Package google.cloud.gsuiteaddons.v1

Indeks

GSuiteAddOns

Layanan untuk mengelola deployment Add-on Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Membuat deployment dengan nama dan konfigurasi yang ditentukan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Menghapus deployment yang diberi nama.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Mendapatkan informasi otorisasi untuk deployment di project tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Mendapatkan deployment dengan nama yang ditentukan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Mendapatkan status penginstalan deployment pengujian.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Menginstal deployment ke akun Anda untuk pengujian. Untuk informasi selengkapnya, lihat Menguji add-on

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Mencantumkan semua deployment dalam project tertentu.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Membuat atau mengganti deployment dengan nama yang ditentukan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Meng-uninstal deployment uji dari akun pengguna. Untuk mengetahui informasi selengkapnya, lihat Menguji add-on.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.

AddOns

Konfigurasi Add-on Google Workspace.

Kolom
common

CommonAddOnManifest

Konfigurasi yang umum di semua Add-on Google Workspace.
gmail

GmailAddOnManifest

Konfigurasi add-on Gmail.
drive

DriveAddOnManifest

Konfigurasi add-on Drive.
calendar

CalendarAddOnManifest

Konfigurasi add-on Kalender.
docs

DocsAddOnManifest

Konfigurasi add-on Dokumen.
sheets

SheetsAddOnManifest

Konfigurasi add-on Spreadsheet.
slides

SlidesAddOnManifest

Konfigurasi add-on Slide.
httpOptions

HttpOptions

Opsi untuk mengirim permintaan ke endpoint HTTP add-on

Otorisasi

Informasi otorisasi yang digunakan saat memanggil endpoint deployment.

Kolom
name

string

Nama lengkap kanonis resource ini. Contoh: projects/123/authorization
serviceAccountEmail

string

Alamat email akun layanan yang digunakan untuk mengautentikasi permintaan ke endpoint callback add-on.
oauthClientId

string

Client ID OAuth yang digunakan untuk mendapatkan token akses OAuth bagi pengguna atas nama add-on.

CreateDeploymentRequest

Pesan permintaan untuk membuat deployment.

Kolom
parent

string

Wajib. Nama project tempat deployment akan dibuat.

Contoh: projects/my_project.

Otorisasi memerlukan izin IAM berikut pada resource parent yang ditentukan:

  • gsuiteaddons.deployments.create
deploymentId

string

Wajib. ID yang akan digunakan untuk deployment ini. Nama lengkap resource yang dibuat adalah projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

Wajib. Deployment yang akan dibuat (deployment.name tidak dapat ditetapkan).

DeleteDeploymentRequest

Pesan permintaan untuk menghapus deployment.

Kolom
name

string

Wajib. Nama resource lengkap deployment yang akan dihapus.

Contoh: projects/my_project/deployments/my_deployment.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • gsuiteaddons.deployments.delete
etag

string

Etag deployment yang akan dihapus. Jika diberikan, nilai ini harus cocok dengan etag server.

Deployment

Deployment Add-on Google Workspace

Kolom
name

string

Nama resource deployment. Contoh: projects/123/deployments/my_deployment.
oauthScopes[]

string

Daftar cakupan Google OAuth yang izinnya akan diminta dari pengguna akhir sebelum menjalankan endpoint add-on.
addOns

AddOns

Konfigurasi Add-on Google Workspace.
etag

string

Nilai ini dihitung oleh server berdasarkan versi deployment dalam penyimpanan, dan dapat dikirim pada permintaan pembaruan dan penghapusan untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan.

GetAuthorizationRequest

Permintaan pesan untuk mendapatkan informasi otorisasi Add-on Google Workspace.

Kolom
name

string

Wajib. Nama project yang akan mendapatkan informasi otorisasi Add-on Google Workspace.

Contoh: projects/my_project/authorization.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

Pesan permintaan untuk mendapatkan deployment.

Kolom
name

string

Wajib. Nama lengkap resource deployment yang akan didapatkan.

Contoh: projects/my_project/deployments/my_deployment.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Pesan permintaan untuk mendapatkan status penginstalan deployment pengujian.

Kolom
name

string

Wajib. Nama resource lengkap deployment.

Contoh: projects/my_project/deployments/my_deployment/installStatus.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

Pesan permintaan untuk menginstal deployment untuk pengujian.

Kolom
name

string

Wajib. Nama resource lengkap deployment yang akan diinstal.

Contoh: projects/my_project/deployments/my_deployment.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • gsuiteaddons.deployments.install

InstallStatus

Status penginstalan deployment pengujian.

Kolom
name

string

Nama lengkap resource kanonis dari status penginstalan deployment.

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

BoolValue

Benar jika deployment diinstal untuk pengguna.

ListDeploymentsRequest

Pesan permintaan untuk mencantumkan deployment untuk sebuah project.

Kolom
parent

string

Wajib. Nama project tempat deployment akan dibuat.

Contoh: projects/my_project.

Otorisasi memerlukan izin IAM berikut pada resource parent yang ditentukan:

  • gsuiteaddons.deployments.list
pageSize

int32

Jumlah maksimum deployment yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, akan ada maksimal 1.000 deployment. Nilai maksimum yang memungkinkan adalah 1.000; nilai di atas 1.000 akan diubah menjadi 1.000.
pageToken

string

Token halaman, diterima dari panggilan ListDeployments sebelumnya. Berikan ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk ListDeployments harus sesuai dengan panggilan yang menyediakan token halaman.

ListDeploymentsResponse

Pesan respons untuk mencantumkan deployment.

Kolom
deployments[]

Deployment

Daftar deployment untuk project tertentu.
nextPageToken

string

Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak ada halaman berikutnya.

ReplaceDeploymentRequest

Pesan permintaan untuk membuat atau mengganti deployment.

Kolom
deployment

Deployment

Wajib. Deployment yang akan dibuat atau diganti.

Otorisasi memerlukan izin IAM berikut pada resource deployment yang ditentukan:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Pesan permintaan untuk meng-uninstal deployment pengujian.

Kolom
name

string

Wajib. Nama resource lengkap deployment yang akan diinstal.

Contoh: projects/my_project/deployments/my_deployment.

Otorisasi memerlukan izin IAM berikut pada resource name yang ditentukan:

  • gsuiteaddons.deployments.execute