SearchCustomers 服务操作 - 客户管理

搜索符合请求条件的客户。

请求元素

SearchCustomersRequest 对象定义服务操作请求的正文和标头元素。 元素的顺序必须与 请求 SOAP 中所示的顺序相同。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
DateRange	确定最小和最大客户创建日期范围。 此请求元素是可选的。	DateRange
订购	按客户的指定属性确定结果的顺序。 此请求元素是可选的。 最多可以在数组中指定一个 OrderBy 元素。 其他元素不受支持，服务将忽略。 对于此服务操作，OrderBy 对象的 Field 元素支持以下值： ID - 订单由返回的 Customer 的 Id 元素决定。 名称 - 订单由返回的 Customer 的 Name 元素决定。 Number - 订单由返回的 Customer 的 Number 元素决定。	OrderBy 数组
PageInfo	确定每页结果的索引和大小。	分页
谓词	确定返回客户必须满足的所有条件。 必须包含 1 到 10 个谓词。 若要按创建的日期范围进行筛选，可以包含两个谓词，并将 字段 值设置为 CreatedDate，否则只能使用每个谓词字段一次。 有关每个支持的谓词 字段 值的详细信息，请参阅 谓词备注。	谓词 数组

请求标头元素

元素	说明	数据类型
AuthenticationToken	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

SearchCustomersResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 SOAP 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
客户	符合请求条件的客户列表。	客户 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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

生产 URL

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

沙盒 URL

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

请求元素

SearchCustomersRequest 对象定义服务操作请求的正文和标头元素。

注意

除非下面另有说明，否则需要所有请求元素。

请求正文元素

元素	说明	数据类型
DateRange	确定最小和最大客户创建日期范围。 此请求元素是可选的。	DateRange
订购	按客户的指定属性确定结果的顺序。 此请求元素是可选的。 最多可以在数组中指定一个 OrderBy 元素。 其他元素不受支持，服务将忽略。 对于此服务操作，OrderBy 对象的 Field 元素支持以下值： ID - 订单由返回的 Customer 的 Id 元素决定。 名称 - 订单由返回的 Customer 的 Name 元素决定。 Number - 订单由返回的 Customer 的 Number 元素决定。	OrderBy 数组
PageInfo	确定每页结果的索引和大小。	分页
谓词	确定返回客户必须满足的所有条件。 必须包含 1 到 10 个谓词。 若要按创建的日期范围进行筛选，可以包含两个谓词，并将 字段 值设置为 CreatedDate，否则只能使用每个谓词字段一次。 有关每个支持的谓词 字段 值的详细信息，请参阅 谓词备注。	谓词 数组

请求标头元素

元素	说明	数据类型
Authorization	OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。 有关详细信息，请参阅 使用 OAuth 进行身份验证。	string
DeveloperToken	用于访问必应广告 API 的开发人员令牌。 有关详细信息，请参阅 获取开发人员令牌。	string
Password	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string
UserName	此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。	string

响应元素

SearchCustomersResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 JSON 中所示的顺序相同。

响应正文元素

元素	说明	数据类型
客户	符合请求条件的客户列表。	客户 数组

响应标头元素

元素	说明	数据类型
跟踪 ID	包含 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 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 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)