SetLabelAssociations サービス操作 - キャンペーン管理

[アーティクル]
10/04/2023

ラベルの関連付けを設定します。

Request 要素

SetLabelAssociationsRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。要素は、要求 SOAP に示されている順序と同じ順序である必要があります。

注:

以下に特に記載がない限り、すべての要求要素が必要です。

要求本文要素

要素	説明	データ型
EntityType	ラベルに関連付けられているエンティティの種類を示します。サポートされているエンティティの種類の値は、 Campaign、 AdGroup、 Ad、 Keyword です。	EntityType
LabelAssociations	設定するラベルの関連付けの一覧。各ラベル関連付けには、ラベルとエンティティ識別子が含まれます。リストの最大サイズは、サービス要求ごとに 100 項目です。各エンティティは、最大 50 個のラベルに関連付けることができます。たとえば、キャンペーン A は最大 50 個のラベルに関連付けることができます。	LabelAssociation 配列

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。詳細については、「 OAuth による認証」を参照してください。	string
CustomerAccountId	要求のエンティティを所有または関連付けられている広告アカウントの識別子。両方が必要な場合、このヘッダー要素の値は AccountId 本文要素と同じである必要があります。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
Customerid	ユーザーがアクセスまたは操作しているマネージャーアカウント (顧客) の識別子。ユーザーは複数のマネージャーアカウントにアクセスできます。この要素は、ほとんどのサービス操作に必要であり、ベストプラクティスとして常に設定する必要があります。詳細については、「アカウントと顧客 ID を取得する」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

SetLabelAssociationsResponse オブジェクトは、サービス操作応答の本文要素とヘッダー要素を定義します。要素は、応答 SOAP に示されている順序と同じ順序で返されます。

応答本文の要素

要素	説明	データ型
PartialErrors	正常に取得されなかった関連付けの詳細を含む BatchError オブジェクトの配列。エラーの一覧は、要求内の関連付けの一覧に直接対応します。リストの項目は null として返される場合があります。関連付けが正常に取得されたリストインデックスごとに、対応する error 要素は 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">SetLabelAssociations</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>
    <SetLabelAssociationsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <EntityType>ValueHere</EntityType>
      <LabelAssociations i:nil="false">
        <LabelAssociation>
          <EntityId>ValueHere</EntityId>
          <LabelId>ValueHere</LabelId>
        </LabelAssociation>
      </LabelAssociations>
    </SetLabelAssociationsRequest>
  </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>
    <SetLabelAssociationsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <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:e174="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e174:KeyValuePairOfstringstring>
              <e174:key d4p1:nil="false">ValueHere</e174:key>
              <e174:value d4p1:nil="false">ValueHere</e174:value>
            </e174: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>
    </SetLabelAssociationsResponse>
  </s:Body>
</s:Envelope>

コード構文

構文の例は、 Bing広告 SDK で使用できます。その他の例については、「Bing広告 API コードの例」を参照してください。

public async Task<SetLabelAssociationsResponse> SetLabelAssociationsAsync(
	EntityType entityType,
	IList<LabelAssociation> labelAssociations)
{
	var request = new SetLabelAssociationsRequest
	{
		EntityType = entityType,
		LabelAssociations = labelAssociations
	};

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

static SetLabelAssociationsResponse setLabelAssociations(
	EntityType entityType,
	ArrayOfLabelAssociation labelAssociations) throws RemoteException, Exception
{
	SetLabelAssociationsRequest request = new SetLabelAssociationsRequest();

	request.setEntityType(entityType);
	request.setLabelAssociations(labelAssociations);

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

static function SetLabelAssociations(
	$entityType,
	$labelAssociations)
{

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

	$request = new SetLabelAssociationsRequest();

	$request->EntityType = $entityType;
	$request->LabelAssociations = $labelAssociations;

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

response=campaignmanagement_service.SetLabelAssociations(
	EntityType=EntityType,
	LabelAssociations=LabelAssociations)

要件

サービス: CampaignManagementService.svc v13
名前空間： https://bingads.microsoft.com/CampaignManagement/v13

次の方法で共有