Package google.cloud.gsuiteaddons.v1

Index

GSuiteAddOns

Ein Dienst zum Verwalten von Bereitstellungen von Google Workspace-Add-ons.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Erstellt eine Bereitstellung 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.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Löscht die Bereitstellung 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.
GetAuthorization

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.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Ruft die Bereitstellung 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.
GetInstallStatus

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.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Installiert eine Bereitstellung zum Testen 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.
ListDeployments

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.
ReplaceDeployment

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.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Eine Testimplementierung wird aus dem Konto des Nutzers deinstalliert. 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.

AddOns

Eine Google Workspace-Add-on-Konfiguration.

Felder
common

CommonAddOnManifest

Konfiguration, die für alle Google Workspace-Add-ons gilt.
gmail

GmailAddOnManifest

Konfiguration des Gmail-Add-ons.
drive

DriveAddOnManifest

Konfiguration des Drive-Add-ons.
calendar

CalendarAddOnManifest

Konfiguration des Kalender-Add-ons
docs

DocsAddOnManifest

Konfiguration des Docs-Add-ons
sheets

SheetsAddOnManifest

Konfiguration des Tabellen-Add-ons.
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

Der kanonische vollständige Name dieser Ressource. Beispiel: projects/123/authorization
serviceAccountEmail

string

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

string

Die OAuth-Client-ID, die zum Abrufen von OAuth-Zugriffstokens für einen Nutzer im Namen des Add-ons verwendet wird.

CreateDeploymentRequest

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 (deployment.name kann nicht festgelegt werden).

DeleteDeploymentRequest

Anfragenachricht zum Löschen einer Bereitstellung.

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 Bereitstellung, die gelöscht werden soll. Wenn es angegeben wird, muss es mit dem ETag des Servers übereinstimmen.

Bereitstellung

Bereitstellung eines Google Workspace-Add-ons

Felder
name

string

Der Name der Bereitstellungsressource. Beispiel: projects/123/deployments/my_deployment.
oauthScopes[]

string

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

AddOns

Die Konfiguration des Google Workspace-Add-ons.
etag

string

Dieser Wert wird vom Server basierend auf der Version der Bereitstellung im Speicher berechnet und kann bei Aktualisierungs- und Löschanfragen gesendet werden, um sicherzustellen, dass der Client über einen aktuellen Wert verfügt, bevor er fortfahren kann.

GetAuthorizationRequest

Nachricht mit der Anfrage, die Autorisierungsinformationen für das Google Workspace-Add-on zu erhalten.

Felder
name

string

Erforderlich. Name des Projekts, für das die Autorisierungsinformationen für das Google Workspace-Add-on 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

GetDeploymentRequest

Anfragenachricht zum Abrufen einer Bereitstellung.

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 zum Abrufen des Installationsstatus einer Testbereitstellung.

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

InstallDeploymentRequest

Anfragenachricht zum Installieren einer Bereitstellung zum Testen.

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

InstallStatus

Installationsstatus einer Testbereitstellung.

Felder
name

string

Der kanonische vollständige Ressourcenname des Bereitstellungsinstallationsstatus.

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

BoolValue

„Wahr“, wenn die Bereitstellung für den Nutzer installiert ist.

ListDeploymentsRequest

Anfragenachricht zum Auflisten von 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 von Bereitstellungen, die zurückgegeben werden sollen. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn keine Angabe gemacht wird, werden maximal 1.000 Bereitstellungen zurückgegeben. Der höchstmö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 Bereitstellungen für das angegebene 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.

ReplaceDeploymentRequest

Anfragenachricht zum Erstellen oder Ersetzen einer Bereitstellung.

Felder
deployment

Deployment

Erforderlich. Die Bereitstellung, die erstellt oder ersetzt werden soll.

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

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Anfragenachricht zum Deinstallieren einer Testbereitstellung.

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