Partilhar via

Operação de Serviço FindAccountsOrCustomersInfo - Gestão de Clientes

  • Artigo

Obtém uma lista das contas e clientes que correspondem aos critérios de filtro especificados.

Elementos do Pedido

O objeto FindAccountsOrCustomersInfoRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço. Os elementos têm de estar na mesma ordem mostrada no Pedido SOAP.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento Descrição Tipo de Dados
Filtro Os critérios a utilizar para filtrar a lista de contas e clientes. Pode especificar um nome de conta, número de conta ou nome de cliente.

O valor do filtro pode conter um nome ou número parcial ou completo. A operação inclui a conta ou o cliente no resultado se o nome ou número começar com o valor de filtro especificado.

A operação efetua uma comparação não sensível a maiúsculas e minúsculas quando compara o valor do filtro com o nome ou número. Por exemplo, se especificar "t" como o valor de filtro, a lista incluirá contas e clientes cujos nomes começam por "t" ou "T".

A operação filtra primeiro as contas que correspondem aos critérios de filtro. Se o número de contas que correspondem aos critérios de filtro for menor do que o valor TopN especificado, a operação procura clientes cujo nome corresponda aos critérios de filtro.

Definir este elemento para uma cadeia vazia é o mesmo que chamar GetAccountsInfo seguido de chamar GetCustomersInfo.		 cadeia
ReturnAdditionalFields A lista de propriedades adicionais que pretende incluir em cada conta devolvida. Os valores de campo adicionais permitem-lhe obter as funcionalidades mais recentes com a versão atual da API de Gestão de Clientes e, na próxima versão, os elementos correspondentes serão incluídos por predefinição.

Este elemento de pedido é opcional.		 AccountAdditionalField
TopN Um número inteiro não zero positivo que especifica o número de contas a devolver no resultado. Tem de especificar um valor de 1 a 5000. int

Elementos do Cabeçalho do Pedido

Elemento Descrição Tipo de Dados
AuthenticationToken O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising.

Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).		 cadeia
DeveloperToken O token de programador utilizado para aceder à API de Anúncios do Bing.

Para obter mais informações, veja Obter um Token de Programador.		 cadeia
Palavra-passe Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia
Nome de Utilizador Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia

Elementos de Resposta

O objeto FindAccountsOrCustomersInfoResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no SOAP de Resposta.

Elementos do Corpo da Resposta

Elemento Descrição Tipo de Dados
AccountInfoWithCustomerData Uma lista de objetos AccountInfoWithCustomerData das contas e clientes que correspondem aos critérios de filtro especificados.

Os objetos contêm informações que identificam a conta e o cliente. Para obter os detalhes completos de uma conta na lista, aceda ao elemento AccountId do objeto AccountInfoWithCustomerData e utilize-o para chamar a operação GetAccount .

Para obter os detalhes completos de um cliente na lista, aceda ao elemento CustomerId do objeto AccountInfoWithCustomerData e utilize-o para chamar GetCustomer.		 AccountInfoWithCustomerData array (Matriz AccountInfoWithCustomerData )

Elementos do Cabeçalho de Resposta

Elemento Descrição Tipo de Dados
TrackingId O identificador da entrada de registo que contém os detalhes da chamada à API. cadeia

Pedir SOAP

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho do pedido SOAP. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

<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 de Resposta

Este modelo foi gerado por uma ferramenta para mostrar a ordem dos elementos do corpo e do cabeçalho para a resposta 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>

Sintaxe de Código

A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)

Requisitos

Serviço: CustomerManagementService.svc v13
Espaço de nomes: https://bingads.microsoft.com/Customer/v13

URL do Pedido

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

Elementos do Pedido

O objeto FindAccountsOrCustomersInfoRequest define os elementos do corpo e do cabeçalho do pedido de operação do serviço.

Nota

Salvo indicação em contrário abaixo, todos os elementos do pedido são necessários.

Elementos do Corpo do Pedido

Elemento Descrição Tipo de Dados
Filtro Os critérios a utilizar para filtrar a lista de contas e clientes. Pode especificar um nome de conta, número de conta ou nome de cliente.

O valor do filtro pode conter um nome ou número parcial ou completo. A operação inclui a conta ou o cliente no resultado se o nome ou número começar com o valor de filtro especificado.

A operação efetua uma comparação não sensível a maiúsculas e minúsculas quando compara o valor do filtro com o nome ou número. Por exemplo, se especificar "t" como o valor de filtro, a lista incluirá contas e clientes cujos nomes começam por "t" ou "T".

A operação filtra primeiro as contas que correspondem aos critérios de filtro. Se o número de contas que correspondem aos critérios de filtro for menor do que o valor TopN especificado, a operação procura clientes cujo nome corresponda aos critérios de filtro.

Definir este elemento para uma cadeia vazia é o mesmo que chamar GetAccountsInfo seguido de chamar GetCustomersInfo.		 cadeia
ReturnAdditionalFields A lista de propriedades adicionais que pretende incluir em cada conta devolvida. Os valores de campo adicionais permitem-lhe obter as funcionalidades mais recentes com a versão atual da API de Gestão de Clientes e, na próxima versão, os elementos correspondentes serão incluídos por predefinição.

Este elemento de pedido é opcional.		 AccountAdditionalField
TopN Um número inteiro não zero positivo que especifica o número de contas a devolver no resultado. Tem de especificar um valor de 1 a 5000. int

Elementos do Cabeçalho do Pedido

Elemento Descrição Tipo de Dados
Autorização O token de acesso OAuth que representa as credenciais de um utilizador que tem permissões para contas do Microsoft Advertising. Certifique-se de que o token tem o prefixo "Portador", que é necessário para uma autenticação adequada.

Para obter mais informações, veja Authentication with OAuth (Autenticação com OAuth).		 cadeia
DeveloperToken O token de programador utilizado para aceder à API de Anúncios do Bing.

Para obter mais informações, veja Obter um Token de Programador.		 cadeia
Palavra-passe Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia
Nome de Utilizador Este elemento está reservado para utilização interna e será removido de uma versão futura da API. Tem de utilizar o elemento AuthenticationToken para definir credenciais de utilizador. cadeia

Elementos de Resposta

O objeto FindAccountsOrCustomersInfoResponse define os elementos do corpo e do cabeçalho da resposta da operação do serviço. Os elementos são devolvidos pela mesma ordem mostrada no JSON de Resposta.

Elementos do Corpo da Resposta

Elemento Descrição Tipo de Dados
AccountInfoWithCustomerData Uma lista de objetos AccountInfoWithCustomerData das contas e clientes que correspondem aos critérios de filtro especificados.

Os objetos contêm informações que identificam a conta e o cliente. Para obter os detalhes completos de uma conta na lista, aceda ao elemento AccountId do objeto AccountInfoWithCustomerData e utilize-o para chamar a operação GetAccount .

Para obter os detalhes completos de um cliente na lista, aceda ao elemento CustomerId do objeto AccountInfoWithCustomerData e utilize-o para chamar GetCustomer.		 AccountInfoWithCustomerData array (Matriz AccountInfoWithCustomerData )

Elementos do Cabeçalho de Resposta

Elemento Descrição Tipo de Dados
TrackingId O identificador da entrada de registo que contém os detalhes da chamada à API. cadeia

Pedir JSON

Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho do pedido JSON. Para tipos suportados que pode utilizar com esta operação de serviço, veja a referência Request Body Elements (Elementos do Corpo do Pedido ) acima.

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

JSON de Resposta

Este modelo foi gerado por uma ferramenta para mostrar os elementos do corpo e do cabeçalho da resposta JSON.

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

Sintaxe de Código

Para chamar a API REST através de SDKs, tem de atualizar o SDK para uma determinada versão e configurar os parâmetros do sistema. A sintaxe de exemplo pode ser utilizada com os SDKs de Anúncios do Bing. Veja Exemplos de Código da API de Anúncios do Bing para obter mais exemplos.

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)