通过

GetCustomersInfo 服务操作 - 客户管理

  • 项目

获取当前经过身份验证的用户可访问的客户标识符和名称。

结果按客户名称进行筛选。

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
CustomerNameFilter 要获取的部分客户或全名。 如果客户的名称以指定的筛选器名称开头，则操作在结果中包括客户。

此请求元素是可选的。 如果不想按客户名称进行筛选，请将此元素设置为空字符串。

当将名称筛选器值与客户名称进行比较时，该操作将执行不区分大小写的比较。 例如，如果指定“t”作为筛选器值，列表将包括其名称以“t”或“T”开头的客户。		 string
TopN 一个非零正整数，指定要在结果中返回的客户数。 int

请求标头元素

元素 说明 数据类型
AuthenticationToken OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

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

响应正文元素

元素 说明 数据类型
CustomersInfo 有关符合请求条件的客户的信息列表。 CustomerInfo 数组

响应标头元素

元素 说明 数据类型
跟踪 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">GetCustomersInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerNameFilter i:nil="false">ValueHere</CustomerNameFilter>
      <TopN>ValueHere</TopN>
    </GetCustomersInfoRequest>
  </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>
    <GetCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomersInfo xmlns:e37="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e37:CustomerInfo>
          <e37:Id d4p1:nil="false">ValueHere</e37:Id>
          <e37:Name d4p1:nil="false">ValueHere</e37:Name>
        </e37:CustomerInfo>
      </CustomersInfo>
    </GetCustomersInfoResponse>
  </s:Body>
</s:Envelope>

代码语法

示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<GetCustomersInfoResponse> GetCustomersInfoAsync(
	string customerNameFilter,
	int topN)
{
	var request = new GetCustomersInfoRequest
	{
		CustomerNameFilter = customerNameFilter,
		TopN = topN
	};

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

static GetCustomersInfoResponse getCustomersInfo(
	java.lang.String customerNameFilter,
	int topN) throws RemoteException, Exception
{
	GetCustomersInfoRequest request = new GetCustomersInfoRequest();

	request.setCustomerNameFilter(customerNameFilter);
	request.setTopN(topN);

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

static function GetCustomersInfo(
	$customerNameFilter,
	$topN)
{

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

	$request = new GetCustomersInfoRequest();

	$request->CustomerNameFilter = $customerNameFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.GetCustomersInfo(
	CustomerNameFilter=CustomerNameFilter,
	TopN=TopN)

要求

服务： CustomerManagementService.svc v13
命名空间： https://bingads.microsoft.com/Customer/v13

请求 URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/CustomersInfo/Query

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
CustomerNameFilter 要获取的部分客户或全名。 如果客户的名称以指定的筛选器名称开头，则操作在结果中包括客户。

此请求元素是可选的。 如果不想按客户名称进行筛选，请将此元素设置为空字符串。

当将名称筛选器值与客户名称进行比较时，该操作将执行不区分大小写的比较。 例如，如果指定“t”作为筛选器值，列表将包括其名称以“t”或“T”开头的客户。		 string
TopN 一个非零正整数，指定要在结果中返回的客户数。 int

请求标头元素

元素 说明 数据类型
Authorization OAuth 访问令牌，表示有权Microsoft广告帐户的用户的凭据。 请确保令牌的前缀为“持有者”，这是正确身份验证所必需的。

有关详细信息，请参阅 使用 OAuth 进行身份验证。		 string
DeveloperToken 用于访问必应广告 API 的开发人员令牌。

有关详细信息，请参阅 获取开发人员令牌。		 string
Password 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string
UserName 此元素保留供内部使用，将从 API 的未来版本中删除。 必须使用 AuthenticationToken 元素来设置用户凭据。 string

响应元素

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

响应正文元素

元素 说明 数据类型
CustomersInfo 有关符合请求条件的客户的信息列表。 CustomerInfo 数组

响应标头元素

元素 说明 数据类型
跟踪 ID 包含 API 调用详细信息的日志条目的标识符。 string

请求 JSON

此模板由显示 JSON 请求的 正文 和 标头 元素的工具生成。 有关可用于此服务操作的支持类型，请参阅上面的 请求正文元素 参考。

{
  "CustomerNameFilter": "ValueHere",
  "TopN": IntValueHere
}

响应 JSON

此模板由一个工具生成，用于显示 JSON 响应的 正文 和 标头 元素。

{
  "CustomersInfo": [
    {
      "Id": "LongValueHere",
      "Name": "ValueHere"
    }
  ]
}

代码语法

若要通过 SDK 调用 REST API，需要将 SDK 升级到特定版本并配置系统参数。示例语法可用于 必应广告 SDK。 有关更多示例，请参阅 必应广告 API 代码示例 。

public async Task<GetCustomersInfoResponse> GetCustomersInfoAsync(
	string customerNameFilter,
	int topN)
{
	var request = new GetCustomersInfoRequest
	{
		CustomerNameFilter = customerNameFilter,
		TopN = topN
	};

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

static GetCustomersInfoResponse getCustomersInfo(
	java.lang.String customerNameFilter,
	int topN) throws RemoteException, Exception
{
	GetCustomersInfoRequest request = new GetCustomersInfoRequest();

	request.setCustomerNameFilter(customerNameFilter);
	request.setTopN(topN);

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

static function GetCustomersInfo(
	$customerNameFilter,
	$topN)
{

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

	$request = new GetCustomersInfoRequest();

	$request->CustomerNameFilter = $customerNameFilter;
	$request->TopN = $topN;

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

response=customermanagement_service.GetCustomersInfo(
	CustomerNameFilter=CustomerNameFilter,
	TopN=TopN)