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

發行項
02/14/2024

將負關鍵詞加入至負關鍵詞清單，或將負數網站新增至網站排除清單。

此作業僅用於透過共用清單的負關鍵詞和負網站。若要直接將負關鍵詞新增至營銷活動或廣告群組，請參閱 AddNegativeKeywordsToEntities。若要設定或取代直接指派給營銷活動或廣告群組的負面網站，請參閱 SetNegativeSitesToCampaigns 和 SetNegativeSitesToAdGroups。

提示

如需概觀，請參閱負關鍵詞和負面網站技術指南。

重要事項

只有擁有 PlacementExclusionList) 之網站排除清單的客戶) ( (管理員帳戶的使用者，才能更新或刪除清單、新增或刪除清單專案，以及將清單與廣告帳戶產生關聯。如果您的廣告帳戶與您不擁有的網站排除清單相關聯，您可以解除清單與帳戶的關聯，但清單和列表專案是只讀的。清單的擁有者取決於關聯的 SharedEntityCustomerId 元素。

如果您可以存取帳戶階層中的多個管理員帳戶，則作業的結果可能會因您設定的 CustomerId 要求標頭元素而有所不同。

要求專案

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

注意事項

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

要求本文專案

元素	說明	資料類型
ListItems	要新增至負關鍵詞清單的負關鍵詞，或要新增至網站排除清單的負數網站。此清單可以包含每個服務呼叫最多5,000個專案。	SharedListItem 陣列
SharedEntityScope	指出共享實體是否可在客戶) 層級的廣告帳戶 (帳戶) 或管理員帳戶 (使用。此元素為選擇性專案，且預設為帳戶範圍。廣告帳戶範圍僅適用於負關鍵詞清單。將此元素設定為 Customer ，以將負面網站新增至您管理員帳戶中的網站排除清單， (客戶) 共用連結庫。	EntityScope
SharedList	負關鍵詞清單或網站排除清單。如果 SharedEntityScope 是空的或設定為 Account，而且 SharedList 是 NegativeKeywordList 或 AccountNegativeKeywordList，則 ListItems 必須是 negative 關鍵詞 (NegativeKeyword) 物件。如果 SharedEntityScope 設定為 Customer，而且 SharedList 是 PlacementExclusionList，則 ListItems 必須是 negative 網站 (NegativeSite) 物件。	SharedList

要求標頭元素

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

Response 元素

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

回應本文專案

元素	說明	資料類型
ListItemIds	long 值的清單，表示已加入之清單專案的標識碼。清單的專案可能會傳回為 Null。對於未新增清單專案的每個清單索引，對應的專案會是 Null。	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">AddListItemsToSharedList</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>
    <AddListItemsToSharedListRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListItems i:nil="false">
        <SharedListItem i:type="-- derived type specified here with the appropriate prefix --">
          <ForwardCompatibilityMap xmlns:e52="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e52:KeyValuePairOfstringstring>
              <e52:key i:nil="false">ValueHere</e52:key>
              <e52:value i:nil="false">ValueHere</e52:value>
            </e52:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Type i:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to NegativeKeyword-->
          <Id i:nil="false">ValueHere</Id>
          <MatchType i:nil="false">ValueHere</MatchType>
          <Text i:nil="false">ValueHere</Text>
          <!--These fields are applicable if the derived type attribute is set to NegativeSite-->
          <Id i:nil="false">ValueHere</Id>
          <Url i:nil="false">ValueHere</Url>
          <!--This field is applicable if the derived type attribute is set to BrandItem-->
          <BrandId>ValueHere</BrandId>
        </SharedListItem>
      </ListItems>
      <SharedList i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
        <ItemCount i:nil="false">ValueHere</ItemCount>
        <!--No additional fields are applicable if the derived type attribute is set to NegativeKeywordList-->
        <!--No additional fields are applicable if the derived type attribute is set to PlacementExclusionList-->
        <!--No additional fields are applicable if the derived type attribute is set to AccountNegativeKeywordList-->
        <!--No additional fields are applicable if the derived type attribute is set to BrandList-->
      </SharedList>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </AddListItemsToSharedListRequest>
  </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>
    <AddListItemsToSharedListResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListItemIds 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>
      </ListItemIds>
      <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:e53="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e53:KeyValuePairOfstringstring>
              <e53:key d4p1:nil="false">ValueHere</e53:key>
              <e53:value d4p1:nil="false">ValueHere</e53:value>
            </e53: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>
    </AddListItemsToSharedListResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

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

public async Task<AddListItemsToSharedListResponse> AddListItemsToSharedListAsync(
	IList<SharedListItem> listItems,
	SharedList sharedList,
	EntityScope? sharedEntityScope)
{
	var request = new AddListItemsToSharedListRequest
	{
		ListItems = listItems,
		SharedList = sharedList,
		SharedEntityScope = sharedEntityScope
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.AddListItemsToSharedListAsync(r), request));
}

static AddListItemsToSharedListResponse addListItemsToSharedList(
	ArrayOfSharedListItem listItems,
	SharedList sharedList,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	AddListItemsToSharedListRequest request = new AddListItemsToSharedListRequest();

	request.setListItems(listItems);
	request.setSharedList(sharedList);
	request.setSharedEntityScope(sharedEntityScope);

	return CampaignManagementService.getService().addListItemsToSharedList(request);
}

static function AddListItemsToSharedList(
	$listItems,
	$sharedList,
	$sharedEntityScope)
{

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

	$request = new AddListItemsToSharedListRequest();

	$request->ListItems = $listItems;
	$request->SharedList = $sharedList;
	$request->SharedEntityScope = $sharedEntityScope;

	return $GLOBALS['CampaignManagementProxy']->GetService()->AddListItemsToSharedList($request);
}

response=campaignmanagement_service.AddListItemsToSharedList(
	ListItems=ListItems,
	SharedList=SharedList,
	SharedEntityScope=SharedEntityScope)

需求

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

共用方式為