Compartir a través de

Operación de servicio ValidateAddress: Administración de clientes

  • Artículo

Determina si la dirección enviada es válida para las cuentas de Microsoft Advertising.

Si la dirección es válida, puede usarla como la cuenta BusinessAddress.

Para Australia (AU), Canadá (CA) y The Estados Unidos (EE. UU.), la operación valida si se puede enviar o no algo a la dirección. Para todos los demás países o regiones, se completa la verificación básica de direcciones (AVS).

Elementos Request

El objeto ValidateAddressRequest define los elementos body y header de la solicitud de operación de servicio. Los elementos deben estar en el mismo orden que se muestra en la solicitud SOAP.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
Dirección Dirección que se va a validar. Dirección

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
AuthenticationToken Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising.

Para obtener más información, consulte Autenticación con OAuth.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto ValidateAddressResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en soap de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
OriginalAddress Dirección que se envió para la validación.

La dirección enviada siempre se pasa aquí en la respuesta, por lo que este elemento siempre se establece.		 Dirección
Estado Determina si la dirección enviada es válida o no para las cuentas de Microsoft Advertising y si hay sugerencias de dirección disponibles a través del elemento de respuesta SuggestedAddresses .

Los valores de cadena posibles son AddressValidWithoutSuggestions, AddressValidWithSuggestions, AddressInvalidWithoutSuggestions y AddressInvalidWithSuggestions.		 string
SuggestedAddresses Una o varias direcciones sugeridas si el estado es AddressValidWithSuggestions o AddressInvalidWithSuggestions.

Este elemento será nulo si status es AddressValidWithoutSuggestions o AddressInvalidWithoutSuggestions.		 Matriz de direcciones

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de SOAP

Esta plantilla se generó mediante una herramienta para mostrar el orden del cuerpo y los elementos de encabezado de la solicitud SOAP. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

<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:e593="https://bingads.microsoft.com/Customer/v13/Entities" i:nil="false">
        <e593:City i:nil="false">ValueHere</e593:City>
        <e593:CountryCode i:nil="false">ValueHere</e593:CountryCode>
        <e593:Id i:nil="false">ValueHere</e593:Id>
        <e593:Line1 i:nil="false">ValueHere</e593:Line1>
        <e593:Line2 i:nil="false">ValueHere</e593:Line2>
        <e593:Line3 i:nil="false">ValueHere</e593:Line3>
        <e593:Line4 i:nil="false">ValueHere</e593:Line4>
        <e593:PostalCode i:nil="false">ValueHere</e593:PostalCode>
        <e593:StateOrProvince i:nil="false">ValueHere</e593:StateOrProvince>
        <e593:TimeStamp i:nil="false">ValueHere</e593:TimeStamp>
        <e593:BusinessName i:nil="false">ValueHere</e593:BusinessName>
      </Address>
    </ValidateAddressRequest>
  </s:Body>
</s:Envelope>

SOAP de respuesta

Esta plantilla se generó mediante una herramienta para mostrar el orden de los elementos body y header para la respuesta 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:e594="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e594:City d4p1:nil="false">ValueHere</e594:City>
        <e594:CountryCode d4p1:nil="false">ValueHere</e594:CountryCode>
        <e594:Id d4p1:nil="false">ValueHere</e594:Id>
        <e594:Line1 d4p1:nil="false">ValueHere</e594:Line1>
        <e594:Line2 d4p1:nil="false">ValueHere</e594:Line2>
        <e594:Line3 d4p1:nil="false">ValueHere</e594:Line3>
        <e594:Line4 d4p1:nil="false">ValueHere</e594:Line4>
        <e594:PostalCode d4p1:nil="false">ValueHere</e594:PostalCode>
        <e594:StateOrProvince d4p1:nil="false">ValueHere</e594:StateOrProvince>
        <e594:TimeStamp d4p1:nil="false">ValueHere</e594:TimeStamp>
        <e594:BusinessName d4p1:nil="false">ValueHere</e594:BusinessName>
      </OriginalAddress>
      <Status d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">ValueHere</Status>
      <SuggestedAddresses xmlns:e595="https://bingads.microsoft.com/Customer/v13/Entities" d4p1:nil="false" xmlns:d4p1="http://www.w3.org/2001/XMLSchema-instance">
        <e595:Address>
          <e595:City d4p1:nil="false">ValueHere</e595:City>
          <e595:CountryCode d4p1:nil="false">ValueHere</e595:CountryCode>
          <e595:Id d4p1:nil="false">ValueHere</e595:Id>
          <e595:Line1 d4p1:nil="false">ValueHere</e595:Line1>
          <e595:Line2 d4p1:nil="false">ValueHere</e595:Line2>
          <e595:Line3 d4p1:nil="false">ValueHere</e595:Line3>
          <e595:Line4 d4p1:nil="false">ValueHere</e595:Line4>
          <e595:PostalCode d4p1:nil="false">ValueHere</e595:PostalCode>
          <e595:StateOrProvince d4p1:nil="false">ValueHere</e595:StateOrProvince>
          <e595:TimeStamp d4p1:nil="false">ValueHere</e595:TimeStamp>
          <e595:BusinessName d4p1:nil="false">ValueHere</e595:BusinessName>
        </e595:Address>
      </SuggestedAddresses>
    </ValidateAddressResponse>
  </s:Body>
</s:Envelope>

Sintaxis de código

La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

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

Servicio: CustomerManagementService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13

Dirección URL de solicitud

https://clientcenter.api.bingads.microsoft.com/CustomerManagement/v13/Address/Validate

Elementos Request

El objeto ValidateAddressRequest define los elementos body y header de la solicitud de operación de servicio.

Nota:

A menos que se indique lo contrario a continuación, se requieren todos los elementos de solicitud.

Elementos del cuerpo de la solicitud

Elemento Descripción Tipo de datos
Dirección Dirección que se va a validar. Dirección

Elementos de encabezado de solicitud

Elemento Descripción Tipo de datos
Autorización Token de acceso de OAuth que representa las credenciales de un usuario que tiene permisos para cuentas de Microsoft Advertising. Asegúrese de que el token tiene el prefijo "Portador", esto es necesario para la autenticación adecuada.

Para obtener más información, consulte Autenticación con OAuth.		 string
DeveloperToken Token de desarrollador que se usa para acceder a Bing Ads API.

Para obtener más información, consulte Obtención de un token de desarrollador.		 string
Password Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string
UserName Este elemento está reservado para uso interno y se quitará de una versión futura de la API. Debe usar el elemento AuthenticationToken para establecer las credenciales de usuario. string

Elementos de respuesta

El objeto ValidateAddressResponse define los elementos body y header de la respuesta de la operación de servicio. Los elementos se devuelven en el mismo orden que se muestra en el JSON de respuesta.

Elementos del cuerpo de la respuesta

Elemento Descripción Tipo de datos
OriginalAddress Dirección que se envió para la validación.

La dirección enviada siempre se pasa aquí en la respuesta, por lo que este elemento siempre se establece.		 Dirección
Estado Determina si la dirección enviada es válida o no para las cuentas de Microsoft Advertising y si hay sugerencias de dirección disponibles a través del elemento de respuesta SuggestedAddresses .

Los valores de cadena posibles son AddressValidWithoutSuggestions, AddressValidWithSuggestions, AddressInvalidWithoutSuggestions y AddressInvalidWithSuggestions.		 string
SuggestedAddresses Una o varias direcciones sugeridas si el estado es AddressValidWithSuggestions o AddressInvalidWithSuggestions.

Este elemento será nulo si status es AddressValidWithoutSuggestions o AddressInvalidWithoutSuggestions.		 Matriz de direcciones

Elementos de encabezado de respuesta

Elemento Descripción Tipo de datos
Seguimiento del Id. Identificador de la entrada de registro que contiene los detalles de la llamada API. string

Solicitud de JSON

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la solicitud JSON. Para ver los tipos admitidos que puede usar con esta operación de servicio, consulte la referencia de elementos de cuerpo de solicitud anterior.

{
  "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 respuesta

Esta plantilla se generó mediante una herramienta para mostrar los elementos body y header de la respuesta 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"
    }
  ]
}

Sintaxis de código

Para llamar a la API REST a través de SDK, debe actualizar el SDK a una versión determinada y configurar los parámetros del sistema. La sintaxis de ejemplo se puede usar con los SDK de Bing Ads. Consulte Ejemplos de código de API de Bing Ads para obtener más ejemplos.

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)