GetNegativeKeywordsByEntityIds 服務作業 - 活動管理

取得直接指派給營銷活動或廣告群組的負關鍵詞。

作業不會傳回共用負關鍵詞清單的負關鍵詞。 如需詳細資訊，請參閱 GetListItemsBySharedList 。

提示

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

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
EntityIds	要傳回相關負關鍵詞的實體標識碼陣列。 指定的實體必須全部存在於相同的父實體內，例如廣告群組標識碼必須全部存在於相同的營銷活動內。 這個陣列最多可以包含1個專案。	long 陣列
EntityType	對應至指定 EntityIds 專案的實體類型。 可能的值包括 AdGroup 和 Campaign。	string
ParentEntityId	對應至指定 EntityIds 專案的父實體標識碼。 如果實體類型為 AdGroup，此元素應該設定為包含所有指定廣告群組的行銷活動識別碼。 如果實體類型為 Campaign，則服務會使用 CustomerAccountId 標頭元素，並忽略此元素。	長

要求標頭元素

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

Response 元素

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

回應本文專案

元素	描述	資料類型
EntityNegativeKeywords	EntityNegativeKeyword 對象的陣列，直接對應至您在要求中指定的實體標識碼。 清單的專案可能會傳回為 Null。 對於未擷取實體負關鍵詞的每個清單索引，對應的專案會是 Null。	EntityNegativeKeyword 陣 列
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">GetNegativeKeywordsByEntityIds</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>
    <GetNegativeKeywordsByEntityIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </EntityIds>
      <EntityType i:nil="false">ValueHere</EntityType>
      <ParentEntityId i:nil="false">ValueHere</ParentEntityId>
    </GetNegativeKeywordsByEntityIdsRequest>
  </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>
    <GetNegativeKeywordsByEntityIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityNegativeKeywords d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <EntityNegativeKeyword>
          <EntityId>ValueHere</EntityId>
          <EntityType d4p1:nil="false">ValueHere</EntityType>
          <NegativeKeywords d4p1:nil="false">
            <NegativeKeyword>
              <Id d4p1:nil="false">ValueHere</Id>
              <MatchType d4p1:nil="false">ValueHere</MatchType>
              <Text d4p1:nil="false">ValueHere</Text>
            </NegativeKeyword>
          </NegativeKeywords>
        </EntityNegativeKeyword>
      </EntityNegativeKeywords>
      <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:e487="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e487:KeyValuePairOfstringstring>
              <e487:key d4p1:nil="false">ValueHere</e487:key>
              <e487:value d4p1:nil="false">ValueHere</e487:value>
            </e487: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>
    </GetNegativeKeywordsByEntityIdsResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

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

public async Task<GetNegativeKeywordsByEntityIdsResponse> GetNegativeKeywordsByEntityIdsAsync(
	IList<long> entityIds,
	string entityType,
	long? parentEntityId)
{
	var request = new GetNegativeKeywordsByEntityIdsRequest
	{
		EntityIds = entityIds,
		EntityType = entityType,
		ParentEntityId = parentEntityId
	};

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

static GetNegativeKeywordsByEntityIdsResponse getNegativeKeywordsByEntityIds(
	ArrayOflong entityIds,
	java.lang.String entityType,
	java.lang.Long parentEntityId) throws RemoteException, Exception
{
	GetNegativeKeywordsByEntityIdsRequest request = new GetNegativeKeywordsByEntityIdsRequest();

	request.setEntityIds(entityIds);
	request.setEntityType(entityType);
	request.setParentEntityId(parentEntityId);

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

static function GetNegativeKeywordsByEntityIds(
	$entityIds,
	$entityType,
	$parentEntityId)
{

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

	$request = new GetNegativeKeywordsByEntityIdsRequest();

	$request->EntityIds = $entityIds;
	$request->EntityType = $entityType;
	$request->ParentEntityId = $parentEntityId;

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

response=campaignmanagement_service.GetNegativeKeywordsByEntityIds(
	EntityIds=EntityIds,
	EntityType=EntityType,
	ParentEntityId=ParentEntityId)

需求

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

要求 URL

生產URL

https://campaign.api.bingads.microsoft.com/CampaignManagement/v13/NegativeKeywords/QueryByEntityIds

沙箱 URL

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

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
EntityIds	要傳回相關負關鍵詞的實體標識碼陣列。 指定的實體必須全部存在於相同的父實體內，例如廣告群組標識碼必須全部存在於相同的營銷活動內。 這個陣列最多可以包含1個專案。	long 陣列
EntityType	對應至指定 EntityIds 專案的實體類型。 可能的值包括 AdGroup 和 Campaign。	string
ParentEntityId	對應至指定 EntityIds 專案的父實體標識碼。 如果實體類型為 AdGroup，此元素應該設定為包含所有指定廣告群組的行銷活動識別碼。 如果實體類型為 Campaign，則服務會使用 CustomerAccountId 標頭元素，並忽略此元素。	長

要求標頭元素

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

Response 元素

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

回應本文專案

元素	描述	資料類型
EntityNegativeKeywords	EntityNegativeKeyword 對象的陣列，直接對應至您在要求中指定的實體標識碼。 清單的專案可能會傳回為 Null。 對於未擷取實體負關鍵詞的每個清單索引，對應的專案會是 Null。	EntityNegativeKeyword 陣 列
PartialErrors	BatchError 物件的陣列，其中包含任何未成功要求專案的詳細數據。 錯誤清單不會直接對應至要求中的項目清單。 如果沒有錯誤，清單可以是空的，或者可以包含一或多個對應到要求中每個不成功清單項目的錯誤物件。	BatchError 陣 列

回應標頭元素

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

要求 JSON

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

{
  "EntityIds": [
    "LongValueHere"
  ],
  "EntityType": "ValueHere",
  "ParentEntityId": "LongValueHere"
}

回應 JSON

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

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

{
  "EntityNegativeKeywords": [
    {
      "EntityId": "LongValueHere",
      "EntityType": "ValueHere",
      "NegativeKeywords": [
        {
          "Id": "LongValueHere",
          "MatchType": "ValueHere",
          "Text": "ValueHere"
        }
      ]
    }
  ],
  "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<GetNegativeKeywordsByEntityIdsResponse> GetNegativeKeywordsByEntityIdsAsync(
	IList<long> entityIds,
	string entityType,
	long? parentEntityId)
{
	var request = new GetNegativeKeywordsByEntityIdsRequest
	{
		EntityIds = entityIds,
		EntityType = entityType,
		ParentEntityId = parentEntityId
	};

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

static GetNegativeKeywordsByEntityIdsResponse getNegativeKeywordsByEntityIds(
	ArrayOflong entityIds,
	java.lang.String entityType,
	java.lang.Long parentEntityId) throws RemoteException, Exception
{
	GetNegativeKeywordsByEntityIdsRequest request = new GetNegativeKeywordsByEntityIdsRequest();

	request.setEntityIds(entityIds);
	request.setEntityType(entityType);
	request.setParentEntityId(parentEntityId);

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

static function GetNegativeKeywordsByEntityIds(
	$entityIds,
	$entityType,
	$parentEntityId)
{

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

	$request = new GetNegativeKeywordsByEntityIdsRequest();

	$request->EntityIds = $entityIds;
	$request->EntityType = $entityType;
	$request->ParentEntityId = $parentEntityId;

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

response=campaignmanagement_service.GetNegativeKeywordsByEntityIds(
	EntityIds=EntityIds,
	EntityType=EntityType,
	ParentEntityId=ParentEntityId)