REST Resource: accounts

Ressource: Compte

Un compte est un conteneur pour votre établissement. Si vous êtes le seul utilisateur à gérer les établissements de votre établissement, vous pouvez utiliser votre compte Google personnel. Pour partager la gestion d'établissements avec plusieurs utilisateurs, créez un compte professionnel.

Représentation JSON 
{
  "name": string,
  "accountName": string,
  "primaryOwner": string,
  "type": enum (AccountType),
  "role": enum (AccountRole),
  "verificationState": enum (VerificationState),
  "vettedState": enum (VettedState),
  "accountNumber": string,
  "permissionLevel": enum (PermissionLevel),
  "organizationInfo": {
    object (OrganizationInfo)
  }
}
Champs
name

string

Immuable. Nom de la ressource, au format accounts/{account_id}.
accountName

string

Obligatoire. Nom du compte. Pour un compte de type PERSONAL, il s'agit du prénom et du nom du compte utilisateur.
primaryOwner

string

Obligatoire. Uniquement en entrée. Nom de ressource du compte qui sera le propriétaire principal du compte en cours de création. Il doit se présenter sous la forme accounts/{account_id}.
type

enum (AccountType)

Obligatoire. Contient le type de compte. Impossible de créer des comptes de type PERSONAL et ORGANIZATION à l'aide de cette API.
role

enum (AccountRole)

Uniquement en sortie. Spécifie l'objet AccountRole de ce compte.
verificationState

enum (VerificationState)

Uniquement en sortie. S'ils sont validés, les futurs établissements créés sont automatiquement associés à Google Maps et des pages Google+ ont été créées, sans nécessiter de modération.
vettedState

enum (VettedState)

Uniquement en sortie. Indique si le compte a été approuvé par Google. Un compte approuvé permet de faire valider des établissements via la méthode VETTED_PARTNER.
accountNumber

string

Uniquement en sortie. Numéro de référence du compte, s'il est fourni
permissionLevel

enum (PermissionLevel)

Uniquement en sortie. Indique le niveau d'autorisation de l'utilisateur pour ce compte.
organizationInfo

object (OrganizationInfo)

Uniquement en sortie. Informations supplémentaires sur une organisation. Ce champ n'est renseigné que pour un compte d'organisation.

AccountType

Indique le type de compte: compte personnel/utilisateur ou compte professionnel.

Enums
ACCOUNT_TYPE_UNSPECIFIED Non spécifié.
PERSONAL Un compte utilisateur final.
LOCATION_GROUP Groupe d'établissements. Pour en savoir plus, consultez cet article du Centre d'aide
USER_GROUP Un groupe d'utilisateurs pour répartir le personnel de l'organisation dans des groupes Pour en savoir plus, consultez cet article du Centre d'aide
ORGANIZATION Organisation représentant une entreprise. Pour en savoir plus, consultez cet article du Centre d'aide

AccountRole

Indique le niveau d'accès de l'utilisateur authentifié pour ce compte. Pour en savoir plus, consultez cet article du Centre d'aide

Enums
ACCOUNT_ROLE_UNSPECIFIED Non spécifié.
PRIMARY_OWNER L'utilisateur est le propriétaire principal de ce compte.
OWNER Propriétaire du compte.
MANAGER L'utilisateur peut gérer ce compte.
SITE_MANAGER L'utilisateur peut gérer un ensemble limité de fonctionnalités pour le compte.

VerificationState

Indique l'état de validation du compte.

Enums
VERIFICATION_STATE_UNSPECIFIED Non spécifié.
VERIFIED Compte validé.
UNVERIFIED Compte non validé pour lequel la validation n'a pas été demandée.
VERIFICATION_REQUESTED Compte non validé alors qu'une validation a été demandée.

VettedState

Indique l'état de validation d'un compte.

Enums
VETTED_STATE_UNSPECIFIED Non spécifié
NOT_VETTED Le compte n'a pas été validé par Google.
VETTED Le compte a été validé par Google et présente un état valide. Un compte est automatiquement approuvé s'il a un accès direct à un compte de groupe validé.
INVALID Le compte a été approuvé, mais n'est pas valide. Le compte se comportera comme un compte non validé.

PermissionLevel

Indique le niveau d'accès de l'utilisateur authentifié pour ce compte.

Enums
PERMISSION_LEVEL_UNSPECIFIED Non spécifié.
OWNER_LEVEL L'utilisateur dispose d'une autorisation de niveau propriétaire.
MEMBER_LEVEL L'utilisateur dispose d'une autorisation au niveau du membre.

OrganizationInfo

Informations supplémentaires stockées pour une organisation.

Représentation JSON 
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
Champs
registeredDomain

string

Uniquement en sortie. Domaine enregistré pour le compte.
address

object (PostalAddress)

Uniquement en sortie. Adresse postale du compte.
phoneNumber

string

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

PostalAddress

Représente une adresse postale, telles que des 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 via une saisie utilisateur ou lors de l'importation de données existantes, en fonction du type de processus.

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

Pour en savoir plus sur l'utilisation de ce schéma, consultez la page 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, mais lorsqu'ils s'en servent, ils peuvent déclencher une validation supplémentaire avec d'autres parties de l'adresse (par exemple, validation par État/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é, sa valeur comprend une chaîne de type CEDEX, éventuellement suivie d'un numéro (par exemple CEDEX 7), ou tout simplement un nombre représentant un "code de secteur" (Jamaïque), un "indicateur de zone de livraison" (Malawi) ou un "indicateur postal" (Côte d'Ivoire, par exemple).
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.

Méthodes

create

 Crée un compte avec le nom et le type spécifiés sous le compte parent donné.

get

 Récupère le compte spécifié.

list

 Liste tous les comptes pour l'utilisateur authentifié.

patch

 Met à jour le compte professionnel spécifié.