共用方式為

SearchCustomers 服務作業 - 客戶管理

  • 發行項

搜尋符合要求準則的客戶。

要求專案

SearchCustomersRequest 物件會定義服務作業要求的主體和標頭元素。 元素的順序必須與 要求SOAP中所示的順序相同。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素 描述 資料類型
DateRange 決定客戶建立日期範圍的最小和最大值。

此要求項目是選擇性的。		 DateRange
訂購 根據客戶的指定屬性來決定結果的順序。

此要求項目是選擇性的。 您最多可以在陣列中指定一個 OrderBy 元素。 不支援其他項目，服務將會忽略這些專案。

針對此服務作業，OrderBy 物件的 Field 元素支援下列值：

標識碼 - 訂單是由傳回之 Customer 的 Id 元素所決定。

名稱 - 訂單取決於傳回之 Customer 的 Name元素。

Number - 訂單是由傳回之 Customer 的 Number 元素所決定。		 OrderBy 陣 列
PageInfo 決定每頁結果的索引和大小。 分頁
謂詞 決定必須符合所有條件才能傳回客戶。

您必須包含一到10個述詞。 若要依建立的日期範圍進行篩選，您可以包含兩個述詞， 並將 Field 值設定為 CreatedDate，否則只能使用每個述詞欄位一次。

如需每個支援述詞 域 值的詳細資訊，請參閱 述詞備註。		 述詞陣 語

要求標頭元素

元素 描述 資料類型
AuthenticationToken OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。

如需詳細資訊，請 參閱使用 OAuth 進行驗證。		 string
DeveloperToken 用來存取 Bing 廣告 API 的開發人員令牌。

如需詳細資訊 ，請參閱取得開發人員令牌。		 string
密碼 此元素會保留供內部使用，並會從未來的 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
命名空間： https://bingads.microsoft.com/Customer/v13

要求 URL

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

要求專案

SearchCustomersRequest 物件會定義服務作業要求的主體和標頭元素。

注意事項

除非下面另有說明，否則所有要求專案都是必要的。

要求本文專案

元素 描述 資料類型
DateRange 決定客戶建立日期範圍的最小和最大值。

此要求項目是選擇性的。		 DateRange
訂購 根據客戶的指定屬性來決定結果的順序。

此要求項目是選擇性的。 您最多可以在陣列中指定一個 OrderBy 元素。 不支援其他項目，服務將會忽略這些專案。

針對此服務作業，OrderBy 物件的 Field 元素支援下列值：

標識碼 - 訂單是由傳回之 Customer 的 Id 元素所決定。

名稱 - 訂單取決於傳回之 Customer 的 Name元素。

Number - 訂單是由傳回之 Customer 的 Number 元素所決定。		 OrderBy 陣 列
PageInfo 決定每頁結果的索引和大小。 分頁
謂詞 決定必須符合所有條件才能傳回客戶。

您必須包含一到10個述詞。 若要依建立的日期範圍進行篩選，您可以包含兩個述詞， 並將 Field 值設定為 CreatedDate，否則只能使用每個述詞欄位一次。

如需每個支援述詞 域 值的詳細資訊，請參閱 述詞備註。		 述詞陣 語

要求標頭元素

元素 描述 資料類型
授權 OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。

如需詳細資訊，請 參閱使用 OAuth 進行驗證。		 string
DeveloperToken 用來存取 Bing 廣告 API 的開發人員令牌。

如需詳細資訊 ，請參閱取得開發人員令牌。		 string
密碼 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string
UserName 此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。 string

Response 元素

SearchCustomersResponse 物件會定義服務作業響應的主體和標頭元素。 這些元素的傳回順序與 回應 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)