Package google.cloud.gsuiteaddons.v1

Index

G Suite-Add-ons

Ein Dienst zum Verwalten von Add-on-Bereitstellungen für Google Workspace.

Deployment erstellen

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Erstellt ein Deployment mit dem angegebenen Namen und der angegebenen Konfiguration.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Bereitstellung löschen

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Löscht das Deployment mit dem angegebenen Namen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Autorisierung abrufen

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Ruft die Autorisierungsinformationen für Bereitstellungen in einem bestimmten Projekt ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
GetBereitstellung

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Ruft das Deployment mit dem angegebenen Namen ab

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Status der Installation

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Ruft den Installationsstatus einer Testbereitstellung ab.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Installationsbereitstellung

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Installiert zu Testzwecken ein Deployment in Ihrem Konto. Weitere Informationen finden Sie unter Add-on testen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Listenbereitstellungen

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Listet alle Bereitstellungen in einem bestimmten Projekt auf.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Ersetzen (Deployment)

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Erstellt oder ersetzt ein Deployment mit dem angegebenen Namen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Deployment deinstallieren

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Deinstalliert eine Testbereitstellung aus dem Nutzerkonto. Weitere Informationen finden Sie unter Add-on testen.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.

Add-ons

Eine Add-on-Konfiguration für Google Workspace.

Felder
common

CommonAddOnManifest

Eine gemeinsame Konfiguration für alle Google Workspace-Add-ons.
gmail

GmailAddOnManifest

Add-on-Konfiguration für Gmail
drive

DriveAddOnManifest

Add-on-Konfiguration für Drive
calendar

CalendarAddOnManifest

Konfiguration des Kalender-Add-ons.
docs

DocsAddOnManifest

Add-on-Konfiguration für Google Docs.
sheets

SheetsAddOnManifest

Add-on-Konfiguration für Google Tabellen.
slides

SlidesAddOnManifest

Konfiguration des Präsentationen-Add-ons.
httpOptions

HttpOptions

Optionen zum Senden von Anfragen an Add-on-HTTP-Endpunkte

Autorisierung

Die Autorisierungsinformationen, die beim Aufrufen von Bereitstellungsendpunkten verwendet werden.

Felder
name

string

Kanonischer vollständiger Name dieser Ressource. Beispiel: projects/123/authorization
serviceAccountEmail

string

Die E-Mail-Adresse des Dienstkontos, mit dem die Anfragen an Add-on-Callback-Endpunkte authentifiziert werden.
oauthClientId

string

OAuth-Client-ID, mit der OAuth-Zugriffstokens für einen Nutzer im Namen des Add-ons abgerufen werden.

Anfrage zum Erstellen der Bereitstellung

Anfragenachricht zum Erstellen eines Deployments

Felder
parent

string

Erforderlich. Name des Projekts, in dem die Bereitstellung erstellt werden soll.

Beispiel: projects/my_project.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • gsuiteaddons.deployments.create
deploymentId

string

Erforderlich. Die ID, die für diese Bereitstellung verwendet werden soll. Der vollständige Name der erstellten Ressource lautet projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

Erforderlich. Die zu erstellende Bereitstellung (deploy.name kann nicht festgelegt werden).

Anfrage zum Löschen der Bereitstellung

Anfragenachricht zum Löschen eines Deployments

Felder
name

string

Erforderlich. Der vollständige Ressourcenname der zu löschenden Bereitstellung.

Beispiel: projects/my_project/deployments/my_deployment.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • gsuiteaddons.deployments.delete
etag

string

Das ETag der zu löschenden Bereitstellung. Wenn dieses angegeben ist, muss es mit dem etag des Servers übereinstimmen.

Bereitstellung

Ein Google Workspace-Add-on-Deployment

Felder
name

string

Der Name der Deployment-Ressource. Beispiel: projects/123/deployments/my_deployment.
oauthScopes[]

string

Die Liste der Google OAuth-Bereiche, für die die Einwilligung des Endnutzers angefordert werden soll, bevor ein Add-on-Endpunkt ausgeführt wird.
addOns

AddOns

Konfiguration des Google Workspace-Add-ons.
etag

string

Dieser Wert wird vom Server anhand der Version des Deployments im Speicher berechnet und kann bei Update- und Löschanfragen gesendet werden, um vor dem Fortfahren sicherzustellen, dass der Client auf dem neuesten Stand ist.

GetAutorisierungsanfrage

Anfragenachricht, um die Informationen für das Google Workspace-Add-on für die Autorisierung abzurufen.

Felder
name

string

Erforderlich. Name des Projekts, für das die Informationen zur Autorisierung des Google Workspace-Add-ons abgerufen werden sollen.

Beispiel: projects/my_project/authorization.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • gsuiteaddons.authorizations.get

GetRequest (Anfrage)

Anfragenachricht, um ein Deployment abzurufen.

Felder
name

string

Erforderlich. Der vollständige Ressourcenname der abzurufenden Bereitstellung.

Beispiel: projects/my_project/deployments/my_deployment.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Anfragenachricht, um den Installationsstatus einer Testbereitstellung abzurufen.

Felder
name

string

Erforderlich. Der vollständige Ressourcenname der Bereitstellung.

Beispiel: projects/my_project/deployments/my_deployment/installStatus.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • gsuiteaddons.deployments.installStatus

Anfrage zur Installation

Anfragenachricht zum Installieren eines Deployments zu Testzwecken.

Felder
name

string

Erforderlich. Der vollständige Ressourcenname der zu installierenden Bereitstellung.

Beispiel: projects/my_project/deployments/my_deployment.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • gsuiteaddons.deployments.install

Installationsstatus

Installationsstatus einer Testbereitstellung.

Felder
name

string

Kanonischer vollständiger Ressourcenname des Installationsstatus der Bereitstellung.

Beispiel: projects/123/deployments/my_deployment/installStatus.
installed

BoolValue

True, wenn das Deployment für den Nutzer installiert ist.

ListDeployments-Anfrage

Anfragenachricht zum Auflisten der Bereitstellungen für ein Projekt

Felder
parent

string

Erforderlich. Name des Projekts, in dem die Bereitstellung erstellt werden soll.

Beispiel: projects/my_project.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource parent erforderlich:

  • gsuiteaddons.deployments.list
pageSize

int32

Die maximale Anzahl der Bereitstellungen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nichts angegeben ist, werden maximal 1.000 Bereitstellungen zurückgegeben. Der maximal mögliche Wert ist 1.000. Werte über 1.000 werden in 1.000 geändert.
pageToken

string

Ein Seitentoken, das von einem vorherigen ListDeployments-Aufruf empfangen wurde. Geben Sie diese an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für ListDeployments bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.

ListDeploymentsResponse

Antwortnachricht zum Auflisten von Bereitstellungen.

Felder
deployments[]

Deployment

Die Liste der Deployments für das jeweilige Projekt.
nextPageToken

string

Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Ersatzanfrage senden

Anfragenachricht zum Erstellen oder Ersetzen eines Deployments

Felder
deployment

Deployment

Erforderlich. Das Deployment, das erstellt oder ersetzt werden soll.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource deployment erforderlich:

  • gsuiteaddons.deployments.update

Bereitstellungsanfrage deinstallieren

Fordern Sie die Nachricht an, um eine Testbereitstellung zu deinstallieren.

Felder
name

string

Erforderlich. Der vollständige Ressourcenname der zu installierenden Bereitstellung.

Beispiel: projects/my_project/deployments/my_deployment.

Für die Autorisierung ist die folgende IAM-Berechtigung für die angegebene Ressource name erforderlich:

  • gsuiteaddons.deployments.execute