Package google.cloud.gsuiteaddons.v1

Index

GSuiteAddOns

Service permettant de gérer les déploiements de modules complémentaires Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Crée un déploiement avec le nom et la configuration spécifiés.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le Guide relatif aux autorisations.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Supprime le déploiement portant le nom indiqué.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le guide d'autorisation.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Récupère les informations d'autorisation pour les déploiements d'un projet donné.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le guide d'autorisation.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Récupère le déploiement portant le nom spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le guide d'autorisation.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Récupère l'état d'installation d'un déploiement test.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le guide d'autorisation.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Installe un déploiement dans votre compte à des fins de test. Pour en savoir plus, consultez Tester votre module complémentaire.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le guide d'autorisation.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Répertorie tous les déploiements d'un projet particulier.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le guide d'autorisation.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Crée ou remplace un déploiement portant le nom spécifié.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le Guide relatif aux autorisations.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Désinstalle une déploiement de test du compte de l'utilisateur. Pour en savoir plus, consultez Tester votre module complémentaire.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour en savoir plus, consultez le Guide relatif aux autorisations.

Modules complémentaires

Une configuration de module complémentaire Google Workspace

Champs
common

CommonAddOnManifest

Configuration commune à tous les modules complémentaires Google Workspace.
gmail

GmailAddOnManifest

Configuration du module complémentaire Gmail.
drive

DriveAddOnManifest

Configuration du module complémentaire Drive.
calendar

CalendarAddOnManifest

Configuration du module complémentaire Agenda.
docs

DocsAddOnManifest

Configuration du module complémentaire Docs.
sheets

SheetsAddOnManifest

Configuration du module complémentaire Sheets.
slides

SlidesAddOnManifest

Configuration du module complémentaire Slides.
httpOptions

HttpOptions

Options d'envoi de requêtes aux points de terminaison HTTP des modules complémentaires

Autorisation

Informations d'autorisation utilisées lors de l'appel des points de terminaison de déploiement.

Champs
name

string

Nom complet canonique de cette ressource. Exemple : projects/123/authorization
serviceAccountEmail

string

Adresse e-mail du compte de service utilisé pour authentifier les requêtes adressées aux points de terminaison de rappel du module complémentaire.
oauthClientId

string

ID client OAuth utilisé pour obtenir des jetons d'accès OAuth pour un utilisateur au nom du module complémentaire.

CreateDeploymentRequest

Message de requête pour créer un déploiement.

Champs
parent

string

Obligatoire. Nom du projet dans lequel créer le déploiement.

Exemple : projects/my_project

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • gsuiteaddons.deployments.create
deploymentId

string

Obligatoire. ID à utiliser pour ce déploiement. Le nom complet de la ressource créée sera projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

Obligatoire. Déploiement à créer (le nom "deployment.name" ne peut pas être défini).

DeleteDeploymentRequest

Message de requête pour supprimer un déploiement.

Champs
name

string

Obligatoire. Nom complet de la ressource du déploiement à supprimer.

Exemple : projects/my_project/deployments/my_deployment

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gsuiteaddons.deployments.delete
etag

string

Etag du déploiement à supprimer. Si cet argument est fourni, il doit correspondre à l'etag du serveur.

Déploiement

Un déploiement de module complémentaire Google Workspace

Champs
name

string

Nom de la ressource de déploiement. Exemple : projects/123/deployments/my_deployment
oauthScopes[]

string

Liste des habilitations Google OAuth pour lesquelles il faut demander l'autorisation de l'utilisateur final avant d'exécuter un point de terminaison du module complémentaire.
addOns

AddOns

Configuration du module complémentaire Google Workspace.
etag

string

Cette valeur est calculée par le serveur en fonction de la version du déploiement dans l'espace de stockage. Elle peut être envoyée lors des requêtes de mise à jour et de suppression pour s'assurer que le client dispose d'une valeur à jour avant de continuer.

GetAuthorizationRequest

Message de requête pour obtenir les informations d'autorisation du module complémentaire Google Workspace.

Champs
name

string

Obligatoire. Nom du projet pour lequel obtenir les informations d'autorisation du module complémentaire Google Workspace.

Exemple : projects/my_project/authorization

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

Message de requête permettant d'obtenir un déploiement.

Champs
name

string

Obligatoire. Nom complet de la ressource du déploiement à obtenir.

Exemple : projects/my_project/deployments/my_deployment

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Message de requête permettant d'obtenir l'état d'installation d'un déploiement test.

Champs
name

string

Obligatoire. Nom complet de la ressource du déploiement.

Exemple : projects/my_project/deployments/my_deployment/installStatus

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

Message de requête pour installer un déploiement à des fins de test.

Champs
name

string

Obligatoire. Nom complet de la ressource du déploiement à installer.

Exemple : projects/my_project/deployments/my_deployment

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gsuiteaddons.deployments.install

InstallStatus

État d'installation d'un déploiement test.

Champs
name

string

Nom complet de la ressource canonique correspondant à l'état d'installation du déploiement.

Exemple : projects/123/deployments/my_deployment/installStatus
installed

BoolValue

"True" si le déploiement est installé pour l'utilisateur.

ListDeploymentsRequest

Message de requête permettant de répertorier les déploiements d'un projet.

Champs
parent

string

Obligatoire. Nom du projet dans lequel créer le déploiement.

Exemple : projects/my_project

L'autorisation IAM suivante est requise pour la ressource parent indiquée :

  • gsuiteaddons.deployments.list
pageSize

int32

Nombre maximal de déploiements à renvoyer. Le service peut renvoyer moins que cette valeur. Si aucune valeur n'est spécifiée, 1 000 déploiements au maximum sont renvoyés. La valeur maximale possible est 1 000. Les valeurs supérieures à 1 000 sont remplacées par 1 000.
pageToken

string

Jeton de page reçu d'un appel ListDeployments précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à ListDeployments doivent correspondre à l'appel ayant fourni le jeton de page.

ListDeploymentsResponse

Message de réponse pour répertorier les déploiements.

Champs
deployments[]

Deployment

Liste des déploiements pour le projet donné.
nextPageToken

string

Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

ReplaceDeploymentRequest

Message de requête pour créer ou remplacer un déploiement.

Champs
deployment

Deployment

Obligatoire. Déploiement à créer ou à remplacer.

L'autorisation IAM suivante est requise pour la ressource deployment indiquée :

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Message de requête pour désinstaller un déploiement de test.

Champs
name

string

Obligatoire. Nom complet de la ressource du déploiement à installer.

Exemple : projects/my_project/deployments/my_deployment

L'autorisation IAM suivante est requise pour la ressource name indiquée :

  • gsuiteaddons.deployments.execute