AddDataExclusions 服務作業 - 營銷活動管理

將數據排除新增至指定的帳戶。

要求專案

AddDataExclusionsRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
AccountId	帳戶標識碼。	長
DataExclusions	要加入的數據排除範圍。	DataExclusion 陣 列

要求標頭元素

元素	描述	資料類型
AuthenticationToken	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
CustomerAccountId	擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
CustomerId	(使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

AddDataExclusionsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素	描述	資料類型
DataExclusionIds	數據排除標識碼。	long 陣列
PartialErrors	數位 BatchError ，其中包含任何未成功要求專案的詳細數據。 錯誤清單不會直接對應至要求中的項目清單。 如果沒有錯誤，清單可以是空的，也可以包含一或多個對應到要求中每個不成功清單項目的錯誤物件。	BatchError 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求SOAP

此範本是由工具所產生，用來顯示SOAP要求的主體和標頭元素順序。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

<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>

回應 SOAP

此範本是由工具所產生，用來顯示SOAP回應的 主體 和 標頭 元素順序。

<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:e93="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e93:KeyValuePairOfstringstring>
              <e93:key d4p1:nil="false">ValueHere</e93:key>
              <e93:value d4p1:nil="false">ValueHere</e93:value>
            </e93: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>

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

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)

需求

服務： CampaignManagementService.svc v13
命名空間： https://bingads.microsoft.com/CampaignManagement/v13

要求 URL

生產URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/DataExclusions

沙箱 URL

https://campaign.api.sandbox.bingads.microsoft.com/CampaignManagement/v13/DataExclusions

要求專案

AddDataExclusionsRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素	描述	資料類型
AccountId	帳戶標識碼。	長
DataExclusions	要加入的數據排除範圍。	DataExclusion 陣 列

要求標頭元素

元素	描述	資料類型
授權	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
CustomerAccountId	擁有或與要求中實體相關聯之廣告帳戶的標識碼。 當兩者都需要時，此標頭元素必須具有與 AccountId body 元素相同的值。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
CustomerId	(使用者存取或操作之使用者) 客戶的管理員帳戶標識碼。 用戶可以存取多個管理員帳戶。 此元素是大部分服務作業的必要專案，最佳做法是一律加以設定。 如需詳細資訊， 請參閱取得您的帳戶和客戶標識符。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

AddDataExclusionsResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素	描述	資料類型
DataExclusionIds	數據排除標識碼。	long 陣列
PartialErrors	數位 BatchError ，其中包含任何未成功要求專案的詳細數據。 錯誤清單不會直接對應至要求中的項目清單。 如果沒有錯誤，清單可以是空的，也可以包含一或多個對應到要求中每個不成功清單項目的錯誤物件。	BatchError 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

{
  "AccountId": "LongValueHere",
  "DataExclusions": [
    {
      "CampaignAssociations": [
        {
          "CampaignId": "LongValueHere"
        }
      ],
      "CampaignTypeFilter": "ValueHere",
      "Description": "ValueHere",
      "DeviceTypeFilter": "ValueHere",
      "EndDate": "ValueHere",
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "StartDate": "ValueHere"
    }
  ]
}

回應 JSON

此範本是由工具所產生，用來顯示 JSON 回應的 主體 和 標頭 元素。

如果 BatchError 的類型是編輯器，則適用以下 範例。

{
  "DataExclusionIds": [
    "LongValueHere"
  ],
  "PartialErrors": [
    {
      "Code": IntValueHere,
      "Details": "ValueHere",
      "ErrorCode": "ValueHere",
      "FieldPath": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Index": IntValueHere,
      "Message": "ValueHere",
      "Type": "EditorialError",
      "Appealable": "ValueHere",
      "DisapprovedText": "ValueHere",
      "Location": "ValueHere",
      "PublisherCountry": "ValueHere",
      "ReasonCode": IntValueHere
    }
  ]
}

程序代碼語法

若要透過 SDK 呼叫 REST API，您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

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)