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

[アーティクル]
03/28/2024

資産グループリストグループにアクションを適用します。

次の検証規則に注意してください。

少なくとも、リストグループツリー構造のルートノードを少なくとも指定する必要があります。リストグループのルート AssetGroupListingGroup には、 条件オペランド を "All" に、 Attribute を null に設定する必要があります。カタログ内のすべての製品の広告を配信する場合は、 PartitionType を "Unit" に設定します。より特定の製品条件で広告を配信する場合は、YPartitionTypeY を "サブディビジョン" に、 ParentCriterionId をnull に、 ID を 負の値に設定します。負の値は、任意の子ノードの ParentCriterionId として使用します。
ルートノードはレベル 0 と見なされ、ツリーの深さは最大 7 レベルまで分岐できます。
呼び出しごとに最大 5,000 個の AssetGroupListingGroupAction オブジェクトを指定できます。複数の呼び出しで作成されたツリー全体には、最大 20,000 個のノードを含めることができます。
AssetGroupListingGroup オブジェクトはそれぞれ同じ AssetGroupId を持っている必要があります。そうしないと、呼び出しは失敗します。
Condition プロパティまたは Attribute プロパティを更新するには、既存の製品パーティションツリーノードを削除し、新しい識別子を取得する新しい製品パーティションツリーノードを追加する必要があります。除外されていないから除外された AssetGroupListingGroup またはその他の方法で更新するには、既存の製品パーティションツリーノードを削除し、新しい識別子を取得する新しい製品パーティションツリーノードを追加する必要があります。
いずれかのアクションが失敗した場合、それ以外の場合に成功した可能性がある残りのアクションもすべて失敗します。
1 回の呼び出しのすべてのアクションは、完全なツリー構造になる必要があります。資産グループごとに 5,000 を超えるアクションを適用する必要がある場合は、複数の呼び出しを行う必要があります。最初の呼び出しから親資産グループ識別子を取得し、後続の呼び出しで必要に応じてさらに子を追加します。
ルートノードからブランチの末尾までのすべてのパスは、リーフノード (ProductPartitionType=Unit) で終了する必要があります。
サブディビジョンの条件の残りの部分に対して、各サブディビジョンには少なくとも 1 つのリーフノードが必要です。たとえば、兄弟単位と同じオペランドを使用し、その Attribute を null に設定します。
子ノードは、その親の後にのみ指定できます。
親と子の両方がまだ存在しない複数のレベルのパーティションを追加する場合は、負の int 値を参照として使用して親を識別します。たとえば、親の ID と子の ParentListingGroupId 要素の両方を同じ負の値に設定します。負の ID は、呼び出しの期間中のみ有効です。正常に追加された資産グループ一覧グループごとに一意のシステム識別子が応答メッセージで返されます。
製品パーティションを一時停止するには、 UpdateAssetGroups を呼び出して資産グループ全体を一時停止する必要があります。 UpdateCampaigns を呼び出して、キャンペーン全体を一時停止できます。
削除アクションの場合は、AssetGroupListingGroup で Id と AssetGroupId のみを指定する必要があります。
親製品パーティションを削除すると、そのすべての子と子孫も削除されます。
ブランチで重複する製品条件を指定することはできません。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
ListingGroupActions	それぞれ Action 要素と ListingGroup 要素を含む AssetGroupListingGroupAction オブジェクトのリスト。資産グループ一覧表示グループのアクションはすべて、同じ資産グループに対するアクションである必要があります。 1 回の呼び出しで 5,000 個の AssetGroupListingGroupAction を渡し、各資産グループに最大 20,000 個の登録情報グループを適用できます。	AssetGroupListingGroupAction 配列

要求ヘッダー要素

要素	説明	データ型
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 要素

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

応答本文の要素

要素	説明	データ型
AssetGroupListingGroupIds	アクションが適用されたリストグループの ID の一覧。 ID の一覧は、要求内のリストグループの一覧に直接対応します。リストグループアクションが失敗した場合、残りのリストグループアクションはすべて失敗し、このリスト内のすべての要素は 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">ApplyAssetGroupListingGroupActions</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>
    <ApplyAssetGroupListingGroupActionsRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListingGroupActions i:nil="false">
        <AssetGroupListingGroupAction>
          <Action>ValueHere</Action>
          <ListingGroup i:nil="false">
            <AssetGroupId>ValueHere</AssetGroupId>
            <AssetGroupListingType>ValueHere</AssetGroupListingType>
            <Dimension i:nil="false">
              <Attribute i:nil="false">ValueHere</Attribute>
              <Operand i:nil="false">ValueHere</Operand>
              <Operator i:nil="false">ValueHere</Operator>
            </Dimension>
            <Id i:nil="false">ValueHere</Id>
            <IsExcluded>ValueHere</IsExcluded>
            <ParentListingGroupId i:nil="false">ValueHere</ParentListingGroupId>
          </ListingGroup>
        </AssetGroupListingGroupAction>
      </ListingGroupActions>
    </ApplyAssetGroupListingGroupActionsRequest>
  </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>
    <ApplyAssetGroupListingGroupActionsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <AssetGroupListingGroupIds 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>
      </AssetGroupListingGroupIds>
      <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:e63="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e63:KeyValuePairOfstringstring>
              <e63:key d4p1:nil="false">ValueHere</e63:key>
              <e63:value d4p1:nil="false">ValueHere</e63:value>
            </e63: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>
    </ApplyAssetGroupListingGroupActionsResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<ApplyAssetGroupListingGroupActionsResponse> ApplyAssetGroupListingGroupActionsAsync(
	IList<AssetGroupListingGroupAction> listingGroupActions)
{
	var request = new ApplyAssetGroupListingGroupActionsRequest
	{
		ListingGroupActions = listingGroupActions
	};

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

static ApplyAssetGroupListingGroupActionsResponse applyAssetGroupListingGroupActions(
	ArrayOfAssetGroupListingGroupAction listingGroupActions) throws RemoteException, Exception
{
	ApplyAssetGroupListingGroupActionsRequest request = new ApplyAssetGroupListingGroupActionsRequest();

	request.setListingGroupActions(listingGroupActions);

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

static function ApplyAssetGroupListingGroupActions(
	$listingGroupActions)
{

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

	$request = new ApplyAssetGroupListingGroupActionsRequest();

	$request->ListingGroupActions = $listingGroupActions;

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

response=campaignmanagement_service.ApplyAssetGroupListingGroupActions(
	ListingGroupActions=ListingGroupActions)

要件

サービス: CampaignManagementService.svc v13
Namespace: https://bingads.microsoft.com/CampaignManagement/v13

次の方法で共有