Skip to content

Latest commit

 

History

History
178 lines (155 loc) · 7.75 KB

adddataexclusions.md

File metadata and controls

178 lines (155 loc) · 7.75 KB
Raw
title ms.service ms.subservice ms.topic author ms.author description dev_langs
AddDataExclusions Service Operation - Campaign Management
bing-ads
campaign-management-api
article
jonmeyers
jonmeyers
Add a data exclusion to the specified account.
csharp
java
php
python

AddDataExclusions Service Operation - Campaign Management

Add a data exclusion to the specified account.

Request Elements

The AddDataExclusionsRequest object defines the body and header elements of the service operation request. The elements must be in the same order as shown in the Request SOAP.

Note

Unless otherwise noted below, all request elements are required.

Request Body Elements

Element Description Data Type
AccountId The account ID. long
DataExclusions The data exclusions to add. DataExclusion array

Request Header Elements

[!INCLUDErequest-header]

Response Elements

The AddDataExclusionsResponse object defines the body and header elements of the service operation response. The elements are returned in the same order as shown in the Response SOAP.

Response Body Elements

Element Description Data Type
DataExclusionIds The data exclusion IDs. long array
PartialErrors An array BatchError that contains details for any request items that were not successful.

The list of errors does not correspond directly to the list of items in the request. The list can be empty if there were no errors, or it can include one or more error objects corresponding to each unsuccessful list item in the request.		 BatchError array

Response Header Elements

[!INCLUDEresponse-header]

Request SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP request. For supported types that you can use with this service operation, see the Request Body Elements reference above.

<s:Envelope xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <Action mustUnderstand="1">AddDataExclusions</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <CustomerAccountId i:nil="false">ValueHere</CustomerAccountId>
    <CustomerId i:nil="false">ValueHere</CustomerId>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <AddDataExclusionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AccountId>ValueHere</AccountId>
      <DataExclusions i:nil="false">
        <DataExclusion>
          <CampaignAssociations i:nil="false">
            <CampaignAssociation>
              <CampaignId>ValueHere</CampaignId>
            </CampaignAssociation>
          </CampaignAssociations>
          <CampaignTypeFilter i:nil="false">ValueHere</CampaignTypeFilter>
          <Description i:nil="false">ValueHere</Description>
          <DeviceTypeFilter i:nil="false">ValueHere</DeviceTypeFilter>
          <EndDate i:nil="false">ValueHere</EndDate>
          <Id i:nil="false">ValueHere</Id>
          <Name i:nil="false">ValueHere</Name>
          <StartDate i:nil="false">ValueHere</StartDate>
        </DataExclusion>
      </DataExclusions>
    </AddDataExclusionsRequest>
  </s:Body>
</s:Envelope>

Response SOAP

This template was generated by a tool to show the order of the body and header elements for the SOAP response.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <AddDataExclusionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <DataExclusionIds d4p1:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <a1:long>ValueHere</a1:long>
      </DataExclusionIds>
      <PartialErrors d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <BatchError d4p1:type="-- derived type specified here with the appropriate prefix --">
          <Code>ValueHere</Code>
          <Details d4p1:nil="false">ValueHere</Details>
          <ErrorCode d4p1:nil="false">ValueHere</ErrorCode>
          <FieldPath d4p1:nil="false">ValueHere</FieldPath>
          <ForwardCompatibilityMap xmlns:e45="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e45:KeyValuePairOfstringstring>
              <e45:key d4p1:nil="false">ValueHere</e45:key>
              <e45:value d4p1:nil="false">ValueHere</e45:value>
            </e45:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Index>ValueHere</Index>
          <Message d4p1:nil="false">ValueHere</Message>
          <Type d4p1:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to EditorialError-->
          <Appealable d4p1:nil="false">ValueHere</Appealable>
          <DisapprovedText d4p1:nil="false">ValueHere</DisapprovedText>
          <Location d4p1:nil="false">ValueHere</Location>
          <PublisherCountry d4p1:nil="false">ValueHere</PublisherCountry>
          <ReasonCode>ValueHere</ReasonCode>
        </BatchError>
      </PartialErrors>
    </AddDataExclusionsResponse>
  </s:Body>
</s:Envelope>

Code Syntax

The example syntax can be used with Bing Ads SDKs. See Bing Ads API Code Examples for more examples.

public async Task<AddDataExclusionsResponse> AddDataExclusionsAsync(
	long accountId,
	IList<DataExclusion> dataExclusions)
{
	var request = new AddDataExclusionsRequest
	{
		AccountId = accountId,
		DataExclusions = dataExclusions
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddDataExclusionsAsync(r), request));
}
static AddDataExclusionsResponse addDataExclusions(
	java.lang.Long accountId,
	ArrayOfDataExclusion dataExclusions) throws RemoteException, Exception
{
	AddDataExclusionsRequest request = new AddDataExclusionsRequest();

	request.setAccountId(accountId);
	request.setDataExclusions(dataExclusions);

	return CampaignManagementService.getService().addDataExclusions(request);
}
static function AddDataExclusions(
	$accountId,
	$dataExclusions)
{

	$GLOBALS['Proxy'] = $GLOBALS['CampaignManagementProxy'];

	$request = new AddDataExclusionsRequest();

	$request->AccountId = $accountId;
	$request->DataExclusions = $dataExclusions;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddDataExclusions($request);
}
response=campaignmanagement_service.AddDataExclusions(
	AccountId=AccountId,
	DataExclusions=DataExclusions)

Requirements

Service: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13