FindAccountsOrCustomersInfo サービス操作 - Customer Management

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

指定したフィルター条件に一致するアカウントと顧客の一覧を取得します。

Request 要素

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

注:

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

要求本文要素

要素	説明	データ型
Filter	アカウントと顧客の一覧をフィルター処理するために使用する条件。アカウント名、アカウント番号、または顧客名を指定できます。フィルター値には、部分的または完全な名前または数値を含めることができます。名前または数値が指定したフィルター値で始まる場合、操作には結果にアカウントまたは顧客が含まれます。操作は、フィルター値を名前または数値と比較するときに、大文字と小文字を区別しない比較を実行します。たとえば、フィルター値として "t" を指定した場合、名前が "t" または "T" で始まるアカウントと顧客がリストに含まれます。操作は、フィルター条件に一致するアカウントに対して最初にフィルター処理します。フィルター条件に一致するアカウントの数が指定された TopN 値より小さい場合、操作は、名前がフィルター条件と一致する顧客を検索します。この要素を空の文字列に設定することは、 GetAccountsInfo を呼び出した後に GetCustomersInfo を呼び出すことと同じです。	string
ReturnAdditionalFields	返された各アカウントに含めたい追加のプロパティの一覧。追加のフィールド値を使用すると、現在のバージョンの Customer Management API を使用して最新の機能を取得できます。次のバージョンでは、対応する要素が既定で含まれます。この要求要素は省略可能です。	AccountAdditionalField
Topn	結果で返されるアカウントの数を指定する 0 以外の正の整数。 1 から 5,000 までの値を指定する必要があります。	int

要求ヘッダー要素

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

Response 要素

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

応答本文の要素

要素	説明	データ型
AccountInfoWithCustomerData	指定したフィルター条件に一致するアカウントと顧客の AccountInfoWithCustomerData オブジェクトの一覧。オブジェクトには、アカウントと顧客を識別する情報が含まれています。リスト内のアカウントの完全な詳細を取得するには、AccountInfoWithCustomerData オブジェクトの AccountId 要素にアクセスし、それを使用して GetAccount 操作を呼び出します。リスト内の顧客の完全な詳細を取得するには、AccountInfoWithCustomerData オブジェクトの CustomerId 要素にアクセスし、それを使用して GetCustomer を呼び出します。	AccountInfoWithCustomerData 配列

応答ヘッダー要素

要素	説明	データ型
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">FindAccountsOrCustomersInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <FindAccountsOrCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Filter i:nil="false">ValueHere</Filter>
      <TopN>ValueHere</TopN>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </FindAccountsOrCustomersInfoRequest>
  </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>
    <FindAccountsOrCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountInfoWithCustomerData xmlns:e227="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e227:AccountInfoWithCustomerData>
          <e227:CustomerId d4p1:nil="false">ValueHere</e227:CustomerId>
          <e227:CustomerName d4p1:nil="false">ValueHere</e227:CustomerName>
          <e227:AccountId>ValueHere</e227:AccountId>
          <e227:AccountName d4p1:nil="false">ValueHere</e227:AccountName>
          <e227:AccountNumber d4p1:nil="false">ValueHere</e227:AccountNumber>
          <e227:AccountLifeCycleStatus>ValueHere</e227:AccountLifeCycleStatus>
          <e227:PauseReason d4p1:nil="false">ValueHere</e227:PauseReason>
          <e227:AccountMode d4p1:nil="false">ValueHere</e227:AccountMode>
        </e227:AccountInfoWithCustomerData>
      </AccountInfoWithCustomerData>
    </FindAccountsOrCustomersInfoResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<FindAccountsOrCustomersInfoResponse> FindAccountsOrCustomersInfoAsync(
	string filter,
	int topN,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new FindAccountsOrCustomersInfoRequest
	{
		Filter = filter,
		TopN = topN,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static FindAccountsOrCustomersInfoResponse findAccountsOrCustomersInfo(
	java.lang.String filter,
	int topN,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	FindAccountsOrCustomersInfoRequest request = new FindAccountsOrCustomersInfoRequest();

	request.setFilter(filter);
	request.setTopN(topN);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function FindAccountsOrCustomersInfo(
	$filter,
	$topN,
	$returnAdditionalFields)
{

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

	$request = new FindAccountsOrCustomersInfoRequest();

	$request->Filter = $filter;
	$request->TopN = $topN;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customermanagement_service.FindAccountsOrCustomersInfo(
	Filter=Filter,
	TopN=TopN,
	ReturnAdditionalFields=ReturnAdditionalFields)

要件

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

次の方法で共有