GetLabelAssociationsByLabelIds 服務作業 - 活動管理

發行項
12/21/2023

依標籤識別碼取得標籤關聯。

要求專案

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

注意事項

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

要求本文專案

元素	說明	資料類型
EntityType	依實體類型篩選傳回的關聯。支援的實體類型值為 Campaign、 AdGroup、 Ad和 Keyword。	EntityType
LabelIds	用來要求標籤關聯的標籤識別碼清單。您必須在清單中只包含一個標籤識別碼。	long 陣列
PageInfo	決定每頁標籤關聯結果的索引和大小。每個頁面最多會傳回 1,000 個標籤關聯，因此您可能需要要求多個頁面來取得所有標籤關聯。如果未指定此元素，則 Defaut 頁面 Index 為 0 ，預設的 Size 為 1,000。	分頁

要求標頭元素

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

Response 元素

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

回應本文專案

元素	說明	資料類型
LabelAssociations	標籤關聯的陣列。針對要求中指定的每個標籤識別碼，會傳回零個或多個 LabelAssociation 物件。雖然所傳回 LabelAssociation 物件的順序保證會依要求的標籤識別碼順序，但請注意，可以針對相同的標籤識別碼傳回多個 LabelAssociation 物件。實體識別碼會以指定標籤關聯的遞增順序排列。您可以跨多個頁面接收重複的關聯，因此您應該檢查是否有重複的結果。	LabelAssociation 數組
PartialErrors	BatchError物件的陣列，其中包含未成功擷取之任何關聯的詳細資料。錯誤清單會直接對應至要求中的關聯清單。清單的專案可能會傳回為 Null。針對已成功擷取關聯的每個清單索引，對應的錯誤專案會是 Null。在理想情況下，會成功擷取所有關聯，而且此清單中的所有元素都是 Null。	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">GetLabelAssociationsByLabelIds</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>
    <GetLabelAssociationsByLabelIdsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityType>ValueHere</EntityType>
      <LabelIds i:nil="false" xmlns:a1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <a1:long>ValueHere</a1:long>
      </LabelIds>
      <PageInfo i:nil="false">
        <Index>ValueHere</Index>
        <Size>ValueHere</Size>
      </PageInfo>
    </GetLabelAssociationsByLabelIdsRequest>
  </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>
    <GetLabelAssociationsByLabelIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <LabelAssociations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <LabelAssociation>
          <EntityId>ValueHere</EntityId>
          <LabelId>ValueHere</LabelId>
        </LabelAssociation>
      </LabelAssociations>
      <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:e156="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e156:KeyValuePairOfstringstring>
              <e156:key d4p1:nil="false">ValueHere</e156:key>
              <e156:value d4p1:nil="false">ValueHere</e156:value>
            </e156: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>
    </GetLabelAssociationsByLabelIdsResponse>
  </s:Body>
</s:Envelope>

程式碼語法

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

public async Task<GetLabelAssociationsByLabelIdsResponse> GetLabelAssociationsByLabelIdsAsync(
	EntityType entityType,
	IList<long> labelIds,
	Paging pageInfo)
{
	var request = new GetLabelAssociationsByLabelIdsRequest
	{
		EntityType = entityType,
		LabelIds = labelIds,
		PageInfo = pageInfo
	};

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

static GetLabelAssociationsByLabelIdsResponse getLabelAssociationsByLabelIds(
	EntityType entityType,
	ArrayOflong labelIds,
	Paging pageInfo) throws RemoteException, Exception
{
	GetLabelAssociationsByLabelIdsRequest request = new GetLabelAssociationsByLabelIdsRequest();

	request.setEntityType(entityType);
	request.setLabelIds(labelIds);
	request.setPageInfo(pageInfo);

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

static function GetLabelAssociationsByLabelIds(
	$entityType,
	$labelIds,
	$pageInfo)
{

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

	$request = new GetLabelAssociationsByLabelIdsRequest();

	$request->EntityType = $entityType;
	$request->LabelIds = $labelIds;
	$request->PageInfo = $pageInfo;

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

response=campaignmanagement_service.GetLabelAssociationsByLabelIds(
	EntityType=EntityType,
	LabelIds=LabelIds,
	PageInfo=PageInfo)

需求

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

共用方式為