FindAccountsOrCustomersInfo 服務作業 - 客戶管理

取得符合指定篩選準則的帳戶和客戶清單。

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
篩選器	用來篩選帳戶和客戶清單的準則。 您可以指定帳戶名稱、帳戶號碼或客戶名稱。 篩選值可以包含部分或完整名稱或數位。 如果名稱或數位是以指定的篩選值開頭，則作業會在結果中包含帳戶或客戶。 當作業比較篩選值與名稱或數位時，會執行不區分大小寫的比較。 例如，如果您指定 「t」 做為篩選值，清單會包含名稱開頭為 「t」 或 「T」 的帳戶和客戶。 作業會先篩選符合篩選準則的帳戶。 如果符合篩選準則的帳戶數目小於指定的 TopN 值，作業會搜尋名稱符合篩選準則的客戶。 將此元素設定為空字串，與呼叫 GetAccountsInfo 後接呼叫 GetCustomersInfo 相同。	string
ReturnAdditionalFields	您想要包含在每個傳回帳戶中的其他屬性清單。 其他域值可讓您使用目前版本的客戶管理 API 取得最新功能，而在下一個版本中，預設會包含對應的元素。 此要求項目是選擇性的。	AccountAdditionalField
TopN	非零的正整數，指定要在結果中傳回的帳戶數目。 您必須指定 1 到 5,000 之間的值。	int

要求標頭元素

元素	描述	資料類型
AuthenticationToken	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

FindAccountsOrCustomersInfoResponse 物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應SOAP中所示的順序相同。

回應本文專案

元素	描述	資料類型
AccountInfoWithCustomerData	符合指定篩選準則之帳戶和客戶的 AccountInfoWithCustomerData 物件清單。 物件包含可識別帳戶和客戶的資訊。 若要取得清單中帳戶的完整詳細數據，請存取 AccountInfoWithCustomerData 物件的 AccountId 元素，並使用它來呼叫 GetAccount 作業。 若要取得清單中客戶的完整詳細數據，請存取 AccountInfoWithCustomerData 物件的 CustomerId 元素，並使用它來呼叫 GetCustomer。	AccountInfoWithCustomerData 陣 列

回應標頭元素

元素	描述	資料類型
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">FindAccountsOrCustomersInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <FindAccountsOrCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Filter i:nil="false">ValueHere</Filter>
      <TopN>ValueHere</TopN>
      <ReturnAdditionalFields i:nil="false">ValueHere</ReturnAdditionalFields>
    </FindAccountsOrCustomersInfoRequest>
  </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>
    <FindAccountsOrCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountInfoWithCustomerData xmlns:e21="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e21:AccountInfoWithCustomerData>
          <e21:CustomerId d4p1:nil="false">ValueHere</e21:CustomerId>
          <e21:CustomerName d4p1:nil="false">ValueHere</e21:CustomerName>
          <e21:AccountId>ValueHere</e21:AccountId>
          <e21:AccountName d4p1:nil="false">ValueHere</e21:AccountName>
          <e21:AccountNumber d4p1:nil="false">ValueHere</e21:AccountNumber>
          <e21:AccountLifeCycleStatus>ValueHere</e21:AccountLifeCycleStatus>
          <e21:PauseReason d4p1:nil="false">ValueHere</e21:PauseReason>
          <e21:AccountMode d4p1:nil="false">ValueHere</e21:AccountMode>
        </e21:AccountInfoWithCustomerData>
      </AccountInfoWithCustomerData>
    </FindAccountsOrCustomersInfoResponse>
  </s:Body>
</s:Envelope>

程序代碼語法

範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<FindAccountsOrCustomersInfoResponse> FindAccountsOrCustomersInfoAsync(
	string filter,
	int topN,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new FindAccountsOrCustomersInfoRequest
	{
		Filter = filter,
		TopN = topN,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static FindAccountsOrCustomersInfoResponse findAccountsOrCustomersInfo(
	java.lang.String filter,
	int topN,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	FindAccountsOrCustomersInfoRequest request = new FindAccountsOrCustomersInfoRequest();

	request.setFilter(filter);
	request.setTopN(topN);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function FindAccountsOrCustomersInfo(
	$filter,
	$topN,
	$returnAdditionalFields)
{

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

	$request = new FindAccountsOrCustomersInfoRequest();

	$request->Filter = $filter;
	$request->TopN = $topN;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customermanagement_service.FindAccountsOrCustomersInfo(
	Filter=Filter,
	TopN=TopN,
	ReturnAdditionalFields=ReturnAdditionalFields)

需求

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

要求 URL

生產URL

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/AccountsOrCustomersInfo/Find

沙箱 URL

https://clientcenter.api.sandbox.bingads.microsoft.com/CustomerManagement/v13/AccountsOrCustomersInfo/Find

要求專案

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

注意事項

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

要求本文專案

元素	描述	資料類型
篩選器	用來篩選帳戶和客戶清單的準則。 您可以指定帳戶名稱、帳戶號碼或客戶名稱。 篩選值可以包含部分或完整名稱或數位。 如果名稱或數位是以指定的篩選值開頭，則作業會在結果中包含帳戶或客戶。 當作業比較篩選值與名稱或數位時，會執行不區分大小寫的比較。 例如，如果您指定 「t」 做為篩選值，清單會包含名稱開頭為 「t」 或 「T」 的帳戶和客戶。 作業會先篩選符合篩選準則的帳戶。 如果符合篩選準則的帳戶數目小於指定的 TopN 值，作業會搜尋名稱符合篩選準則的客戶。 將此元素設定為空字串，與呼叫 GetAccountsInfo 後接呼叫 GetCustomersInfo 相同。	string
ReturnAdditionalFields	您想要包含在每個傳回帳戶中的其他屬性清單。 其他域值可讓您使用目前版本的客戶管理 API 取得最新功能，而在下一個版本中，預設會包含對應的元素。 此要求項目是選擇性的。	AccountAdditionalField
TopN	非零的正整數，指定要在結果中傳回的帳戶數目。 您必須指定 1 到 5,000 之間的值。	int

要求標頭元素

元素	描述	資料類型
授權	OAuth 存取令牌，代表有權Microsoft Advertising 帳戶之用戶的認證。 請確定令牌前面加上 「Bearer」 ，這是正確驗證的必要專案。 如需詳細資訊，請 參閱使用 OAuth 進行驗證。	string
DeveloperToken	用來存取 Bing 廣告 API 的開發人員令牌。 如需詳細資訊 ，請參閱取得開發人員令牌。	string
密碼	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string
UserName	此元素會保留供內部使用，並會從未來的 API 版本中移除。 您必須使用 AuthenticationToken 元素來設定用戶認證。	string

Response 元素

FindAccountsOrCustomersInfoResponse 物件會定義服務作業回應的主體和標頭元素。 這些元素的傳回順序與 回應 JSON 中所示的順序相同。

回應本文專案

元素	描述	資料類型
AccountInfoWithCustomerData	符合指定篩選準則之帳戶和客戶的 AccountInfoWithCustomerData 物件清單。 物件包含可識別帳戶和客戶的資訊。 若要取得清單中帳戶的完整詳細數據，請存取 AccountInfoWithCustomerData 物件的 AccountId 元素，並使用它來呼叫 GetAccount 作業。 若要取得清單中客戶的完整詳細數據，請存取 AccountInfoWithCustomerData 物件的 CustomerId 元素，並使用它來呼叫 GetCustomer。	AccountInfoWithCustomerData 陣 列

回應標頭元素

元素	描述	資料類型
TrackingId	包含 API 呼叫詳細數據的記錄項目識別碼。	string

要求 JSON

此範本是由工具所產生，用來顯示 JSON 要求的 主體 和 標頭 元素。 如需可搭配此服務作業使用的支援類型，請參閱上述 的要求本文項目 參考。

{
  "Filter": "ValueHere",
  "TopN": IntValueHere,
  "ReturnAdditionalFields": "ValueHere"
}

回應 JSON

此範本是由工具所產生，用來顯示 JSON 回應的 主體 和 標頭 元素。

{
  "AccountInfoWithCustomerData": [
    {
      "AccountId": "LongValueHere",
      "AccountLifeCycleStatus": "ValueHere",
      "AccountMode": "ValueHere",
      "AccountName": "ValueHere",
      "AccountNumber": "ValueHere",
      "CustomerId": "LongValueHere",
      "CustomerName": "ValueHere",
      "PauseReason": "ValueHere"
    }
  ]
}

程序代碼語法

若要透過 SDK 呼叫 REST API，您必須將 SDK 升級至特定版本並設定系統參數。範例語法可以與 Bing 廣告 SDK 搭配使用。 如需更多範例，請參閱 Bing 廣告 API 程式代碼範 例。

public async Task<FindAccountsOrCustomersInfoResponse> FindAccountsOrCustomersInfoAsync(
	string filter,
	int topN,
	AccountAdditionalField? returnAdditionalFields)
{
	var request = new FindAccountsOrCustomersInfoRequest
	{
		Filter = filter,
		TopN = topN,
		ReturnAdditionalFields = returnAdditionalFields
	};

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

static FindAccountsOrCustomersInfoResponse findAccountsOrCustomersInfo(
	java.lang.String filter,
	int topN,
	ArrayList<AccountAdditionalField> returnAdditionalFields) throws RemoteException, Exception
{
	FindAccountsOrCustomersInfoRequest request = new FindAccountsOrCustomersInfoRequest();

	request.setFilter(filter);
	request.setTopN(topN);
	request.setReturnAdditionalFields(returnAdditionalFields);

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

static function FindAccountsOrCustomersInfo(
	$filter,
	$topN,
	$returnAdditionalFields)
{

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

	$request = new FindAccountsOrCustomersInfoRequest();

	$request->Filter = $filter;
	$request->TopN = $topN;
	$request->ReturnAdditionalFields = $returnAdditionalFields;

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

response=customermanagement_service.FindAccountsOrCustomersInfo(
	Filter=Filter,
	TopN=TopN,
	ReturnAdditionalFields=ReturnAdditionalFields)