Partilhar via

Operação getLinkedAccountsAndCustomersInfo – Gestão de Clientes

  • Artigo

Obtém a hierarquia do cliente e da conta no cliente especificado.

Elementos do Pedido

O objeto GetLinkedAccountsAndCustomersInfoRequest 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
CustomerId O identificador do cliente cuja hierarquia pretende obter. Longo
OnlyParentAccounts Determina se deve devolver apenas as contas de anunciante que pertencem ao cliente ou também devolver clientes ligados e contas de anunciantes associadas noutros clientes.

Para limitar os resultados a contas de anunciante diretamente no cliente especificado, defina este elemento como verdadeiro e, de outra forma, deixe-o vazio ou defina a propriedade como falso. O valor predefinido é falso.		 booleano

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 GetLinkedAccountsAndCustomersInfoResponse 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
AccountsInfo A lista de informações sobre contas de anunciantes que correspondem aos critérios do pedido.

Tenha em atenção que pode haver um atraso de até cinco minutos a partir do momento em que cria uma conta até que as informações da conta sejam incluídas na resposta.		 Matriz AccountInfo
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">GetLinkedAccountsAndCustomersInfo</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <GetLinkedAccountsAndCustomersInfoRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <CustomerId i:nil="false">ValueHere</CustomerId>
      <OnlyParentAccounts>ValueHere</OnlyParentAccounts>
    </GetLinkedAccountsAndCustomersInfoRequest>
  </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>
    <GetLinkedAccountsAndCustomersInfoResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountsInfo xmlns:e39="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e39:AccountInfo>
          <e39:Id>ValueHere</e39:Id>
          <e39:Name d4p1:nil="false">ValueHere</e39:Name>
          <e39:Number d4p1:nil="false">ValueHere</e39:Number>
          <e39:AccountLifeCycleStatus>ValueHere</e39:AccountLifeCycleStatus>
          <e39:PauseReason d4p1:nil="false">ValueHere</e39:PauseReason>
        </e39:AccountInfo>
      </AccountsInfo>
      <CustomersInfo xmlns:e40="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e40:CustomerInfo>
          <e40:Id d4p1:nil="false">ValueHere</e40:Id>
          <e40:Name d4p1:nil="false">ValueHere</e40:Name>
        </e40:CustomerInfo>
      </CustomersInfo>
    </GetLinkedAccountsAndCustomersInfoResponse>
  </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<GetLinkedAccountsAndCustomersInfoResponse> GetLinkedAccountsAndCustomersInfoAsync(
	long? customerId,
	bool onlyParentAccounts)
{
	var request = new GetLinkedAccountsAndCustomersInfoRequest
	{
		CustomerId = customerId,
		OnlyParentAccounts = onlyParentAccounts
	};

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

static GetLinkedAccountsAndCustomersInfoResponse getLinkedAccountsAndCustomersInfo(
	java.lang.Long customerId,
	boolean onlyParentAccounts) throws RemoteException, Exception
{
	GetLinkedAccountsAndCustomersInfoRequest request = new GetLinkedAccountsAndCustomersInfoRequest();

	request.setCustomerId(customerId);
	request.setOnlyParentAccounts(onlyParentAccounts);

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

static function GetLinkedAccountsAndCustomersInfo(
	$customerId,
	$onlyParentAccounts)
{

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

	$request = new GetLinkedAccountsAndCustomersInfoRequest();

	$request->CustomerId = $customerId;
	$request->OnlyParentAccounts = $onlyParentAccounts;

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

response=customermanagement_service.GetLinkedAccountsAndCustomersInfo(
	CustomerId=CustomerId,
	OnlyParentAccounts=OnlyParentAccounts)

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/LinkedAccountsAndCustomersInfo/Query

Elementos do Pedido

O objeto GetLinkedAccountsAndCustomersInfoRequest 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
CustomerId O identificador do cliente cuja hierarquia pretende obter. Longo
OnlyParentAccounts Determina se deve devolver apenas as contas de anunciante que pertencem ao cliente ou também devolver clientes ligados e contas de anunciantes associadas noutros clientes.

Para limitar os resultados a contas de anunciante diretamente no cliente especificado, defina este elemento como verdadeiro e, de outra forma, deixe-o vazio ou defina a propriedade como falso. O valor predefinido é falso.		 booleano

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 GetLinkedAccountsAndCustomersInfoResponse 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
AccountsInfo A lista de informações sobre contas de anunciantes que correspondem aos critérios do pedido.

Tenha em atenção que pode haver um atraso de até cinco minutos a partir do momento em que cria uma conta até que as informações da conta sejam incluídas na resposta.		 Matriz AccountInfo
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 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.

{
  "CustomerId": "LongValueHere",
  "OnlyParentAccounts": "ValueHere"
}

JSON de Resposta

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

{
  "AccountsInfo": [
    {
      "AccountLifeCycleStatus": "ValueHere",
      "Id": "LongValueHere",
      "Name": "ValueHere",
      "Number": "ValueHere",
      "PauseReason": "ValueHere"
    }
  ],
  "CustomersInfo": [
    {
      "Id": "LongValueHere",
      "Name": "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<GetLinkedAccountsAndCustomersInfoResponse> GetLinkedAccountsAndCustomersInfoAsync(
	long? customerId,
	bool onlyParentAccounts)
{
	var request = new GetLinkedAccountsAndCustomersInfoRequest
	{
		CustomerId = customerId,
		OnlyParentAccounts = onlyParentAccounts
	};

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

static GetLinkedAccountsAndCustomersInfoResponse getLinkedAccountsAndCustomersInfo(
	java.lang.Long customerId,
	boolean onlyParentAccounts) throws RemoteException, Exception
{
	GetLinkedAccountsAndCustomersInfoRequest request = new GetLinkedAccountsAndCustomersInfoRequest();

	request.setCustomerId(customerId);
	request.setOnlyParentAccounts(onlyParentAccounts);

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

static function GetLinkedAccountsAndCustomersInfo(
	$customerId,
	$onlyParentAccounts)
{

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

	$request = new GetLinkedAccountsAndCustomersInfoRequest();

	$request->CustomerId = $customerId;
	$request->OnlyParentAccounts = $onlyParentAccounts;

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

response=customermanagement_service.GetLinkedAccountsAndCustomersInfo(
	CustomerId=CustomerId,
	OnlyParentAccounts=OnlyParentAccounts)