Partager via

Opération du service ValidateAddress - Gestion des clients

  • Article

Détermine si l’adresse envoyée est valide ou non pour les comptes Microsoft Advertising.

Si l’adresse est valide, vous pouvez l’utiliser comme compte BusinessAddress.

Pour l’Australie (AU), le Canada (CA) et le États-Unis (États-Unis), l’opération vérifie si vous pouvez ou non expédier quelque chose à l’adresse. Pour tous les autres pays ou régions, la vérification d’adresse de base (AVS) est effectuée.

Éléments de demande

L’objet ValidateAddressRequest définit les éléments body et header de la demande d’opération de service. Les éléments doivent être dans le même ordre que celui indiqué dans la requête SOAP.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément Description Type de données
Address Adresse à valider. Adresse

Éléments d’en-tête de requête

Élément Description Type de données
AuthenticationToken Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising.

Pour plus d’informations, consultez Authentification avec OAuth.		 chaîne
DeveloperToken Jeton de développeur utilisé pour accéder à l’API Bing Ads.

Pour plus d’informations, consultez Obtenir un jeton de développeur.		 chaîne
Mot de passe Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. chaîne
UserName Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. chaîne

Éléments Response

L’objet ValidateAddressResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans la réponse SOAP.

Response Body, éléments

Élément Description Type de données
OriginalAddress Adresse qui a été soumise pour validation.

L’adresse envoyée étant toujours renvoyée ici dans la réponse, cet élément est toujours défini.		 Adresse
Statut Détermine si l’adresse envoyée est valide pour les comptes Microsoft Advertising et si des suggestions d’adresse sont disponibles ou non via l’élément de réponse SuggestedAddresses .

Les valeurs de chaîne possibles sont AddressValidWithoutSuggestions, AddressValidWithSuggestions, AddressInvalidWithoutSuggestions et AddressInvalidWithSuggestions.		 chaîne
SuggestedAddresses Une ou plusieurs adresses suggérées si l’état est AddressValidWithSuggestions ou AddressInvalidWithSuggestions.

Cet élément est nul si l’état est AddressValidWithoutSuggestions ou AddressInvalidWithoutSuggestions.		 Tableau d’adresses

Éléments d’en-tête de réponse

Élément Description Type de données
TrackingId Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. chaîne

Requête SOAP

Ce modèle a été généré par un outil pour afficher l’ordre des éléments body et header pour la requête SOAP. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

<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 réponse

Ce modèle a été généré par un outil pour afficher l’ordre des éléments de corps et d’en-tête pour la réponse 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>

Syntaxe du code

L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

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)

Configuration requise

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

URL de la demande

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

Éléments de demande

L’objet ValidateAddressRequest définit les éléments body et header de la demande d’opération de service.

Remarque

Sauf indication contraire ci-dessous, tous les éléments de requête sont requis.

Éléments du corps de la requête

Élément Description Type de données
Address Adresse à valider. Adresse

Éléments d’en-tête de requête

Élément Description Type de données
Autorisation Jeton d’accès OAuth qui représente les informations d’identification d’un utilisateur disposant d’autorisations sur les comptes Microsoft Advertising. Vérifiez que le jeton est précédé de « Porteur », ce qui est nécessaire pour une authentification appropriée.

Pour plus d’informations, consultez Authentification avec OAuth.		 chaîne
DeveloperToken Jeton de développeur utilisé pour accéder à l’API Bing Ads.

Pour plus d’informations, consultez Obtenir un jeton de développeur.		 chaîne
Mot de passe Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. chaîne
UserName Cet élément est réservé à un usage interne et sera supprimé d’une version ultérieure de l’API. Vous devez utiliser l’élément AuthenticationToken pour définir les informations d’identification de l’utilisateur. chaîne

Éléments Response

L’objet ValidateAddressResponse définit les éléments body et header de la réponse de l’opération de service. Les éléments sont retournés dans le même ordre que celui indiqué dans le json de réponse.

Response Body, éléments

Élément Description Type de données
OriginalAddress Adresse qui a été soumise pour validation.

L’adresse envoyée étant toujours renvoyée ici dans la réponse, cet élément est toujours défini.		 Adresse
Statut Détermine si l’adresse envoyée est valide pour les comptes Microsoft Advertising et si des suggestions d’adresse sont disponibles ou non via l’élément de réponse SuggestedAddresses .

Les valeurs de chaîne possibles sont AddressValidWithoutSuggestions, AddressValidWithSuggestions, AddressInvalidWithoutSuggestions et AddressInvalidWithSuggestions.		 chaîne
SuggestedAddresses Une ou plusieurs adresses suggérées si l’état est AddressValidWithSuggestions ou AddressInvalidWithSuggestions.

Cet élément est nul si l’état est AddressValidWithoutSuggestions ou AddressInvalidWithoutSuggestions.		 Tableau d’adresses

Éléments d’en-tête de réponse

Élément Description Type de données
TrackingId Identificateur de l’entrée de journal qui contient les détails de l’appel d’API. chaîne

Requête JSON

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la requête JSON. Pour connaître les types pris en charge que vous pouvez utiliser avec cette opération de service, consultez la référence Éléments du corps de la demande ci-dessus.

{
  "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 réponse

Ce modèle a été généré par un outil pour afficher le corps et les éléments d’en-tête de la réponse 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"
    }
  ]
}

Syntaxe du code

Pour appeler l’API REST via des kits SDK, vous devez mettre à niveau le KIT de développement logiciel (SDK) vers une certaine version et configurer les paramètres système. L’exemple de syntaxe peut être utilisé avec les Kits de développement logiciel (SDK) Bing Ads. Pour plus d’exemples, consultez Exemples de code de l’API Bing Ads .

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)