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żenie o danej 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 na temat 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 na temat 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 dotyczącym autoryzacji.

InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Instaluje wdrożenie na koncie w celu przetestowania. 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 na temat 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 na temat 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 na temat autoryzacji.

Dodatki

Konfiguracja dodatku do Google Workspace.

Pola
common

CommonAddOnManifest

Konfiguracja, która jest 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

Autoryzacja

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

Pola
name

string

Kanoniczna pełna nazwa 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łań zwrotnych.

oauthClientId

string

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

CreateDeploymentRequest

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

Pola
parent

string

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

Przykład: projects/my_project.

Autoryzacja wymaga następujących uprawnień IAM w odniesieniu do określonego zasobu parent:

  • gsuiteaddons.deployments.create
deploymentId

string

Wymagane. Identyfikator do użycia w tym wdrożeniu. Pełna nazwa utworzonego zasobu to projects/<project_number>/deployments/<deployment_id>.

deployment

Deployment

Wymagane. Nie można ustawić wdrożenia do utworzenia (deployment.name).

DeleteDeploymentRequest

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

Pola
name

string

Wymagane. Pełna nazwa zasobu wdrożenia do usunięcia.

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

Autoryzacja wymaga następujących uprawnień IAM w odniesieniu do 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, w przypadku których należy zażądać zgody od użytkownika przed wykonaniem dodatku w punkcie końcowym.

addOns

AddOns

Konfiguracja dodatku do Google Workspace.

etag

string

Ta wartość jest obliczana przez serwer na podstawie wersji wdrożenia w pamięci masowej i może być wysyłana w przypadku żądań aktualizacji lub usunięcia, aby zapewnić aktualność wartości, zanim przejdziesz dalej.

GetAuthorizationRequest

Poproś o wiadomość z prośbą o informacje dotyczące autoryzacji dodatku do 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 wdrożenie,

Pola
name

string

Wymagane. Pełna nazwa zasobu wdrożenia, które ma zostać pobrane.

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

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

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Komunikat żądania wyświetlenia stanu instalacji wdrożenia testowego.

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

Komunikat żądania 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 określono inaczej, 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 funkcji ListDeployments. Podaj ten parametr, aby pobrać kolejną stronę.

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

ListDeploymentsResponse

Odpowiedź na prośbę o wyświetlenie listy wdrożeń.

Pola
deployments[]

Deployment

Lista wdrożeń w danym projekcie.

nextPageToken

string

token, który może być wysyłany jako page_token w celu pobrania następnej strony. 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 następujących uprawnień IAM w odniesieniu do 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 następujących uprawnień IAM w odniesieniu do określonego zasobu name:

  • gsuiteaddons.deployments.execute