SearchClientLinks サービス操作 - 顧客管理

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

現在認証されているユーザーの顧客のクライアントリンクを検索し、検索条件でフィルター処理します。この操作では、代理店の顧客とクライアントアカウントの一意の組み合わせごとに最新のリンクが返されます。

注:

スーパー管理者または標準の資格情報を持つユーザーのみが、広告主アカウントへのクライアントリンクを追加、更新、検索できます。 Super Admin 資格情報を持つユーザーのみが、顧客へのクライアントリンクを追加、更新、検索できます。詳細については、ユーザーロールのテクニカルガイドを参照してください。

ユーザーが代理店によって管理されている 1 つ以上のアカウントを持つクライアント顧客内にある場合は、リンクされた、またはリンクされる資格がある個々のアカウントを一度に 1 つずつ検索できます。個々のアカウントで検索するには、述語フィールドを ClientAccountId に設定し、述語値を検索するアカウント識別子に設定します。

ヒント

クライアントリンクライフサイクルの詳細については、アカウント階層のテクニカルガイドを参照してください。代理店になる方法の詳細については、代理店パートナー向けのリソースに関するページを参照してください。クライアントの観点から詳しくは、「 Microsoft Advertising アカウントを代理店で管理する方法」をご覧ください。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
順序	結果の順序を決定します。この要求要素は省略可能です。指定した場合、リストに含める OrderBy 要素は 1 つだけです。追加の要素はサポートされていないため、サービスによって無視されます。このサービス操作では、OrderBy オブジェクトの Field 要素で次の値がサポートされます。 Id - 順序は、返された ClientLink の ClientAccountId 要素によって決まります。名前 - 順序は、返された ClientLink の Name 要素によって決まります。数値 - 順序は、返された ClientLink の ManageingCustomerNumber 要素によって決まります。	OrderBy 配列
PageInfo	ページごとの結果のインデックスとサイズを決定します。	Paging
述語	クライアントリンクを返すために満たす必要がある条件を決定します。 1 つまたは 2 つの述語を含める必要があります。サポートされている述語フィールドの値ごとに結果を決定する方法の詳細については、「述語の備考」を参照してください。	述語配列

要求ヘッダー要素

要素	説明	データ型
AuthenticationToken	Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセストークン。詳細については、「 OAuth による認証」を参照してください。	string
DeveloperToken	Bing Ads API へのアクセスに使用される開発者トークン。詳細については、「開発者トークンを取得する」を参照してください。	string
Password	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string
UserName	この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。	string

Response 要素

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

応答本文の要素

要素	説明	データ型
ClientLinks	クライアントリンクの招待の一覧。	ClientLink 配列

応答ヘッダー要素

要素	説明	データ型
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/Customer/v13">
    <Action mustUnderstand="1">SearchClientLinks</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchClientLinksRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e250="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e250:Predicate>
          <e250:Field i:nil="false">ValueHere</e250:Field>
          <e250:Operator>ValueHere</e250:Operator>
          <e250:Value i:nil="false">ValueHere</e250:Value>
        </e250:Predicate>
      </Predicates>
      <Ordering xmlns:e251="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e251:OrderBy>
          <e251:Field>ValueHere</e251:Field>
          <e251:Order>ValueHere</e251:Order>
        </e251:OrderBy>
      </Ordering>
      <PageInfo xmlns:e252="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e252:Index>ValueHere</e252:Index>
        <e252:Size>ValueHere</e252:Size>
      </PageInfo>
    </SearchClientLinksRequest>
  </s:Body>
</s:Envelope>

応答 SOAP

このテンプレートは、SOAP 応答の本文要素とヘッダー要素の順序を示すツールによって生成されました。

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header xmlns="https://bingads.microsoft.com/Customer/v13">
    <TrackingId d3p1:nil="false" xmlns:d3p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</TrackingId>
  </s:Header>
  <s:Body>
    <SearchClientLinksResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <ClientLinks xmlns:e253="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e253:ClientLink>
          <e253:Type d4p1:nil="false">ValueHere</e253:Type>
          <e253:ClientEntityId d4p1:nil="false">ValueHere</e253:ClientEntityId>
          <e253:ClientEntityNumber d4p1:nil="false">ValueHere</e253:ClientEntityNumber>
          <e253:ClientEntityName d4p1:nil="false">ValueHere</e253:ClientEntityName>
          <e253:ManagingCustomerId d4p1:nil="false">ValueHere</e253:ManagingCustomerId>
          <e253:ManagingCustomerNumber d4p1:nil="false">ValueHere</e253:ManagingCustomerNumber>
          <e253:ManagingCustomerName d4p1:nil="false">ValueHere</e253:ManagingCustomerName>
          <e253:Note d4p1:nil="false">ValueHere</e253:Note>
          <e253:Name d4p1:nil="false">ValueHere</e253:Name>
          <e253:InviterEmail d4p1:nil="false">ValueHere</e253:InviterEmail>
          <e253:InviterName d4p1:nil="false">ValueHere</e253:InviterName>
          <e253:InviterPhone d4p1:nil="false">ValueHere</e253:InviterPhone>
          <e253:IsBillToClient d4p1:nil="false">ValueHere</e253:IsBillToClient>
          <e253:StartDate d4p1:nil="false">ValueHere</e253:StartDate>
          <e253:Status d4p1:nil="false">ValueHere</e253:Status>
          <e253:SuppressNotification>ValueHere</e253:SuppressNotification>
          <e253:LastModifiedDateTime>ValueHere</e253:LastModifiedDateTime>
          <e253:LastModifiedByUserId>ValueHere</e253:LastModifiedByUserId>
          <e253:Timestamp d4p1:nil="false">ValueHere</e253:Timestamp>
          <e253:ForwardCompatibilityMap xmlns:e254="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e254:KeyValuePairOfstringstring>
              <e254:key d4p1:nil="false">ValueHere</e254:key>
              <e254:value d4p1:nil="false">ValueHere</e254:value>
            </e254:KeyValuePairOfstringstring>
          </e253:ForwardCompatibilityMap>
          <e253:CustomerLinkPermission d4p1:nil="false">ValueHere</e253:CustomerLinkPermission>
        </e253:ClientLink>
      </ClientLinks>
    </SearchClientLinksResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<SearchClientLinksResponse> SearchClientLinksAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo)
{
	var request = new SearchClientLinksRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo
	};

	return (await CustomerManagementService.CallAsync((s, r) => s.SearchClientLinksAsync(r), request));
}

static SearchClientLinksResponse searchClientLinks(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo) throws RemoteException, Exception
{
	SearchClientLinksRequest request = new SearchClientLinksRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);

	return CustomerManagementService.getService().searchClientLinks(request);
}

static function SearchClientLinks(
	$predicates,
	$ordering,
	$pageInfo)
{

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

	$request = new SearchClientLinksRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;

	return $GLOBALS['CustomerManagementProxy']->GetService()->SearchClientLinks($request);
}

response=customermanagement_service.SearchClientLinks(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo)

要件

サービス: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

次の方法で共有