Package google.mybusiness.accountmanagement.v1

Index

AccessControl

Ce service permet de gérer les utilisateurs ayant accès aux comptes et aux établissements.

AcceptInvitation

rpc AcceptInvitation(AcceptInvitationRequest) returns (Empty)

Accepte l'invitation spécifiée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
CreateAccountAdmin

rpc CreateAccountAdmin(CreateAccountAdminRequest) returns (Admin)

Invite l'utilisateur spécifié à devenir administrateur du compte spécifié. Il doit accepter l'invitation pour obtenir l'accès au compte. Consultez [AcceptInvitation] [google.mybusiness.accountmanagement.v1.AcceptInvitation] pour accepter une invitation par programmation.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
CreateLocationAdmin

rpc CreateLocationAdmin(CreateLocationAdminRequest) returns (Admin)

Invite l'utilisateur spécifié à devenir administrateur de l'établissement indiqué. Il doit accepter l'invitation pour pouvoir accéder à l'établissement. Reportez-vous à [AcceptInvitation] [google.mybusiness.accountmangement.v1.AcceptInvitation] pour accepter une invitation par programmation.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
DeclineInvitation

rpc DeclineInvitation(DeclineInvitationRequest) returns (Empty)

Refuse l'invitation spécifiée.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
DeleteAccountAdmin

rpc DeleteAccountAdmin(DeleteAccountAdminRequest) returns (Empty)

Supprime l'administrateur spécifié du compte indiqué.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
DeleteLocationAdmin

rpc DeleteLocationAdmin(DeleteLocationAdminRequest) returns (Empty)

Supprime l'administrateur spécifié en tant que responsable de l'établissement spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
ListAccountAdmins

rpc ListAccountAdmins(ListAccountAdminsRequest) returns (ListAccountAdminsResponse)

Liste les administrateurs du compte spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
ListInvitations

rpc ListInvitations(ListInvitationsRequest) returns (ListInvitationsResponse)

Liste les invitations en attente pour le compte spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
ListLocationAdmins

rpc ListLocationAdmins(ListLocationAdminsRequest) returns (ListLocationAdminsResponse)

Liste tous les administrateurs de l'établissement spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
TransferLocation

rpc TransferLocation(TransferLocationRequest) returns (Empty)

Déplace un établissement d'un compte appartenant à l'utilisateur vers un autre compte géré par le même utilisateur. L'utilisateur doit être propriétaire du compte auquel l'établissement est actuellement associé et être au moins administrateur du compte de destination.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
UpdateAccountAdmin

rpc UpdateAccountAdmin(UpdateAccountAdminRequest) returns (Admin)

Met à jour l'administrateur de l'administrateur de compte spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
UpdateLocationAdmin

rpc UpdateLocationAdmin(UpdateLocationAdminRequest) returns (Admin)

Met à jour l'administrateur pour l'établissement spécifié. Seul l'AdminRole de l'administrateur peut être mis à jour.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

Comptes

Cette API permet de gérer les comptes professionnels sur Google. Il définit le modèle de ressource suivant:

  • L'API dispose d'une collection de ressources "Account", nommée accounts/*.

  • Pour plus de commodité, vous pouvez utiliser le synonyme "moi" au lieu de l'identifiant du compte personnel de l'appelant authentifié. Exemples: GET /v1/accounts/me GET /v1/accounts/me/locations

CreateAccount

rpc CreateAccount(CreateAccountRequest) returns (Account)

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

  • Vous ne pouvez pas créer de comptes personnels ni d'organisations.
  • Impossible de créer des groupes d'utilisateurs avec un compte personnel comme propriétaire principal.
  • Vous ne pouvez pas créer de groupes d'établissements avec le propriétaire principal d'un compte personnel si celui-ci fait partie d'une organisation.
  • Des groupes de zones géographiques ne peuvent pas en être propriétaires.
Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Récupère le compte spécifié. Renvoie la valeur NOT_FOUND si le compte n'existe pas ou si l'appelant n'a pas les droits d'accès à celui-ci.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
ListAccounts

rpc ListAccounts(ListAccountsRequest) returns (ListAccountsResponse)

Répertorie tous les comptes de l'utilisateur authentifié. Cela inclut tous les comptes dont l'utilisateur est propriétaire ou dont il dispose des droits de gestion.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.
UpdateAccount

rpc UpdateAccount(UpdateAccountRequest) returns (Account)

Met à jour le compte professionnel spécifié. Les comptes personnels ne peuvent pas être mis à jour avec cette méthode.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/business.manage

Pour en savoir plus, consultez la présentation d'OAuth 2.0.

AcceptInvitationRequest

Message de requête pour AccessControl.AcceptInvitation.

Champs
name

string

Obligatoire. Nom de l'invitation acceptée. accounts/{account_id}/invitations/{invitation_id}

Compte

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

Champs
name

string

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

string

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

string

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

AccountType

Obligatoire. Contient le type de compte. Impossible de créer des comptes de type PERSONAL ou ORGANIZATION avec cette API.
role

AccountRole

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

VerificationState

Uniquement en sortie. S'ils sont validés, les futurs établissements créés sont automatiquement associés à Google Maps et disposent de pages Google+, sans modération.
vetted_state

VettedState

Uniquement en sortie. Indique si le compte est approuvé par Google. Un compte approuvé peut faire valider des établissements via la méthode VETTED_PARTNER.
account_number

string

Uniquement en sortie. Numéro de référence du compte, le cas échéant
permission_level

PermissionLevel

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

OrganizationInfo

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

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 de l'utilisateur 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.

AccountType

Indique de quel type de compte il s'agit: 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 permettant de répartir le personnel de l'organisation en groupes. Pour en savoir plus, consultez cet article du Centre d'aide.
ORGANIZATION Une organisation représentant une entreprise. Pour en savoir plus, consultez cet article du Centre d'aide.

OrganizationInfo

Informations supplémentaires stockées pour une organisation.

Champs
registered_domain

string

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

PostalAddress

Uniquement en sortie. Adresse postale du compte.
phone_number

string

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

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 au niveau du propriétaire.
MEMBER_LEVEL L'utilisateur dispose d'une autorisation au niveau du membre.

VerificationState

Indique l'état de validation du compte.

Enums
VERIFICATION_STATE_UNSPECIFIED Non spécifié.
VERIFIED Compte validé.
UNVERIFIED Compte non validé et dont la validation n'a pas été demandée.
VERIFICATION_REQUESTED Compte non validé, mais une validation a été demandée.

VettedState

Indique l'état d'examen d'un compte.

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

Administrateur

l'administrateur d'un compte ou d'un établissement.

Champs
name

string

Immuable. Nom de la ressource Pour les administrateurs de compte, voici le formulaire: accounts/{account_id}/admins/{admin_id}

Pour les administrateurs d'établissements, voici le formulaire: locations/{location_id}/admins/{admin_id}

Ce champ sera ignoré s'il est défini lors de la création de l'administrateur.
admin

string

Facultatif. Nom de l'administrateur. Lors de l'envoi de l'invitation initiale, il s'agit de l'adresse e-mail de l'invité. Lors des appels GET, l'adresse e-mail de l'utilisateur est renvoyée si l'invitation est toujours en attente. Sinon, il contient le prénom et le nom de l'utilisateur.

Ce champ ne doit être défini que lors de la création par l'administrateur.
account

string

Immuable. Nom de la ressource "Account" à laquelle cet administrateur fait référence. Utilisé lorsque vous appelez locations.admins.create pour inviter un LocationGroup en tant qu'administrateur.

Si ce champ et admin sont tous les deux définis dans les requêtes CREATE, ce champ est prioritaire, et l'adresse e-mail figurant dans admin sera ignorée.

Format : accounts/{account}.
role

AdminRole

Obligatoire. Spécifie le rôle que cet administrateur utilise pour le compte ou l'emplacement spécifié.
pending_invitation

bool

Uniquement en sortie. Indique si cet administrateur dispose d'une invitation en attente pour la ressource spécifiée.

AdminRole

Indique le niveau d'accès d'un administrateur. Pour en savoir plus, consultez cet article du Centre d'aide.

Enums
ADMIN_ROLE_UNSPECIFIED Non spécifié.
PRIMARY_OWNER L'administrateur dispose d'un accès de niveau propriétaire et est le propriétaire principal. ("Propriétaire principal" s'affiche dans l'interface utilisateur).
OWNER L'administrateur dispose d'un accès de niveau propriétaire. ("Propriétaire" dans l'interface utilisateur).
MANAGER L'administrateur dispose d'un accès de niveau administrateur.
SITE_MANAGER L'administrateur peut gérer les pages de réseaux sociaux (Google+). ("Responsable de site" dans l'interface utilisateur). Cette API ne permet pas de créer un administrateur de compte doté du rôle SITE_MANAGER.

CreateAccountAdminRequest

Message de requête pour AccessControl.CreateAccountAdmin.

Champs
parent

string

Obligatoire. Nom de ressource du compte pour lequel cet administrateur est créé. accounts/{account_id}.
admin

Admin

Obligatoire. Administrateur à créer. Le rôle ne peut pas être SITE_MANAGER

CreateAccountRequest

Message de requête pour Accounts.CreateAccount.

Champs
account

Account

Obligatoire. Informations sur le compte à créer. Les seuls champs autorisés sont "Compte" et "Type".

CreateLocationAdminRequest

Message de requête pour AccessControl.CreateLocationAdmin.

Champs
parent

string

Obligatoire. Nom de ressource de l'établissement pour lequel cet administrateur est créé. locations/{location_id}/admins.
admin

Admin

Obligatoire. Administrateur à créer.

DeclineInvitationRequest

Message de requête pour AccessControl.RefuséInvitation.

Champs
name

string

Obligatoire. Nom de l'invitation de compte qui a été refusée. accounts/{account_id}/invitations/{invitation_id}

DeleteAccountAdminRequest

Message de requête pour AccessControl.DeleteAccountAdmin.

Champs
name

string

Obligatoire. Nom de ressource de l'administrateur à supprimer du compte. accounts/{account_id}/admins/{admin_id}.

DeleteLocationAdminRequest

Message de requête pour AccessControl.DeleteLocationAdmin.

Champs
name

string

Obligatoire. Nom de ressource de l'administrateur à supprimer de l'établissement.

GetAccountRequest

Message de requête pour Accounts.GetAccount.

Champs
name

string

Obligatoire. Nom du compte à récupérer.

Invitation

Représente une invitation en attente.

Champs
name

string

Obligatoire. Nom de ressource de l'invitation. accounts/{account_id}/invitations/{invitation_id}.
role

AdminRole

Uniquement en sortie. Rôle invité pour le compte.
target_type

TargetType

Uniquement en sortie. Spécifie les types de cibles devant apparaître dans la réponse.
Champ d'union target. Indique la cible pour laquelle cette invitation est destinée. target ne peut être qu'un des éléments suivants :
target_account

Account

Compte faiblement renseigné auquel cette invitation est destinée.
target_location

TargetLocation

Zone géographique cible pour laquelle cette invitation est destinée.

TargetLocation

Représente un emplacement cible pour une invitation en attente.

Champs
location_name

string

Nom de l'établissement auquel l'utilisateur est invité.
address

string

Adresse de l'établissement auquel l'utilisateur est invité.

TargetType

Type de cible auquel une invitation est destinée.

Enums
TARGET_TYPE_UNSPECIFIED Défini lorsque le type de cible n'est pas spécifié.
ACCOUNTS_ONLY Répertorier les invitations uniquement pour les cibles de type Account.
LOCATIONS_ONLY Répertorier les invitations uniquement pour les cibles de type Lieu

ListAccountAdminsRequest

Message de requête pour AccessControl.ListAccountAdmins.

Champs
parent

string

Obligatoire. Nom du compte à partir duquel récupérer la liste des administrateurs. accounts/{account_id}/admins.

ListAccountAdminsResponse

Message de réponse pour AccessControl.ListAccountAdmins.

Champs
account_admins[]

Admin

Collection d'instances d'administration.

ListAccountsRequest

Message de requête pour Accounts.ListAccounts.

Champs
parent_account

string

Facultatif. Nom de ressource du compte pour lequel la liste des comptes directement accessibles doit être récupérée. Cela n'a de sens que pour les organisations et les groupes d'utilisateurs. Si ce champ est vide, renvoie ListAccounts pour l'utilisateur authentifié. accounts/{account_id}.
page_size

int32

Facultatif. Nombre de comptes à récupérer par page. La valeur par défaut et la valeur maximale sont 20.
page_token

string

Facultatif. Si elle est spécifiée, la page de comptes suivante est récupérée. Le pageToken est renvoyé lorsqu'un appel à accounts.list renvoie plus de résultats que la taille de page demandée ne peut en tenir.
filter

string

Facultatif. Filtre contraignant les comptes à afficher. La réponse n'inclut que les entrées qui correspondent au filtre. Si filter est vide, aucune contrainte n'est appliquée et tous les comptes (paginés) sont récupérés pour le compte demandé.

Par exemple, une requête avec le filtre type=USER_GROUP ne renverra que des groupes d'utilisateurs.

Le champ type est le seul filtre accepté.

ListAccountsResponse

Message de réponse pour Accounts.ListAccounts.

Champs
accounts[]

Account

Ensemble de comptes auxquels l'utilisateur a accès. Le compte personnel de l'utilisateur effectuant la requête sera toujours le premier élément du résultat, sauf s'il est filtré.
next_page_token

string

Si le nombre de comptes dépasse la taille de page demandée, ce champ est renseigné avec un jeton permettant d'extraire la page de comptes suivante lors d'un prochain appel à accounts.list. S'il n'y a plus de comptes, ce champ n'est pas présent dans la réponse.

ListInvitationsRequest

Message de requête pour AccessControl.ListInvitations.

Champs
parent

string

Obligatoire. Nom du compte à partir duquel la liste des invitations est récupérée. accounts/{account_id}/invitations
filter

string

Facultatif. Vous pouvez filtrer la réponse à l'aide du champ Invitation.target_type.

ListInvitationsResponse

Message de réponse pour AccessControl.ListInvitations.

Champs
invitations[]

Invitation

Ensemble d'invitations en attente pour le compte. Le nombre d'invitations indiquées ici ne peut pas dépasser 1 000.

ListLocationAdminsRequest

Message de requête pour AccessControl.ListLocationAdmins.

Champs
parent

string

Obligatoire. Nom de l'établissement dont les administrateurs doivent être listés. locations/{location_id}/admins.

ListLocationAdminsResponse

Message de réponse pour AccessControl.ListLocationAdmins.

Champs
admins[]

Admin

Ensemble d'administrateurs.

TransferLocationRequest

Message de requête pour AccessControl.TransferLocation.

Champs
name

string

Obligatoire. Nom de l'établissement à transférer. locations/{location_id}.
destination_account

string

Obligatoire. Nom de la ressource du compte vers laquelle transférer l'établissement (par exemple, "accounts/{account}").

UpdateAccountAdminRequest

Message de requête pour AccessControl.UpdateAccountAdmin.

Champs
account_admin

Admin

Obligatoire. Version mise à jour de la page Administration.
update_mask

FieldMask

Obligatoire. Champs spécifiques à mettre à jour. Le seul champ modifiable est le rôle.

UpdateAccountRequest

Message de requête pour Accounts.UpdateAccount.

Champs
account

Account

Obligatoire. Compte mis à jour.
update_mask

FieldMask

Obligatoire. Champs spécifiques à mettre à jour. Le seul champ modifiable est accountName.
validate_only

bool

Facultatif. Si la valeur est "true", la requête est validée sans mettre à jour le compte.

UpdateLocationAdminRequest

Message de requête pour AccessControl.UpdateLocationAdmin.

Champs
location_admin

Admin

Obligatoire. Version mise à jour de la page Administration.
update_mask

FieldMask

Obligatoire. Champs spécifiques à mettre à jour. Le seul champ modifiable est le rôle.