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

キャンペーン ID 別のキャンペーンの関連付けに対する除外キーワード リスト、または広告アカウント ID 別の広告アカウントの関連付けに対する Web サイト除外リストを取得します。

ヒント

概要については、 負のキーワードと否定的サイトに関する テクニカル ガイドを参照してください。

重要

Web サイトの除外リスト (PlacementExclusionList) を所有しているマネージャー アカウント (顧客) のユーザーのみが、リストの更新または削除、リスト アイテムの追加または削除、およびリストを広告アカウントに関連付けることができます。 所有していない Web サイト除外リストに広告アカウントが関連付けられている場合は、アカウントからリストの関連付けを解除できますが、リストとリストアイテムは読み取り専用です。 リストの所有者は、関連付けの SharedEntityCustomerId 要素によって決まります。

アカウント階層内の複数のマネージャー アカウントにアクセスできる場合、操作の結果は、設定した CustomerId 要求ヘッダー 要素によって異なる場合があります。

Request 要素

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

注:

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

要求本文要素

要素 説明 データ型
EntityIds キャンペーンまたは広告アカウント識別子の一覧。

この配列には、最大 100 個の要素を含めることができます。
long 配列
EntityType 指定した EntityIds 要素に対応するエンティティの型。

広告アカウント共有ライブラリのキャンペーンの関連付けに除外キーワード リストを取得するには、この要素を "キャンペーン" に設定します。

この要素を "Account" に設定すると、マネージャー アカウント (顧客) 共有ライブラリの広告アカウントの関連付けに対する Web サイトの除外リストが取得されます。
string
SharedEntityScope 共有エンティティが広告アカウント (アカウント) レベルまたはマネージャー アカウント (顧客) レベルで使用できるかどうかを示します。

この要素は省略可能であり、既定値は Account スコープです。 広告アカウントのスコープは、キャンペーンの関連付けに除外キーワード リストにのみ適用されます。

この要素を Customer に設定すると、Manager アカウント ( 顧客 ) 共有ライブラリの広告アカウントの関連付けに対する Web サイトの除外リストが取得されます。
EntityScope
SharedEntityType 関連付けを取得する共有エンティティの種類。

広告アカウント共有ライブラリのキャンペーンの関連付けに除外キーワード リストを取得するには、この要素を "NegativeKeywordList" に設定します。

この要素を "PlacementExclusionList" に設定すると、マネージャー アカウント (顧客) 共有ライブラリの広告アカウントの関連付けに対する Web サイトの除外リストが取得されます。
string

要求ヘッダー要素

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

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

応答本文の要素

要素 説明 データ型
関連付け 要求で指定したエンティティ識別子に直接対応する SharedEntityAssociation オブジェクトの配列。 リストの項目は null として返される場合があります。 関連付けが取得されなかったリスト インデックスごとに、対応する要素は null になります。 SharedEntityAssociation 配列
PartialErrors 成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。

エラーの一覧は、要求内の項目の一覧に直接対応していません。 エラーがない場合はリストを空にすることも、失敗したリスト 項目ごとに対応する 1 つ以上のエラー オブジェクトを要求に含めることもできます。
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">GetSharedEntityAssociationsByEntityIds</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>
    <GetSharedEntityAssociationsByEntityIdsRequest 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>
      <SharedEntityType i:nil="false">ValueHere</SharedEntityType>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </GetSharedEntityAssociationsByEntityIdsRequest>
  </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>
    <GetSharedEntityAssociationsByEntityIdsResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <Associations d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <SharedEntityAssociation>
          <EntityId>ValueHere</EntityId>
          <EntityType d4p1:nil="false">ValueHere</EntityType>
          <SharedEntityCustomerId d4p1:nil="false">ValueHere</SharedEntityCustomerId>
          <SharedEntityId>ValueHere</SharedEntityId>
          <SharedEntityType d4p1:nil="false">ValueHere</SharedEntityType>
        </SharedEntityAssociation>
      </Associations>
      <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:e168="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e168:KeyValuePairOfstringstring>
              <e168:key d4p1:nil="false">ValueHere</e168:key>
              <e168:value d4p1:nil="false">ValueHere</e168:value>
            </e168: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>
    </GetSharedEntityAssociationsByEntityIdsResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<GetSharedEntityAssociationsByEntityIdsResponse> GetSharedEntityAssociationsByEntityIdsAsync(
	IList<long> entityIds,
	string entityType,
	string sharedEntityType,
	EntityScope? sharedEntityScope)
{
	var request = new GetSharedEntityAssociationsByEntityIdsRequest
	{
		EntityIds = entityIds,
		EntityType = entityType,
		SharedEntityType = sharedEntityType,
		SharedEntityScope = sharedEntityScope
	};

	return (await CampaignManagementService.CallAsync((s, r) => s.GetSharedEntityAssociationsByEntityIdsAsync(r), request));
}
static GetSharedEntityAssociationsByEntityIdsResponse getSharedEntityAssociationsByEntityIds(
	ArrayOflong entityIds,
	java.lang.String entityType,
	java.lang.String sharedEntityType,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	GetSharedEntityAssociationsByEntityIdsRequest request = new GetSharedEntityAssociationsByEntityIdsRequest();

	request.setEntityIds(entityIds);
	request.setEntityType(entityType);
	request.setSharedEntityType(sharedEntityType);
	request.setSharedEntityScope(sharedEntityScope);

	return CampaignManagementService.getService().getSharedEntityAssociationsByEntityIds(request);
}
static function GetSharedEntityAssociationsByEntityIds(
	$entityIds,
	$entityType,
	$sharedEntityType,
	$sharedEntityScope)
{

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

	$request = new GetSharedEntityAssociationsByEntityIdsRequest();

	$request->EntityIds = $entityIds;
	$request->EntityType = $entityType;
	$request->SharedEntityType = $sharedEntityType;
	$request->SharedEntityScope = $sharedEntityScope;

	return $GLOBALS['CampaignManagementProxy']->GetService()->GetSharedEntityAssociationsByEntityIds($request);
}
response=campaignmanagement_service.GetSharedEntityAssociationsByEntityIds(
	EntityIds=EntityIds,
	EntityType=EntityType,
	SharedEntityType=SharedEntityType,
	SharedEntityScope=SharedEntityScope)

要件

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