Partilhar via

ValidateAddress Service Operation – Gestão de Clientes

  • Artigo

Determina se o endereço submetido é ou não válido para contas do Microsoft Advertising.

Se o endereço for válido, pode utilizá-lo como a conta BusinessAddress.

Para a Austrália (AU), Canadá (AC) e The Estados Unidos (E.U.A.), a operação valida se pode ou não enviar algo para o endereço. Para todos os outros países ou regiões, a verificação de endereços básicos (AVS) está concluída.

Elementos do Pedido

O objeto ValidateAddressRequest 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
Endereço O endereço a validar. Address

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 ValidateAddressResponse 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
Endereço Original O endereço que foi submetido para validação.

O Endereço submetido é sempre transmitido para aqui na resposta, pelo que este elemento está sempre definido.		 Address
Estado Determina se o endereço submetido é ou não válido para contas do Microsoft Advertising e se estão ou não disponíveis sugestões de endereço através do elemento de resposta SuggestedAddresses .

Os valores de cadeia possíveis são AddressValidWithoutSuggestions, AddressValidWithSuggestions, AddressInvalidWithoutSuggestions e AddressInvalidWithSuggestions.		 cadeia
Endereços Sugeridos Um ou mais endereços sugeridos se o Estado for AddressValidWithSuggestions ou AddressInvalidWithSuggestions.

Este elemento será nulo se o Estado for AddressValidWithoutSuggestions ou AddressInvalidWithoutSuggestions.		 Matriz de endereços

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">ValidateAddress</Action>
    <AuthenticationToken i:nil="false">ValueHere</AuthenticationToken>
    <DeveloperToken i:nil="false">ValueHere</DeveloperToken>
  </s:Header>
  <s:Body>
    <ValidateAddressRequest xmlns="https://bingads.microsoft.com/Customer/v13">
      <Address xmlns:e137="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e137:City i:nil="false">ValueHere</e137:City>
        <e137:CountryCode i:nil="false">ValueHere</e137:CountryCode>
        <e137:Id i:nil="false">ValueHere</e137:Id>
        <e137:Line1 i:nil="false">ValueHere</e137:Line1>
        <e137:Line2 i:nil="false">ValueHere</e137:Line2>
        <e137:Line3 i:nil="false">ValueHere</e137:Line3>
        <e137:Line4 i:nil="false">ValueHere</e137:Line4>
        <e137:PostalCode i:nil="false">ValueHere</e137:PostalCode>
        <e137:StateOrProvince i:nil="false">ValueHere</e137:StateOrProvince>
        <e137:TimeStamp i:nil="false">ValueHere</e137:TimeStamp>
        <e137:BusinessName i:nil="false">ValueHere</e137:BusinessName>
      </Address>
    </ValidateAddressRequest>
  </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>
    <ValidateAddressResponse xmlns="https://bingads.microsoft.com/Customer/v13">
      <OriginalAddress xmlns:e138="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e138:City d4p1:nil="false">ValueHere</e138:City>
        <e138:CountryCode d4p1:nil="false">ValueHere</e138:CountryCode>
        <e138:Id d4p1:nil="false">ValueHere</e138:Id>
        <e138:Line1 d4p1:nil="false">ValueHere</e138:Line1>
        <e138:Line2 d4p1:nil="false">ValueHere</e138:Line2>
        <e138:Line3 d4p1:nil="false">ValueHere</e138:Line3>
        <e138:Line4 d4p1:nil="false">ValueHere</e138:Line4>
        <e138:PostalCode d4p1:nil="false">ValueHere</e138:PostalCode>
        <e138:StateOrProvince d4p1:nil="false">ValueHere</e138:StateOrProvince>
        <e138:TimeStamp d4p1:nil="false">ValueHere</e138:TimeStamp>
        <e138:BusinessName d4p1:nil="false">ValueHere</e138:BusinessName>
      </OriginalAddress>
      <Status d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</Status>
      <SuggestedAddresses xmlns:e139="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e139:Address>
          <e139:City d4p1:nil="false">ValueHere</e139:City>
          <e139:CountryCode d4p1:nil="false">ValueHere</e139:CountryCode>
          <e139:Id d4p1:nil="false">ValueHere</e139:Id>
          <e139:Line1 d4p1:nil="false">ValueHere</e139:Line1>
          <e139:Line2 d4p1:nil="false">ValueHere</e139:Line2>
          <e139:Line3 d4p1:nil="false">ValueHere</e139:Line3>
          <e139:Line4 d4p1:nil="false">ValueHere</e139:Line4>
          <e139:PostalCode d4p1:nil="false">ValueHere</e139:PostalCode>
          <e139:StateOrProvince d4p1:nil="false">ValueHere</e139:StateOrProvince>
          <e139:TimeStamp d4p1:nil="false">ValueHere</e139:TimeStamp>
          <e139:BusinessName d4p1:nil="false">ValueHere</e139:BusinessName>
        </e139:Address>
      </SuggestedAddresses>
    </ValidateAddressResponse>
  </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<ValidateAddressResponse> ValidateAddressAsync(
	Address address)
{
	var request = new ValidateAddressRequest
	{
		Address = address
	};

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

static ValidateAddressResponse validateAddress(
	Address address) throws RemoteException, Exception
{
	ValidateAddressRequest request = new ValidateAddressRequest();

	request.setAddress(address);

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

static function ValidateAddress(
	$address)
{

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

	$request = new ValidateAddressRequest();

	$request->Address = $address;

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

response=customermanagement_service.ValidateAddress(
	Address=Address)

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/Address/Validate

Elementos do Pedido

O objeto ValidateAddressRequest 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
Endereço O endereço a validar. Address

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 ValidateAddressResponse 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
Endereço Original O endereço que foi submetido para validação.

O Endereço submetido é sempre transmitido para aqui na resposta, pelo que este elemento está sempre definido.		 Address
Estado Determina se o endereço submetido é ou não válido para contas do Microsoft Advertising e se estão ou não disponíveis sugestões de endereço através do elemento de resposta SuggestedAddresses .

Os valores de cadeia possíveis são AddressValidWithoutSuggestions, AddressValidWithSuggestions, AddressInvalidWithoutSuggestions e AddressInvalidWithSuggestions.		 cadeia
Endereços Sugeridos Um ou mais endereços sugeridos se o Estado for AddressValidWithSuggestions ou AddressInvalidWithSuggestions.

Este elemento será nulo se o Estado for AddressValidWithoutSuggestions ou AddressInvalidWithoutSuggestions.		 Matriz de endereços

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.

{
  "Address": {
    "BusinessName": "ValueHere",
    "City": "ValueHere",
    "CountryCode": "ValueHere",
    "Id": "LongValueHere",
    "Line1": "ValueHere",
    "Line2": "ValueHere",
    "Line3": "ValueHere",
    "Line4": "ValueHere",
    "PostalCode": "ValueHere",
    "StateOrProvince": "ValueHere",
    "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.

{
  "OriginalAddress": {
    "BusinessName": "ValueHere",
    "City": "ValueHere",
    "CountryCode": "ValueHere",
    "Id": "LongValueHere",
    "Line1": "ValueHere",
    "Line2": "ValueHere",
    "Line3": "ValueHere",
    "Line4": "ValueHere",
    "PostalCode": "ValueHere",
    "StateOrProvince": "ValueHere",
    "TimeStamp": "ValueHere"
  },
  "Status": "ValueHere",
  "SuggestedAddresses": [
    {
      "BusinessName": "ValueHere",
      "City": "ValueHere",
      "CountryCode": "ValueHere",
      "Id": "LongValueHere",
      "Line1": "ValueHere",
      "Line2": "ValueHere",
      "Line3": "ValueHere",
      "Line4": "ValueHere",
      "PostalCode": "ValueHere",
      "StateOrProvince": "ValueHere",
      "TimeStamp": "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<ValidateAddressResponse> ValidateAddressAsync(
	Address address)
{
	var request = new ValidateAddressRequest
	{
		Address = address
	};

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

static ValidateAddressResponse validateAddress(
	Address address) throws RemoteException, Exception
{
	ValidateAddressRequest request = new ValidateAddressRequest();

	request.setAddress(address);

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

static function ValidateAddress(
	$address)
{

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

	$request = new ValidateAddressRequest();

	$request->Address = $address;

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

response=customermanagement_service.ValidateAddress(
	Address=Address)