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

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

広告アカウントライブラリに除外キーワードリストを追加するか、マネージャーアカウント (顧客) ライブラリに Web サイトの除外リストを追加します。

ヒント

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

重要

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

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

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
ListItems	新しい除外キーワードリストに含める除外キーワード (合計 5,000 個)、または新しい Web サイトの除外リストに含める除外サイト (合計 10,000 件)。この一覧には、サービス呼び出しごとに最大 5,000 個の項目を含めることができます。リスト項目をさらに追加するには、 AddListItemsToSharedList 操作を呼び出します。	SharedListItem 配列
SharedEntity	除外キーワードリストまたは Web サイトの除外リスト。 SharedEntityScope が空または Account に設定されている場合、SharedEntity が NegativeKeywordList の場合、ListItems は負のキーワード (NegativeKeyword) オブジェクトである必要があります。 SharedEntityScope が Customer に設定されていて、SharedEntity が PlacementExclusionList の場合、ListItems は負のサイト (NegativeSite) オブジェクトである必要があります。	SharedEntity
SharedEntityScope	共有エンティティが広告アカウント (アカウント) レベルまたはマネージャーアカウント (顧客) レベルで使用できるかどうかを示します。この要素は省略可能であり、既定値は Account スコープです。広告アカウントのスコープは、除外キーワードリストにのみ適用されます。マネージャーアカウント ( 顧客 ) 共有ライブラリに Web サイトの除外リストを追加するには、この要素を Customer に設定します。	EntityScope

要求ヘッダー要素

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

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

応答本文の要素

要素	説明	データ型
ListItemIds	追加されたリストアイテムの識別子を表す長い値の一覧。リストの項目は null として返される場合があります。リスト項目が追加されなかったリストインデックスごとに、対応する要素は null になります。	long 配列
PartialErrors	成功しなかった要求項目の詳細を含む BatchError オブジェクトの配列。エラーの一覧は、要求内の項目の一覧に直接対応していません。エラーがない場合はリストを空にすることも、失敗したリスト項目ごとに対応する 1 つ以上のエラーオブジェクトを要求に含めることもできます。	BatchError 配列
SharedEntityId	追加された共有エンティティの識別子。	long

応答ヘッダー要素

要素	説明	データ型
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">AddSharedEntity</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>
    <AddSharedEntityRequest xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <SharedEntity i:nil="false" i:type="-- derived type specified here with the appropriate prefix --">
        <AssociationCount i:nil="false">ValueHere</AssociationCount>
        <ForwardCompatibilityMap xmlns:e57="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
          <e57:KeyValuePairOfstringstring>
            <e57:key i:nil="false">ValueHere</e57:key>
            <e57:value i:nil="false">ValueHere</e57:value>
          </e57:KeyValuePairOfstringstring>
        </ForwardCompatibilityMap>
        <Id i:nil="false">ValueHere</Id>
        <Name i:nil="false">ValueHere</Name>
        <Type i:nil="false">ValueHere</Type>
        <!--This field is applicable if the derived type attribute is set to SharedList-->
        <ItemCount i:nil="false">ValueHere</ItemCount>
      </SharedEntity>
      <ListItems i:nil="false">
        <SharedListItem i:type="-- derived type specified here with the appropriate prefix --">
          <ForwardCompatibilityMap xmlns:e58="http://schemas.datacontract.org/2004/07/System.Collections.Generic" i:nil="false">
            <e58:KeyValuePairOfstringstring>
              <e58:key i:nil="false">ValueHere</e58:key>
              <e58:value i:nil="false">ValueHere</e58:value>
            </e58:KeyValuePairOfstringstring>
          </ForwardCompatibilityMap>
          <Type i:nil="false">ValueHere</Type>
          <!--These fields are applicable if the derived type attribute is set to NegativeKeyword-->
          <Id i:nil="false">ValueHere</Id>
          <MatchType i:nil="false">ValueHere</MatchType>
          <Text i:nil="false">ValueHere</Text>
          <!--These fields are applicable if the derived type attribute is set to NegativeSite-->
          <Id i:nil="false">ValueHere</Id>
          <Url i:nil="false">ValueHere</Url>
          <!--This field is applicable if the derived type attribute is set to BrandItem-->
          <BrandId>ValueHere</BrandId>
        </SharedListItem>
      </ListItems>
      <SharedEntityScope i:nil="false">ValueHere</SharedEntityScope>
    </AddSharedEntityRequest>
  </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>
    <AddSharedEntityResponse xmlns="https://bingads.microsoft.com/CampaignManagement/v13">
      <ListItemIds 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>
      </ListItemIds>
      <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:e59="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e59:KeyValuePairOfstringstring>
              <e59:key d4p1:nil="false">ValueHere</e59:key>
              <e59:value d4p1:nil="false">ValueHere</e59:value>
            </e59: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>
      <SharedEntityId>ValueHere</SharedEntityId>
    </AddSharedEntityResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<AddSharedEntityResponse> AddSharedEntityAsync(
	SharedEntity sharedEntity,
	IList<SharedListItem> listItems,
	EntityScope? sharedEntityScope)
{
	var request = new AddSharedEntityRequest
	{
		SharedEntity = sharedEntity,
		ListItems = listItems,
		SharedEntityScope = sharedEntityScope
	};

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

static AddSharedEntityResponse addSharedEntity(
	SharedEntity sharedEntity,
	ArrayOfSharedListItem listItems,
	EntityScope sharedEntityScope) throws RemoteException, Exception
{
	AddSharedEntityRequest request = new AddSharedEntityRequest();

	request.setSharedEntity(sharedEntity);
	request.setListItems(listItems);
	request.setSharedEntityScope(sharedEntityScope);

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

static function AddSharedEntity(
	$sharedEntity,
	$listItems,
	$sharedEntityScope)
{

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

	$request = new AddSharedEntityRequest();

	$request->SharedEntity = $sharedEntity;
	$request->ListItems = $listItems;
	$request->SharedEntityScope = $sharedEntityScope;

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

response=campaignmanagement_service.AddSharedEntity(
	SharedEntity=SharedEntity,
	ListItems=ListItems,
	SharedEntityScope=SharedEntityScope)

要件

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

次の方法で共有