Package google.cloud.gsuiteaddons.v1

Индекс

GSuiteДополнения

Сервис для управления развертыванием надстроек Google Workspace.

Создать развертывание

rpc CreateDeployment( CreateDeploymentRequest ) returns ( Deployment )

Создает развертывание с указанным именем и конфигурацией.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Удалить развертывание

rpc DeleteDeployment( DeleteDeploymentRequest ) returns ( Empty )

Удаляет развертывание с указанным именем.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Получить авторизацию

rpc GetAuthorization( GetAuthorizationRequest ) returns ( Authorization )

Получает информацию об авторизации для развертываний в данном проекте.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Получить развертывание

rpc GetDeployment( GetDeploymentRequest ) returns ( Deployment )

Получает развертывание с указанным именем.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

GetInstallStatus

rpc GetInstallStatus( GetInstallStatusRequest ) returns ( InstallStatus )

Получает состояние установки тестового развертывания.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

УстановкаРазвертывание

rpc InstallDeployment( InstallDeploymentRequest ) returns ( Empty )

Устанавливает развертывание в вашу учетную запись для тестирования. Дополнительную информацию см. в разделе Проверка надстройки.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Список развертываний

rpc ListDeployments( ListDeploymentsRequest ) returns ( ListDeploymentsResponse )

Перечисляет все развертывания в конкретном проекте.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Замена развертывания

rpc ReplaceDeployment( ReplaceDeploymentRequest ) returns ( Deployment )

Создает или заменяет развертывание с указанным именем.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Удалить развертывание

rpc UninstallDeployment( UninstallDeploymentRequest ) returns ( Empty )

Удаляет тестовое развертывание из учетной записи пользователя. Дополнительную информацию см. в разделе Проверка надстройки .

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .

Дополнения

Конфигурация надстройки Google Workspace.

Поля
common

CommonAddOnManifest

Конфигурация, общая для всех дополнений Google Workspace.

gmail

GmailAddOnManifest

Конфигурация дополнения Gmail.

drive

DriveAddOnManifest

Конфигурация надстройки диска.

calendar

CalendarAddOnManifest

Настройка дополнения календаря.

docs

DocsAddOnManifest

Конфигурация дополнения «Документы».

sheets

SheetsAddOnManifest

Конфигурация надстройки Таблиц.

slides

SlidesAddOnManifest

Конфигурация надстройки слайдов.

httpOptions

HttpOptions

Варианты отправки запросов на дополнительные конечные точки HTTP

Авторизация

Информация авторизации, используемая при вызове конечных точек развертывания.

Поля
name

string

Каноническое полное имя этого ресурса. Пример: projects/123/authorization

serviceAccountEmail

string

Адрес электронной почты учетной записи службы, используемый для аутентификации запросов к дополнительным конечным точкам обратного вызова.

oauthClientId

string

Идентификатор клиента OAuth, используемый для получения токенов доступа OAuth для пользователя от имени надстройки.

Создать запрос развертывания

Сообщение запроса на создание развертывания.

Поля
parent

string

Необходимый. Имя проекта, в котором необходимо создать развертывание.

Пример: projects/my_project .

Для авторизации требуется следующее разрешение IAM для указанного parent ресурса:

  • gsuiteaddons.deployments.create
deploymentId

string

Необходимый. Идентификатор, который будет использоваться для этого развертывания. Полное имя созданного ресурса будет projects/<project_number>/deployments/<deployment_id> .

deployment

Deployment

Необходимый. Развертывание, которое необходимо создать (имя_развертывания нельзя задать).

Удалитьдеплойментрекуест

Сообщение с запросом на удаление развертывания.

Поля
name

string

Необходимый. Полное имя ресурса развертывания, которое требуется удалить.

Пример: projects/my_project/deployments/my_deployment .

Для авторизации требуется следующее разрешение IAM для указанного name ресурса:

  • gsuiteaddons.deployments.delete
etag

string

Etag развертывания, которое необходимо удалить. Если это предусмотрено, оно должно соответствовать etag сервера.

Развертывание

Развертывание надстройки Google Workspace

Поля
name

string

Имя ресурса развертывания. Пример: projects/123/deployments/my_deployment .

oauthScopes[]

string

Список областей Google OAuth, для которых запрашивается согласие конечного пользователя перед выполнением конечной точки надстройки.

addOns

AddOns

Конфигурация надстройки Google Workspace.

etag

string

Это значение вычисляется сервером на основе версии развертывания в хранилище и может отправляться в запросах на обновление и удаление, чтобы убедиться, что клиент имеет актуальное значение, прежде чем продолжить.

Получить запрос авторизации

Запросите сообщение, чтобы получить информацию для авторизации надстройки Google Workspace.

Поля
name

string

Необходимый. Название проекта, для которого необходимо получить информацию об авторизации надстройки Google Workspace.

Пример: projects/my_project/authorization .

Для авторизации требуется следующее разрешение IAM для указанного name ресурса:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

Запросите сообщение для получения развертывания.

Поля
name

string

Необходимый. Полное имя ресурса развертывания, которое необходимо получить.

Пример: projects/my_project/deployments/my_deployment .

Для авторизации требуется следующее разрешение IAM для указанного name ресурса:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Запросите сообщение, чтобы получить статус установки тестового развертывания.

Поля
name

string

Необходимый. Полное имя ресурса развертывания.

Пример: projects/my_project/deployments/my_deployment/installStatus .

Для авторизации требуется следующее разрешение IAM для указанного name ресурса:

  • gsuiteaddons.deployments.installStatus

Инсталлдеплойментреквест

Сообщение с запросом на установку развертывания для тестирования.

Поля
name

string

Необходимый. Полное имя ресурса развертывания, которое необходимо установить.

Пример: projects/my_project/deployments/my_deployment .

Для авторизации требуется следующее разрешение IAM для указанного name ресурса:

  • gsuiteaddons.deployments.install

Инсталлстатус

Статус установки тестового развертывания.

Поля
name

string

Каноническое полное имя ресурса состояния установки развертывания.

Пример: projects/123/deployments/my_deployment/installStatus .

installed

BoolValue

True, если развертывание установлено для пользователя.

Запрос списка развертываний

Сообщение запроса для перечисления развертываний для проекта.

Поля
parent

string

Необходимый. Имя проекта, в котором необходимо создать развертывание.

Пример: projects/my_project .

Для авторизации требуется следующее разрешение IAM для указанного parent ресурса:

  • gsuiteaddons.deployments.list
pageSize

int32

Максимальное количество возвращаемых развертываний. Служба может вернуть меньше этого значения. Если не указано, возвращается не более 1000 развертываний. Максимально возможное значение — 1000; значения выше 1000 изменяются на 1000.

pageToken

string

Токен страницы, полученный в результате предыдущего вызова ListDeployments . Предоставьте это, чтобы получить следующую страницу.

При разбиении на страницы все остальные параметры, предоставляемые ListDeployments должны соответствовать вызову, который предоставил токен страницы.

ListDeploymentsResponse

Ответное сообщение для получения списка развертываний.

Поля
deployments[]

Deployment

Список развертываний для данного проекта.

nextPageToken

string

Токен, который можно отправить как page_token для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

Резаменедеплойментреквест

Сообщение запроса на создание или замену развертывания.

Поля
deployment

Deployment

Необходимый. Развертывание для создания или замены.

Для авторизации требуется следующее разрешение IAM для указанного deployment ресурса:

  • gsuiteaddons.deployments.update

ДеинсталлДеплойментрекуест

Сообщение с запросом на удаление тестового развертывания.

Поля
name

string

Необходимый. Полное имя ресурса развертывания, которое необходимо установить.

Пример: projects/my_project/deployments/my_deployment .

Для авторизации требуется следующее разрешение IAM для указанного name ресурса:

  • gsuiteaddons.deployments.execute