Package google.cloud.gsuiteaddons.v1

Indeks

Dodatki do G Suite

Usługa do zarządzania wdrożeniami dodatków do Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Tworzy wdrożenie o określonej nazwie i konfiguracji.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Usuwa wdrożenie o podanej nazwie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Pobiera informacje o autoryzacji wdrożeń w danym projekcie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Pobiera wdrożenie o określonej nazwie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Pobiera stan instalacji wdrożenia testowego.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Instaluje wdrożenie na Twoim koncie na potrzeby testowania. Więcej informacji znajdziesz w artykule Testowanie dodatku.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Wyświetla listę wszystkich wdrożeń w danym projekcie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Tworzy lub zastępuje wdrożenie o podanej nazwie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Odinstalowuje wdrożenie testowe z konta użytkownika. Więcej informacji znajdziesz w artykule Testowanie dodatku.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

AddOns

Konfiguracja dodatku do Google Workspace.

Pola
common

CommonAddOnManifest

Konfiguracja wspólna dla wszystkich dodatków do Google Workspace.
gmail

GmailAddOnManifest

Konfiguracja dodatku w Gmailu.
drive

DriveAddOnManifest

Konfiguracja dodatku do Dysku.
calendar

CalendarAddOnManifest

Konfiguracja dodatku do Kalendarza.
docs

DocsAddOnManifest

Konfiguracja dodatku do Dokumentów.
sheets

SheetsAddOnManifest

Konfiguracja dodatku do Arkuszy.
slides

SlidesAddOnManifest

Konfiguracja dodatku do Prezentacji.
httpOptions

HttpOptions

Opcje wysyłania żądań do dodatkowych punktów końcowych HTTP

Upoważnienie

Informacje o autoryzacji używane podczas wywoływania punktów końcowych wdrożenia.

Pola
name

string

Pełna nazwa kanoniczna tego zasobu. Przykład: projects/123/authorization
serviceAccountEmail

string

Adres e-mail konta usługi używanego do uwierzytelniania żądań do dodatkowych punktów końcowych wywołania zwrotnego.
oauthClientId

string

Identyfikator klienta OAuth używany do uzyskania tokenów dostępu OAuth dla użytkownika w imieniu dodatku.

CreateDeploymentRequest

Poproś o wiadomość, aby utworzyć wdrożenie.

Pola
parent

string

To pole jest wymagane. Nazwa projektu, w którym ma zostać utworzone wdrożenie.

Przykład: projects/my_project.

Autoryzacja wymaga tych uprawnień Uprawnienia do określonego zasobu parent:

  • gsuiteaddons.deployments.create
deploymentId

string

To pole jest wymagane. Identyfikator używany w tym wdrożeniu. Pełna nazwa utworzonego zasobu to projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

To pole jest wymagane. Wdrożenie do utworzenia (nie można ustawić nazwy wdrożenia).

DeleteDeploymentRequest

Wyślij prośbę o usunięcie wdrożenia.

Pola
name

string

To pole jest wymagane. Pełna nazwa zasobu wdrożenia do usunięcia.

Przykład: projects/my_project/deployments/my_deployment.

Autoryzacja wymaga tych uprawnień Uprawnienia do określonego zasobu name:

  • gsuiteaddons.deployments.delete
etag

string

Tag wdrożenia do usunięcia. Jeśli ten parametr jest podany, musi być zgodny z etagiem serwera.

Wdrażanie

Wdrożenie dodatku do Google Workspace

Pola
name

string

Nazwa zasobu wdrożenia. Przykład: projects/123/deployments/my_deployment.
oauthScopes[]

string

Lista zakresów Google OAuth, w przypadku których należy poprosić użytkownika o zgodę przed uruchomieniem punktu końcowego dodatku.
addOns

AddOns

Konfiguracja dodatku do Google Workspace.
etag

string

Ta wartość jest obliczana przez serwer na podstawie wersji wdrożenia w pamięci i może być wysyłana w odpowiedzi na żądania aktualizacji i usunięcia, aby upewnić się, że klient ma aktualną wartość, zanim przejdziesz dalej.

GetAuthorizationRequest

Poproś o wiadomość z prośbą o uzyskanie informacji o autoryzacji dodatku Google Workspace.

Pola
name

string

To pole jest wymagane. Nazwa projektu, dla którego chcesz uzyskać informacje o autoryzacji dodatku Google Workspace.

Przykład: projects/my_project/authorization.

Autoryzacja wymaga tych uprawnień Uprawnienia do określonego zasobu name:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

Poproś o wiadomość w celu pobrania wdrożenia.

Pola
name

string

To pole jest wymagane. Pełna nazwa zasobu wdrożenia do pobrania.

Przykład: projects/my_project/deployments/my_deployment.

Autoryzacja wymaga tych uprawnień Uprawnienia do określonego zasobu name:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Wyślij wiadomość z prośbą o informacje o stanie instalacji wdrożenia testowego.

Pola
name

string

To pole jest wymagane. Pełna nazwa zasobu wdrożenia.

Przykład: projects/my_project/deployments/my_deployment/installStatus.

Autoryzacja wymaga tych uprawnień Uprawnienia do określonego zasobu name:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

Poproś o wiadomość z prośbą o zainstalowanie wdrożenia na potrzeby testów.

Pola
name

string

To pole jest wymagane. Pełna nazwa zasobu wdrożenia do zainstalowania.

Przykład: projects/my_project/deployments/my_deployment.

Autoryzacja wymaga tych uprawnień Uprawnienia do określonego zasobu name:

  • gsuiteaddons.deployments.install

InstallStatus

Stan instalacji testowego wdrożenia.

Pola
name

string

Pełna nazwa kanoniczna zasobu stanu instalacji wdrożenia.

Przykład: projects/123/deployments/my_deployment/installStatus.
installed

BoolValue

Prawda, jeśli wdrożenie zostało zainstalowane dla użytkownika.

ListDeploymentsRequest

Poproś o wiadomość z listą wdrożeń w projekcie.

Pola
parent

string

To pole jest wymagane. Nazwa projektu, w którym ma zostać utworzone wdrożenie.

Przykład: projects/my_project.

Autoryzacja wymaga tych uprawnień Uprawnienia do określonego zasobu parent:

  • gsuiteaddons.deployments.list
pageSize

int32

Maksymalna liczba wdrożeń do zwrócenia. Usługa może zwrócić mniejszą wartość od tej wartości. Jeśli wartość nie jest określona, zwracanych jest maksymalnie 1000 wdrożeń. Maksymalna możliwa wartość to 1000, a wartości powyżej 1000 są zmieniane na 1000.
pageToken

string

Token strony otrzymany z poprzedniego wywołania ListDeployments. Podaj tę wartość, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie pozostałe parametry przekazywane w metodzie ListDeployments muszą odpowiadać wywołaniu, które przekazało token strony.

ListDeploymentsResponse

Odpowiedź na listę wdrożeń.

Pola
deployments[]

Deployment

Lista wdrożeń w danym projekcie.
nextPageToken

string

Token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

ReplaceDeploymentRequest

Poproś o wiadomość, aby utworzyć lub zastąpić wdrożenie.

Pola
deployment

Deployment

To pole jest wymagane. Wdrożenie do utworzenia lub zastąpienia.

Autoryzacja wymaga tych uprawnień Uprawnienia do określonego zasobu deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Prośba o odinstalowanie wdrożenia testowego.

Pola
name

string

To pole jest wymagane. Pełna nazwa zasobu wdrożenia do zainstalowania.

Przykład: projects/my_project/deployments/my_deployment.

Autoryzacja wymaga tych uprawnień Uprawnienia do określonego zasobu name:

  • gsuiteaddons.deployments.execute