Partilhar via

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

  • Artigo

Elimina uma conta.

Nota

Apenas um utilizador com credenciais de Super Administração pode eliminar contas. Para obter mais informações, veja o Guia técnico das Funções de Utilizador .

Uma vez que a operação de eliminação requer o carimbo de data/hora da operação de escrita da conta mais recente, primeiro tem de chamar a operação GetAccount . A operação GetAccount devolve os dados da conta, que inclui o carimbo de data/hora. A chamada de eliminação falhará se utilizar um carimbo de data/hora antigo, por exemplo, os dados da conta são atualizados pela sua aplicação ou outra aplicação depois de obter o carimbo de data/hora.

Depois de eliminar a conta, esta será pesquisável e apresentada como inativa na aplicação Web Microsoft Advertising. Pode ou não optar por apresentar contas inativas na sua aplicação.

Elementos do Pedido

O objeto DeleteAccountRequest 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
AccountId O identificador da conta a eliminar. Longo
Carimbo de data/hora O valor do carimbo de data/hora que a operação utiliza para reconciliar a atualização. Tem de chamar GetAccount para obter o valor do carimbo de data/hora. A operação de eliminação falha se o objeto de conta tiver um valor de carimbo de data/hora diferente daquele que passa. base64Binary

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 DeleteAccountResponse 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

Não existem elementos no corpo de resposta da operação.

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">DeleteAccount</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <DeleteAccountRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <AccountId>ValueHere</AccountId>
      <TimeStamp i:nil="false">ValueHere</TimeStamp>
    </DeleteAccountRequest>
  </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>
    <DeleteAccountResponse xmlns="https://bingads.microsoft.com/Customer/v13" />
  </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<DeleteAccountResponse> DeleteAccountAsync(
	long accountId,
	base64Binary timeStamp)
{
	var request = new DeleteAccountRequest
	{
		AccountId = accountId,
		TimeStamp = timeStamp
	};

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

static DeleteAccountResponse deleteAccount(
	java.lang.Long accountId,
	byte[] timeStamp) throws RemoteException, Exception
{
	DeleteAccountRequest request = new DeleteAccountRequest();

	request.setAccountId(accountId);
	request.setTimeStamp(timeStamp);

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

static function DeleteAccount(
	$accountId,
	$timeStamp)
{

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

	$request = new DeleteAccountRequest();

	$request->AccountId = $accountId;
	$request->TimeStamp = $timeStamp;

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

response=customermanagement_service.DeleteAccount(
	AccountId=AccountId,
	TimeStamp=TimeStamp)

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/Account

Elementos do Pedido

O objeto DeleteAccountRequest 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
AccountId O identificador da conta a eliminar. Longo
Carimbo de data/hora O valor do carimbo de data/hora que a operação utiliza para reconciliar a atualização. Tem de chamar GetAccount para obter o valor do carimbo de data/hora. A operação de eliminação falha se o objeto de conta tiver um valor de carimbo de data/hora diferente daquele que passa. base64Binary

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 DeleteAccountResponse 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

Não existem elementos no corpo de resposta da operação.

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.

{
  "AccountId": "LongValueHere",
  "TimeStamp": "ValueHere"
}

JSON de Resposta

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

{}

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<DeleteAccountResponse> DeleteAccountAsync(
	long accountId,
	base64Binary timeStamp)
{
	var request = new DeleteAccountRequest
	{
		AccountId = accountId,
		TimeStamp = timeStamp
	};

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

static DeleteAccountResponse deleteAccount(
	java.lang.Long accountId,
	byte[] timeStamp) throws RemoteException, Exception
{
	DeleteAccountRequest request = new DeleteAccountRequest();

	request.setAccountId(accountId);
	request.setTimeStamp(timeStamp);

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

static function DeleteAccount(
	$accountId,
	$timeStamp)
{

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

	$request = new DeleteAccountRequest();

	$request->AccountId = $accountId;
	$request->TimeStamp = $timeStamp;

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

response=customermanagement_service.DeleteAccount(
	AccountId=AccountId,
	TimeStamp=TimeStamp)