次の方法で共有

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

  • [アーティクル]

要求条件に一致する顧客を検索します。

Request 要素

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

注:

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

要求本文要素

要素 説明 データ型
DateRange 顧客の作成の最小および最大日付範囲を決定します。

この要求要素は省略可能です。		 DateRange
順序 顧客の指定したプロパティによって結果の順序を決定します。

この要求要素は省略可能です。 配列には、最大 1 つの OrderBy 要素を指定できます。 追加の要素はサポートされていないため、サービスによって無視されます。

このサービス操作では、OrderBy オブジェクトの Field 要素で次の値がサポートされます。

Id - 注文は、返された Customer の Id 要素によって決まります。

名前 - 注文は、返された Customer の Name 要素によって決まります。

Number - 注文は、返された Customer の Number 要素によって決まります。		 OrderBy 配列
PageInfo ページごとの結果のインデックスとサイズを決定します。 Paging
述語 顧客を返すためにすべて満たす必要がある条件を決定します。

1 ~ 10 個の述語を含める必要があります。 作成された日付範囲でフィルター処理するには、 Field 値が CreatedDate に設定されている 2 つの述語を含めることができます。それ以外の場合は、各述語フィールドを 1 回だけ使用できます。

サポートされている各述語 フィールド 値の詳細については、「 述語の備考」を参照してください。		 述語 配列

要求ヘッダー要素

要素 説明 データ型
AuthenticationToken Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。

詳細については、「 OAuth による認証」を参照してください。		 string
DeveloperToken Bing Ads API へのアクセスに使用される開発者トークン。

詳細については、「 開発者トークンを取得する」を参照してください。		 string
Password この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string
UserName この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string

Response 要素

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

応答本文の要素

要素 説明 データ型
顧客 要求条件を満たす顧客の一覧。 顧客 配列

応答ヘッダー要素

要素 説明 データ型
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">SearchCustomers</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchCustomersRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e77="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e77:Predicate>
          <e77:Field i:nil="false">ValueHere</e77:Field>
          <e77:Operator>ValueHere</e77:Operator>
          <e77:Value i:nil="false">ValueHere</e77:Value>
        </e77:Predicate>
      </Predicates>
      <DateRange xmlns:e78="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e78:MinDate i:nil="false">ValueHere</e78:MinDate>
        <e78:MaxDate i:nil="false">ValueHere</e78:MaxDate>
      </DateRange>
      <Ordering xmlns:e79="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e79:OrderBy>
          <e79:Field>ValueHere</e79:Field>
          <e79:Order>ValueHere</e79:Order>
        </e79:OrderBy>
      </Ordering>
      <PageInfo xmlns:e80="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e80:Index>ValueHere</e80:Index>
        <e80:Size>ValueHere</e80:Size>
      </PageInfo>
    </SearchCustomersRequest>
  </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>
    <SearchCustomersResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <Customers xmlns:e81="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e81:Customer>
          <e81:CustomerFinancialStatus d4p1:nil="false">ValueHere</e81:CustomerFinancialStatus>
          <e81:Id d4p1:nil="false">ValueHere</e81:Id>
          <e81:Industry d4p1:nil="false">ValueHere</e81:Industry>
          <e81:LastModifiedByUserId d4p1:nil="false">ValueHere</e81:LastModifiedByUserId>
          <e81:LastModifiedTime d4p1:nil="false">ValueHere</e81:LastModifiedTime>
          <e81:MarketCountry d4p1:nil="false">ValueHere</e81:MarketCountry>
          <e81:ForwardCompatibilityMap xmlns:e82="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e82:KeyValuePairOfstringstring>
              <e82:key d4p1:nil="false">ValueHere</e82:key>
              <e82:value d4p1:nil="false">ValueHere</e82:value>
            </e82:KeyValuePairOfstringstring>
          </e81:ForwardCompatibilityMap>
          <e81:MarketLanguage d4p1:nil="false">ValueHere</e81:MarketLanguage>
          <e81:Name d4p1:nil="false">ValueHere</e81:Name>
          <e81:ServiceLevel d4p1:nil="false">ValueHere</e81:ServiceLevel>
          <e81:CustomerLifeCycleStatus d4p1:nil="false">ValueHere</e81:CustomerLifeCycleStatus>
          <e81:TimeStamp d4p1:nil="false">ValueHere</e81:TimeStamp>
          <e81:Number d4p1:nil="false">ValueHere</e81:Number>
          <e81:CustomerAddress d4p1:nil="false">
            <e81:City d4p1:nil="false">ValueHere</e81:City>
            <e81:CountryCode d4p1:nil="false">ValueHere</e81:CountryCode>
            <e81:Id d4p1:nil="false">ValueHere</e81:Id>
            <e81:Line1 d4p1:nil="false">ValueHere</e81:Line1>
            <e81:Line2 d4p1:nil="false">ValueHere</e81:Line2>
            <e81:Line3 d4p1:nil="false">ValueHere</e81:Line3>
            <e81:Line4 d4p1:nil="false">ValueHere</e81:Line4>
            <e81:PostalCode d4p1:nil="false">ValueHere</e81:PostalCode>
            <e81:StateOrProvince d4p1:nil="false">ValueHere</e81:StateOrProvince>
            <e81:TimeStamp d4p1:nil="false">ValueHere</e81:TimeStamp>
            <e81:BusinessName d4p1:nil="false">ValueHere</e81:BusinessName>
          </e81:CustomerAddress>
        </e81:Customer>
      </Customers>
    </SearchCustomersResponse>
  </s:Body>
</s:Envelope>

コード構文

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

public async Task<SearchCustomersResponse> SearchCustomersAsync(
	IList<Predicate> predicates,
	DateRange dateRange,
	IList<OrderBy> ordering,
	Paging pageInfo)
{
	var request = new SearchCustomersRequest
	{
		Predicates = predicates,
		DateRange = dateRange,
		Ordering = ordering,
		PageInfo = pageInfo
	};

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

static SearchCustomersResponse searchCustomers(
	ArrayOfPredicate predicates,
	DateRange dateRange,
	ArrayOfOrderBy ordering,
	Paging pageInfo) throws RemoteException, Exception
{
	SearchCustomersRequest request = new SearchCustomersRequest();

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

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

static function SearchCustomers(
	$predicates,
	$dateRange,
	$ordering,
	$pageInfo)
{

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

	$request = new SearchCustomersRequest();

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

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

response=customermanagement_service.SearchCustomers(
	Predicates=Predicates,
	DateRange=DateRange,
	Ordering=Ordering,
	PageInfo=PageInfo)

要件

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

要求 URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Customers/Search

Request 要素

SearchCustomersRequest オブジェクトは、サービス操作要求の本文要素とヘッダー要素を定義します。

注:

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

要求本文要素

要素 説明 データ型
DateRange 顧客の作成の最小および最大日付範囲を決定します。

この要求要素は省略可能です。		 DateRange
順序 顧客の指定したプロパティによって結果の順序を決定します。

この要求要素は省略可能です。 配列には、最大 1 つの OrderBy 要素を指定できます。 追加の要素はサポートされていないため、サービスによって無視されます。

このサービス操作では、OrderBy オブジェクトの Field 要素で次の値がサポートされます。

Id - 注文は、返された Customer の Id 要素によって決まります。

名前 - 注文は、返された Customer の Name 要素によって決まります。

Number - 注文は、返された Customer の Number 要素によって決まります。		 OrderBy 配列
PageInfo ページごとの結果のインデックスとサイズを決定します。 Paging
述語 顧客を返すためにすべて満たす必要がある条件を決定します。

1 ~ 10 個の述語を含める必要があります。 作成された日付範囲でフィルター処理するには、 Field 値が CreatedDate に設定されている 2 つの述語を含めることができます。それ以外の場合は、各述語フィールドを 1 回だけ使用できます。

サポートされている各述語 フィールド 値の詳細については、「 述語の備考」を参照してください。		 述語 配列

要求ヘッダー要素

要素 説明 データ型
Authorization Microsoft Advertising アカウントへのアクセス許可を持つユーザーの資格情報を表す OAuth アクセス トークン。 トークンのプレフィックスに "Bearer" があることを確認してください。これは、適切な認証に必要です。

詳細については、「 OAuth による認証」を参照してください。		 string
DeveloperToken Bing Ads API へのアクセスに使用される開発者トークン。

詳細については、「 開発者トークンを取得する」を参照してください。		 string
Password この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string
UserName この要素は内部使用のために予約されており、今後のバージョンの API から削除されます。 ユーザー資格情報を設定するには、AuthenticationToken 要素を使用する必要があります。 string

Response 要素

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

応答本文の要素

要素 説明 データ型
顧客 要求条件を満たす顧客の一覧。 顧客 配列

応答ヘッダー要素

要素 説明 データ型
TrackingId API 呼び出しの詳細を含むログ エントリの識別子。 string

JSON を要求する

このテンプレートは、JSON 要求の 本文 と ヘッダー 要素を表示するツールによって生成されました。 このサービス操作で使用できるサポートされる型については、上記の 要求本文要素 のリファレンスを参照してください。

{
  "Predicates": [
    {
      "Field": "ValueHere",
      "Operator": "ValueHere",
      "Value": "ValueHere"
    }
  ],
  "DateRange": {
    "MaxDate": "ValueHere",
    "MinDate": "ValueHere"
  },
  "Ordering": [
    {
      "Field": "ValueHere",
      "Order": "ValueHere"
    }
  ],
  "PageInfo": {
    "Index": IntValueHere,
    "Size": IntValueHere
  }
}

応答 JSON

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

{
  "Customers": [
    {
      "CustomerAddress": {
        "BusinessName": "ValueHere",
        "City": "ValueHere",
        "CountryCode": "ValueHere",
        "Id": "LongValueHere",
        "Line1": "ValueHere",
        "Line2": "ValueHere",
        "Line3": "ValueHere",
        "Line4": "ValueHere",
        "PostalCode": "ValueHere",
        "StateOrProvince": "ValueHere",
        "TimeStamp": "ValueHere"
      },
      "CustomerFinancialStatus": "ValueHere",
      "CustomerLifeCycleStatus": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Industry": "ValueHere",
      "LastModifiedByUserId": "LongValueHere",
      "LastModifiedTime": "ValueHere",
      "MarketCountry": "ValueHere",
      "MarketLanguage": "ValueHere",
      "Name": "ValueHere",
      "Number": "ValueHere",
      "ServiceLevel": "ValueHere",
      "TimeStamp": "ValueHere"
    }
  ]
}

コード構文

SDK を使用して REST API を呼び出すには、SDK を特定のバージョンにアップグレードし、システム パラメーターを構成する必要があります。構文の例は、 Bing広告 SDK で使用できます。 その他 の例については、「Bing広告 API コードの例 」を参照してください。

public async Task<SearchCustomersResponse> SearchCustomersAsync(
	IList<Predicate> predicates,
	DateRange dateRange,
	IList<OrderBy> ordering,
	Paging pageInfo)
{
	var request = new SearchCustomersRequest
	{
		Predicates = predicates,
		DateRange = dateRange,
		Ordering = ordering,
		PageInfo = pageInfo
	};

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

static SearchCustomersResponse searchCustomers(
	ArrayOfPredicate predicates,
	DateRange dateRange,
	ArrayOfOrderBy ordering,
	Paging pageInfo) throws RemoteException, Exception
{
	SearchCustomersRequest request = new SearchCustomersRequest();

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

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

static function SearchCustomers(
	$predicates,
	$dateRange,
	$ordering,
	$pageInfo)
{

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

	$request = new SearchCustomersRequest();

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

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

response=customermanagement_service.SearchCustomers(
	Predicates=Predicates,
	DateRange=DateRange,
	Ordering=Ordering,
	PageInfo=PageInfo)