Package google.cloud.gsuiteaddons.v1

Indeks

GSuiteAddOns

Usługa do zarządzania wdrożeniami dodatków 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 dotyczącym autoryzacji.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Usuwa wdrożoną wersję o podanej nazwie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Pobiera informacje autoryzacyjne dla 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 dotyczącym 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 dotyczącym autoryzacji.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Pobiera stan instalacji testowego wdrożenia.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym 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 dotyczącym 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 dotyczącym autoryzacji.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Tworzy lub zastępuje 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 dotyczącym autoryzacji.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Odinstaluj z konta użytkownika testowe wdrożenie. 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 dotyczącym autoryzacji.

AddOns

konfiguracja dodatku do Google Workspace;

Pola
common

CommonAddOnManifest

Konfiguracja wspólna dla wszystkich dodatków 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.
meet

MeetAddOnManifest

Konfiguracja dodatku do Meet.
sheets

SheetsAddOnManifest

Konfiguracja dodatku do Arkuszy.
slides

SlidesAddOnManifest

Konfiguracja dodatku do Prezentacji.
httpOptions

HttpOptions

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

Autoryzacja

Informacje autoryzacyjne 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żywany do uwierzytelniania żądań do punktów końcowych wywołania zwrotnego dodatku.
oauthClientId

string

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

CreateDeploymentRequest

wiadomość z prośbą o utworzenie wdrożenia;

Pola
parent

string

Wymagane. Nazwa projektu, w którym chcesz utworzyć wdrożenie.

Przykład: projects/my_project.

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu parent:

  • gsuiteaddons.deployments.create
deploymentId

string

Wymagane. Identyfikator do użycia w tym wdrożeniu. Pełna nazwa utworzonego zasobu będzie brzmieć projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

Wymagane. Wdrożenie do utworzenia (nie można ustawić parametru deployment.name).

DeleteDeploymentRequest

wiadomość z prośbą o usunięcie wdrożenia;

Pola
name

string

Wymagane. Pełna nazwa zasobu wdrożenia, które chcesz usunąć.

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

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu name:

  • gsuiteaddons.deployments.delete
etag

string

Etag wdrożenia, które chcesz usunąć. Jeśli podasz ten identyfikator, musi on być zgodny z etykietą serwera.

Wdrożenie

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 protokołu OAuth Google, o które należy poprosić użytkownika przed wykonaniem punktu końcowego dodatku.
addOns

AddOns

Konfiguracja dodatku Google Workspace.
etag

string

Ta wartość jest obliczana przez serwer na podstawie wersji wdrożenia w magazynie i może być wysyłana w żądaniach aktualizacji i usunięcia, aby zapewnić klientowi aktualną wartość przed kontynuacją.

GetAuthorizationRequest

wiadomość z prośbą o informacje autoryzujące dodatek Google Workspace;

Pola
name

string

Wymagane. Nazwa projektu, dla którego chcesz uzyskać informacje o autoryzacji dodatku Google Workspace.

Przykład: projects/my_project/authorization.

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu name:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

wiadomość z prośbą o rozpoczęcie wdrożenia;

Pola
name

string

Wymagane. Pełna nazwa zasobu wdrożenia, które chcesz pobrać.

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

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu name:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

wiadomość z prośbą o uzyskanie stanu instalacji testowego wdrożenia.

Pola
name

string

Wymagane. Pełna nazwa zasobu wdrożenia.

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

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu name:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

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

Pola
name

string

Wymagane. Pełna nazwa zasobu wdrożenia do zainstalowania.

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

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu name:

  • gsuiteaddons.deployments.install

InstallStatus

Stan instalacji wdrożenia testowego.

Pola
name

string

Kanoniczna pełna nazwa zasobu stanu instalacji wdrożenia.

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

BoolValue

Wartość Prawda, jeśli wdrożenie jest zainstalowane dla użytkownika.

ListDeploymentsRequest

Żądanie wyświetlenia listy wdrożeń w projekcie.

Pola
parent

string

Wymagane. Nazwa projektu, w którym chcesz utworzyć wdrożenie.

Przykład: projects/my_project.

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu parent:

  • gsuiteaddons.deployments.list
pageSize

int32

Maksymalna liczba wdrożeń do zwrócenia. Usługa może zwrócić mniej niż ta wartość. Jeśli nie podasz tej wartości, zwróci się maksymalnie 1000 wdrożeń. Maksymalna możliwa wartość to 1000; wartości powyżej 1000 są zmieniane na 1000.
pageToken

string

Token strony otrzymany z poprzedniego wywołania funkcji ListDeployments. Podaj ten parametr, aby pobrać kolejną stronę.

Podczas podziału na strony wszystkie inne parametry przekazywane do funkcji ListDeployments muszą być zgodne z wywołaniem, które dostarczyło token strony.

ListDeploymentsResponse

Odpowiedź na wiadomość z 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

wiadomość z prośbą o utworzenie lub zastąpienie wdrożenia;

Pola
deployment

Deployment

Wymagane. Wdrożenie do utworzenia lub zastąpienia.

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Prośba o odinstalowanie testowego wdrożenia.

Pola
name

string

Wymagane. Pełna nazwa zasobu wdrożenia do zainstalowania.

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

Autoryzacja wymaga tych uprawnień IAM w przypadku określonego zasobu name:

  • gsuiteaddons.deployments.execute