REST Resource: accounts.businessInfo

Ressource: BusinessInfo

Le message BusinessInfo contient des informations essentielles sur l'établissement d'un marchand.

Ce message contient des informations clés sur l'établissement, telles que l'adresse physique, les coordonnées du service client et les identifiants spécifiques à la région.

Représentation JSON 
{
  "name": string,
  "address": {
    object (PostalAddress)
  },
  "phone": {
    object (PhoneNumber)
  },
  "phoneVerificationState": enum (PhoneVerificationState),
  "customerService": {
    object (CustomerService)
  },
  "koreanBusinessRegistrationNumber": string
}
Champs
name

string

Identifiant. Nom de la ressource des informations sur l'établissement. Format: accounts/{account}/businessInfo
address

object (PostalAddress)

Facultatif. Adresse de l'établissement. Seuls les champs regionCode, addressLines, postalCode, administrativeArea et locality sont acceptés. Tous les autres champs sont ignorés.
phone

object (PhoneNumber)

Uniquement en sortie. Numéro de téléphone de l'établissement.
phoneVerificationState

enum (PhoneVerificationState)

Uniquement en sortie. État de la validation du numéro de téléphone de l'établissement.
customerService

object (CustomerService)

Facultatif. Le service client de l'entreprise.
koreanBusinessRegistrationNumber

string

Facultatif. Numéro d'enregistrement d'entreprise coréen à 10 chiffres, séparé par des tirets, au format: XXX-XX-XXXXX.

PostalAddress

Représente une adresse postale. (par exemple, pour les adresses de livraison ou de paiement) Les services postaux peuvent effectuer une livraison à cette adresse, boîte postale ou autre. Ce champ n'a pas vocation à modéliser des emplacements géographiques (routes, villes ou montagnes).

Généralement, une adresse est créée par l'utilisateur ou lors de l'importation de données existantes, en fonction du type de processus.

Conseils pour la saisie et la modification d'adresses : utilisez un widget d'adresse compatible internationalisation tel que https://github.com/google/libaddressinput. Les utilisateurs ne doivent pas voir les éléments d'interface utilisateur permettant de saisir ou de modifier les champs en dehors des pays dans lesquels ce champ est utilisé.

Pour en savoir plus sur l'utilisation de ce schéma, consultez https://support.google.com/business/answer/6397478.

Représentation JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Champs
revision

integer

Révision du schéma de PostalAddress. Il doit être défini sur 0, à savoir la dernière révision.

Toutes les nouvelles révisions doivent être rétrocompatibles avec les anciennes révisions.
regionCode

string

Obligatoire. Code pays/région CLDR de l'adresse. Il n'est jamais déduit, et il revient à l'utilisateur de s'assurer que la valeur est correcte. Pour en savoir plus, consultez les pages https://cldr.unicode.org/ et https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemple : "CH" pour la Suisse.
languageCode

string

Facultatif. Code de langue BCP-47 du contenu de cette adresse (s'il est connu). Il s'agit souvent de la langue d'UI du formulaire de saisie. Sinon, il doit correspondre à l'une des langues utilisées dans le pays/la région mentionnés dans l'adresse ou leurs équivalents translittérés. Ce champ peut modifier la mise en forme dans certains pays, mais cela ne risque pas de nuire à l'exactitude des données et n'affectera jamais aucune validation ni aucune opération ne concernant pas la mise en forme.

Si cette valeur est inconnue, vous devez l'omettre (plutôt que de spécifier une valeur par défaut éventuellement incorrecte).

Exemples : "zh-Hant", "ja", "ja-Latn" et "en".
postalCode

string

Facultatif. Code postal de l'adresse. Tous les pays n'utilisent pas ou n'exigent pas de codes postaux. Toutefois, s'ils sont en vigueur, cela peut entraîner une validation supplémentaire avec d'autres parties de l'adresse (par exemple, validation par État ou par code postal aux États-Unis).
sortingCode

string

Facultatif. Code de tri supplémentaire, spécifique à chaque pays. La plupart des régions ne s'en servent pas. Lorsqu'il est utilisé, la valeur est une chaîne telle que "CEDEX", éventuellement suivie d'un nombre (par exemple, "CEDEX 7") ou d'un nombre seul, représentant le "code de secteur" (Jamaïque), l'"indicateur de zone de livraison" (Malawi) ou l'"indicateur de bureau de poste" (par exemple, Côte d'Ivoire).
administrativeArea

string

Facultatif. Plus haute subdivision administrative utilisée pour les adresses postales d'un pays ou d'une région. Par exemple, il peut s'agir d'un État, d'une province, d'un oblast ou d'une préfecture. Plus précisément, pour l'Espagne, il s'agit de la province et non de la communauté autonome (par exemple, "Barcelone" et non "Catalogne"). De nombreux pays n'utilisent pas de région administrative dans leurs adresses postales. Par exemple, ce champ doit rester vide en Suisse.
locality

string

Facultatif. Fait généralement référence à la ville de l'adresse. Exemples : une "city" aux États-Unis, une "comune" en Italie, une "post town" au Royaume-Uni. Dans les régions du monde où les localités ne sont pas bien définies ou ne s'intègrent pas bien dans cette structure, laissez le champ de localité vide et utilisez addressLines.
sublocality

string

Facultatif. Sous-localité de l'adresse. Il peut s'agir, par exemple, de quartiers, d'arrondissements ou de districts.
addressLines[]

string

Lignes d'adresse non structurées décrivant les niveaux inférieurs d'une adresse.

Étant donné que les valeurs dans "addressLines" ne contiennent pas d'informations de type et peuvent parfois comprendre plusieurs valeurs dans un seul champ (par exemple, "Austin, TX"), il est important que l'ordre des lignes soit bien clair. L'ordre des lignes d'adresse doit correspondre à l'ordre suivi sur les enveloppes pour le pays/la région de l'adresse. Dans les pays où cet ordre peut varier (par exemple, au Japon), "address_language" est utilisé pour le rendre explicite (par exemple, "ja" pour un ordre décroissant et "ja-Latn" ou "en" pour un ordre croissant). De cette façon, la ligne la plus spécifique d'une adresse peut être sélectionnée en fonction de la langue.

La représentation structurelle minimale autorisée d'une adresse consiste en un code "regionCode" avec toutes les informations restantes placées dans les lignes "adresseLines". Il serait possible de mettre en forme une telle adresse de manière très approximative sans géocodage, mais aucun raisonnement sémantique ne pourrait être réalisé quant à l'un des composants d'adresse avant qu'il n'ait été au moins partiellement résolu.

La création d'une adresse contenant uniquement un code "regionCode" et des lignes "addressLines" suivi d'un géocodage est la méthode recommandée pour gérer les adresses complètement déstructurées (plutôt que de deviner quelles parties de l'adresse sont des localités ou des régions administratives).
recipients[]

string

Facultatif. Destinataire. Ce champ peut, dans certaines circonstances, contenir des informations multilignes. Par exemple, il peut comporter la ligne "chez".
organization

string

Facultatif. Nom de l'entreprise.

PhoneNumber

Objet représentant un numéro de téléphone, adapté en tant que format de fil d'API.

Cette représentation:

  • ne doit pas être utilisé pour le formatage d'un numéro de téléphone spécifique à une région, par exemple "+1 (650) 253-0000 ext. 123"

  • n'est pas conçu pour un stockage efficace ;

  • ne convient peut-être pas à la numérotation. Pour ce faire, utilisez des bibliothèques spécialisées (voir les références).

Pour effectuer une action utile avec ce nombre (par exemple, le mettre en forme pour différents cas d'utilisation), commencez par le convertir en objet i18n.phonenumbers.PhoneNumber.

Par exemple, en Java, vous pouvez utiliser la syntaxe suivante:

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

Référence(s): - https://github.com/google/libphonenumber

Représentation JSON 
{
  "extension": string,

  // Union field kind can be only one of the following:
  "e164Number": string,
  "shortCode": {
    object (ShortCode)
  }
  // End of list of possible types for union field kind.
}
Champs
extension

string

Numéro de l'extension du numéro de téléphone. L'extension n'est pas normalisée dans les recommandations de l'UIT, sauf qu'elle est définie comme une série de chiffres d'une longueur maximale de 40 chiffres. En plus des chiffres, d'autres caractères de numérotation tels que ',' (indiquant un temps d'attente) ou '#' peuvent être stockés ici.

Notez qu'aucune région n'utilise actuellement d'extensions avec des codes courts. Par conséquent, ce champ n'est normalement défini qu'avec un numéro E.164. Il est conservé séparément du numéro E.164 pour permettre l'extension des numéros abrégés à l'avenir.
Champ d'union kind. Obligatoire. Il peut s'agir d'un numéro standard ou d'un code court. De nouveaux champs pourraient être ajoutés à la valeur oneof ci-dessous à l'avenir. Par conséquent, les clients doivent ignorer les numéros de téléphone pour lesquels aucun des champs qu'ils ont codés n'est défini. kind ne peut être qu'un des éléments suivants :
e164Number

string

Le numéro de téléphone, représenté par un signe plus ("+") au début, suivi d'un numéro de téléphone utilisant un format ITU E.164 simplifié composé du code pays (1 à 3 chiffres) et du numéro de l'abonné, sans espaces ni mise en forme supplémentaires. Exemples: - Correct: "+15552220123" - Incorrect: "+1 (555) 222-01234 x123".

Le format E.164 de l'UIT limite ce dernier à 12 chiffres, mais en pratique, tous les pays ne le respectent pas. Nous assouplissons donc cette restriction ici. Les numéros nationaux uniquement ne sont pas autorisés.

Références: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
shortCode

object (ShortCode)

Un code court.

Référence(s): - https://en.wikipedia.org/wiki/Short_code

ShortCode

Objet représentant un code court, qui est un numéro de téléphone généralement beaucoup plus court que les numéros de téléphone standards. Il peut être utilisé pour envoyer des messages dans les systèmes MMS et SMS, ainsi que pour composer des numéros abrégés (par exemple, "Envoyez un message au 611 pour connaître le nombre de minutes restantes sur votre forfait.").

Les numéros abrégés sont limités à une région et ne sont pas accessibles à l'international. Par conséquent, un même numéro abrégé peut exister dans différentes régions, avec des conditions d'utilisation et des tarifs différents, même si ces régions partagent le même code pays (par exemple, les États-Unis et le Canada).

Représentation JSON 
{
  "regionCode": string,
  "number": string
}
Champs
regionCode

string

Obligatoire. Code de région BCP-47 de l'emplacement où les appels vers ce numéro abrégé peuvent être effectués, par exemple "US" et "BB".

Référence(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
number

string

Obligatoire. Les chiffres du numéro abrégé, sans signe plus (+) ni code pays. Exemple : "611".

PhoneVerificationState

État de la validation du numéro de téléphone.

Enums
PHONE_VERIFICATION_STATE_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
PHONE_VERIFICATION_STATE_VERIFIED Le téléphone est validé.
PHONE_VERIFICATION_STATE_UNVERIFIED Le téléphone n'est pas validé

CustomerService

Informations sur le service client

Représentation JSON 
{
  "uri": string,
  "email": string,
  "phone": {
    object (PhoneNumber)
  }
}
Champs
uri

string

Facultatif. URI du service client.
email

string

Facultatif. Adresse e-mail du service client.
phone

object (PhoneNumber)

Facultatif. Numéro de téléphone du service client.

Méthodes

getBusinessInfo

 Récupère les informations sur l'entreprise d'un compte.

updateBusinessInfo

 Met à jour les informations sur l'établissement d'un compte.