通过

SearchAccounts 服务操作 - 客户管理

  • 项目

搜索与请求条件匹配的帐户。

例如，可以搜索当前经过身份验证的用户可以访问的帐户。

提示

有关示例的概述，请参阅 帐户层次结构和用户权限 指南。

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
订购 按帐户的指定属性确定结果的顺序。

此请求元素是可选的。 最多可以在数组中指定一个 OrderBy 元素。 其他元素不受支持，服务将忽略。

如果将 OrderBy 对象的 Field 元素设置为“Id”、“Name”或“Number”，则返回的 Accounts 将相应地按帐户标识符、名称或数字排序。

此请求元素是可选的。		 OrderBy 数组
PageInfo 确定每页结果的索引和大小。 分页
谓词 确定返回帐户必须满足的所有条件。

必须仅包含一个谓词。 如果谓词 字段 设置为“AccountLifeCycleStatus”，则必须指定一个附加谓词，并将 字段 设置为另一个值，例如 UserId。

有关每个支持的谓词 字段 值的详细信息，请参阅 谓词备注。		 谓词 数组
ReturnAdditionalFields 要包含在每个返回的帐户中的其他属性的列表。 借助其他字段值，可以使用当前版本的客户管理 API 获取最新功能，并在下一个版本中默认包含相应的元素。

此请求元素是可选的。		 AccountAdditionalField

请求标头元素

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

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

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

响应元素

SearchAccountsResponse 对象定义服务操作响应的正文和标头元素。 元素的返回顺序与 响应 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">SearchAccounts</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <SearchAccountsRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Predicates xmlns:e53="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e53:Predicate>
          <e53:Field i:nil="false">ValueHere</e53:Field>
          <e53:Operator>ValueHere</e53:Operator>
          <e53:Value i:nil="false">ValueHere</e53:Value>
        </e53:Predicate>
      </Predicates>
      <Ordering xmlns:e54="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e54:OrderBy>
          <e54:Field>ValueHere</e54:Field>
          <e54:Order>ValueHere</e54:Order>
        </e54:OrderBy>
      </Ordering>
      <PageInfo xmlns:e55="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e55:Index>ValueHere</e55:Index>
        <e55:Size>ValueHere</e55:Size>
      </PageInfo>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </SearchAccountsRequest>
  </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>
    <SearchAccountsResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <Accounts xmlns:e56="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e56:AdvertiserAccount>
          <e56:BillToCustomerId d4p1:nil="false">ValueHere</e56:BillToCustomerId>
          <e56:CurrencyCode d4p1:nil="false">ValueHere</e56:CurrencyCode>
          <e56:AccountFinancialStatus d4p1:nil="false">ValueHere</e56:AccountFinancialStatus>
          <e56:Id d4p1:nil="false">ValueHere</e56:Id>
          <e56:Language d4p1:nil="false">ValueHere</e56:Language>
          <e56:LastModifiedByUserId d4p1:nil="false">ValueHere</e56:LastModifiedByUserId>
          <e56:LastModifiedTime d4p1:nil="false">ValueHere</e56:LastModifiedTime>
          <e56:Name d4p1:nil="false">ValueHere</e56:Name>
          <e56:Number d4p1:nil="false">ValueHere</e56:Number>
          <e56:ParentCustomerId>ValueHere</e56:ParentCustomerId>
          <e56:PaymentMethodId d4p1:nil="false">ValueHere</e56:PaymentMethodId>
          <e56:PaymentMethodType d4p1:nil="false">ValueHere</e56:PaymentMethodType>
          <e56:PrimaryUserId d4p1:nil="false">ValueHere</e56:PrimaryUserId>
          <e56:AccountLifeCycleStatus d4p1:nil="false">ValueHere</e56:AccountLifeCycleStatus>
          <e56:TimeStamp d4p1:nil="false">ValueHere</e56:TimeStamp>
          <e56:TimeZone d4p1:nil="false">ValueHere</e56:TimeZone>
          <e56:PauseReason d4p1:nil="false">ValueHere</e56:PauseReason>
          <e56:ForwardCompatibilityMap xmlns:e57="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e57:KeyValuePairOfstringstring>
              <e57:key d4p1:nil="false">ValueHere</e57:key>
              <e57:value d4p1:nil="false">ValueHere</e57:value>
            </e57:KeyValuePairOfstringstring>
          </e56:ForwardCompatibilityMap>
          <e56:LinkedAgencies d4p1:nil="false">
            <e56:CustomerInfo>
              <e56:Id d4p1:nil="false">ValueHere</e56:Id>
              <e56:Name d4p1:nil="false">ValueHere</e56:Name>
            </e56:CustomerInfo>
          </e56:LinkedAgencies>
          <e56:SalesHouseCustomerId d4p1:nil="false">ValueHere</e56:SalesHouseCustomerId>
          <e56:TaxInformation xmlns:e58="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
            <e58:KeyValuePairOfstringstring>
              <e58:key d4p1:nil="false">ValueHere</e58:key>
              <e58:value d4p1:nil="false">ValueHere</e58:value>
            </e58:KeyValuePairOfstringstring>
          </e56:TaxInformation>
          <e56:BackUpPaymentInstrumentId d4p1:nil="false">ValueHere</e56:BackUpPaymentInstrumentId>
          <e56:BillingThresholdAmount d4p1:nil="false">ValueHere</e56:BillingThresholdAmount>
          <e56:BusinessAddress d4p1:nil="false">
            <e56:City d4p1:nil="false">ValueHere</e56:City>
            <e56:CountryCode d4p1:nil="false">ValueHere</e56:CountryCode>
            <e56:Id d4p1:nil="false">ValueHere</e56:Id>
            <e56:Line1 d4p1:nil="false">ValueHere</e56:Line1>
            <e56:Line2 d4p1:nil="false">ValueHere</e56:Line2>
            <e56:Line3 d4p1:nil="false">ValueHere</e56:Line3>
            <e56:Line4 d4p1:nil="false">ValueHere</e56:Line4>
            <e56:PostalCode d4p1:nil="false">ValueHere</e56:PostalCode>
            <e56:StateOrProvince d4p1:nil="false">ValueHere</e56:StateOrProvince>
            <e56:TimeStamp d4p1:nil="false">ValueHere</e56:TimeStamp>
            <e56:BusinessName d4p1:nil="false">ValueHere</e56:BusinessName>
          </e56:BusinessAddress>
          <e56:AutoTagType d4p1:nil="false">ValueHere</e56:AutoTagType>
          <e56:SoldToPaymentInstrumentId d4p1:nil="false">ValueHere</e56:SoldToPaymentInstrumentId>
          <e56:TaxCertificate d4p1:nil="false">
            <e56:TaxCertificateBlobContainerName d4p1:nil="false">ValueHere</e56:TaxCertificateBlobContainerName>
            <e56:TaxCertificates xmlns:e59="http://schemas.datacontract.org/2004/07/System.Collections.Generic" d4p1:nil="false">
              <e59:KeyValuePairOfstringbase64Binary>
                <e59:key d4p1:nil="false">ValueHere</e59:key>
                <e59:value d4p1:nil="false">ValueHere</e59:value>
              </e59:KeyValuePairOfstringbase64Binary>
            </e56:TaxCertificates>
            <e56:Status d4p1:nil="false">ValueHere</e56:Status>
          </e56:TaxCertificate>
          <e56:AccountMode d4p1:nil="false">ValueHere</e56:AccountMode>
        </e56:AdvertiserAccount>
      </Accounts>
    </SearchAccountsResponse>
  </s:Body>
</s:Envelope>

代码语法

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

public async Task<SearchAccountsResponse> SearchAccountsAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new SearchAccountsRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchAccountsResponse searchAccounts(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchAccountsRequest request = new SearchAccountsRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function SearchAccounts(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchAccountsRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customermanagement_service.SearchAccounts(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)

要求

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

请求 URL

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

请求元素

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

注意

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

请求正文元素

元素 说明 数据类型
订购 按帐户的指定属性确定结果的顺序。

此请求元素是可选的。 最多可以在数组中指定一个 OrderBy 元素。 其他元素不受支持，服务将忽略。

如果将 OrderBy 对象的 Field 元素设置为“Id”、“Name”或“Number”，则返回的 Accounts 将相应地按帐户标识符、名称或数字排序。

此请求元素是可选的。		 OrderBy 数组
PageInfo 确定每页结果的索引和大小。 分页
谓词 确定返回帐户必须满足的所有条件。

必须仅包含一个谓词。 如果谓词 字段 设置为“AccountLifeCycleStatus”，则必须指定一个附加谓词，并将 字段 设置为另一个值，例如 UserId。

有关每个支持的谓词 字段 值的详细信息，请参阅 谓词备注。		 谓词 数组
ReturnAdditionalFields 要包含在每个返回的帐户中的其他属性的列表。 借助其他字段值，可以使用当前版本的客户管理 API 获取最新功能，并在下一个版本中默认包含相应的元素。

此请求元素是可选的。		 AccountAdditionalField

请求标头元素

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

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

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

响应元素

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

响应正文元素

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

响应标头元素

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

请求 JSON

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

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

响应 JSON

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

{
  "Accounts": [
    {
      "AccountFinancialStatus": "ValueHere",
      "AccountLifeCycleStatus": "ValueHere",
      "AccountMode": "ValueHere",
      "AutoTagType": "ValueHere",
      "BackUpPaymentInstrumentId": "LongValueHere",
      "BillingThresholdAmount": DecimalValueHere,
      "BillToCustomerId": "LongValueHere",
      "BusinessAddress": {
        "BusinessName": "ValueHere",
        "City": "ValueHere",
        "CountryCode": "ValueHere",
        "Id": "LongValueHere",
        "Line1": "ValueHere",
        "Line2": "ValueHere",
        "Line3": "ValueHere",
        "Line4": "ValueHere",
        "PostalCode": "ValueHere",
        "StateOrProvince": "ValueHere",
        "TimeStamp": "ValueHere"
      },
      "CurrencyCode": "ValueHere",
      "ForwardCompatibilityMap": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "Id": "LongValueHere",
      "Language": "ValueHere",
      "LastModifiedByUserId": "LongValueHere",
      "LastModifiedTime": "ValueHere",
      "LinkedAgencies": [
        {
          "Id": "LongValueHere",
          "Name": "ValueHere"
        }
      ],
      "Name": "ValueHere",
      "Number": "ValueHere",
      "ParentCustomerId": "LongValueHere",
      "PauseReason": "ValueHere",
      "PaymentMethodId": "LongValueHere",
      "PaymentMethodType": "ValueHere",
      "PrimaryUserId": "LongValueHere",
      "SalesHouseCustomerId": "LongValueHere",
      "SoldToPaymentInstrumentId": "LongValueHere",
      "TaxCertificate": {
        "Status": "ValueHere",
        "TaxCertificateBlobContainerName": "ValueHere",
        "TaxCertificates": [
          {
            "key": "ValueHere",
            "value": "ValueHere"
          }
        ]
      },
      "TaxInformation": [
        {
          "key": "ValueHere",
          "value": "ValueHere"
        }
      ],
      "TimeStamp": "ValueHere",
      "TimeZone": "ValueHere"
    }
  ]
}

代码语法

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

public async Task<SearchAccountsResponse> SearchAccountsAsync(
	IList<Predicate> predicates,
	IList<OrderBy> ordering,
	Paging pageInfo,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new SearchAccountsRequest
	{
		Predicates = predicates,
		Ordering = ordering,
		PageInfo = pageInfo,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static SearchAccountsResponse searchAccounts(
	ArrayOfPredicate predicates,
	ArrayOfOrderBy ordering,
	Paging pageInfo,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	SearchAccountsRequest request = new SearchAccountsRequest();

	request.setPredicates(predicates);
	request.setOrdering(ordering);
	request.setPageInfo(pageInfo);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function SearchAccounts(
	$predicates,
	$ordering,
	$pageInfo,
	$returnAdditionalFields)
{

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

	$request = new SearchAccountsRequest();

	$request->Predicates = $predicates;
	$request->Ordering = $ordering;
	$request->PageInfo = $pageInfo;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customermanagement_service.SearchAccounts(
	Predicates=Predicates,
	Ordering=Ordering,
	PageInfo=PageInfo,
	ReturnAdditionalFields=ReturnAdditionalFields)