Operação getCustomersInfo - Gestão de Clientes

Artigo
12/21/2023

Obtém os identificadores e os nomes dos clientes que estão acessíveis ao utilizador autenticado atual.

Os resultados são filtrados pelo nome do cliente.

Elementos do Pedido

O objeto GetCustomersInfoRequest 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
CustomerNameFilter	Um nome parcial ou completo dos clientes que pretende obter. A operação inclui o cliente no resultado se o nome do cliente começar com o nome de filtro especificado. Este elemento de pedido é opcional. Se não quiser filtrar pelo nome do cliente, defina este elemento como uma cadeia vazia. A operação efetua uma comparação não sensível a maiúsculas e minúsculas quando compara o valor do filtro de nome com os nomes dos clientes. Por exemplo, se especificar "t" como o valor de filtro, a lista incluirá clientes cujos nomes começam por "t" ou "T".	cadeia
TopN	Um número inteiro não zero positivo que especifica o número de clientes a devolver no resultado.	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 GetCustomersInfoResponse 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
CustomersInfo	A lista de informações sobre clientes que correspondem aos critérios do pedido.	Matriz CustomerInfo

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">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 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>
    <GetCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomersInfo xmlns:e235="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e235:CustomerInfo>
          <e235:Id d4p1:nil="false">ValueHere</e235:Id>
          <e235:Name d4p1:nil="false">ValueHere</e235:Name>
        </e235:CustomerInfo>
      </CustomersInfo>
    </GetCustomersInfoResponse>
  </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<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)

Requisitos

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

Partilhar via