Package google.cloud.gsuiteaddons.v1

Dizin

GSuiteAddOns

Google Workspace eklentisi dağıtımlarını yönetmek için kullanılan bir hizmet.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Belirtilen ada ve yapılandırmayla bir dağıtım oluşturur.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Belirtilen ada sahip dağıtımı siler.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Belirli bir projedeki dağıtımlar için yetkilendirme bilgilerini alır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Belirtilen ada sahip dağıtımı alır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Bir test dağıtımının yükleme durumunu alır.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Test için hesabınıza bir dağıtım yükler. Daha fazla bilgi için Eklentinizi test etme başlıklı makaleyi inceleyin.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Belirli bir projedeki tüm dağıtımları listeler.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Belirtilen ada sahip bir dağıtım oluşturur veya mevcut dağıtımı değiştirir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Kullanıcının hesabından bir test dağıtımını kaldırır. Daha fazla bilgi için Eklentinizi test etme başlıklı makaleyi inceleyin.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

AddOns

Google Workspace eklentisi yapılandırması.

Alanlar
common

CommonAddOnManifest

Tüm Google Workspace eklentilerinde ortak olan yapılandırma.
gmail

GmailAddOnManifest

Gmail eklenti yapılandırması.
drive

DriveAddOnManifest

Drive eklentisi yapılandırması.
calendar

CalendarAddOnManifest

Takvim eklentisi yapılandırması.
docs

DocsAddOnManifest

Dokümanlar eklentisi yapılandırması.
sheets

SheetsAddOnManifest

E-Tablolar eklenti yapılandırması.
slides

SlidesAddOnManifest

Slaytlar eklentisi yapılandırması.
httpOptions

HttpOptions

Eklenti HTTP uç noktalarına istek gönderme seçenekleri

Yetkilendirme

Dağıtım uç noktaları çağrılırken kullanılan yetkilendirme bilgileri.

Alanlar
name

string

Bu kaynağın standart tam adı. Örnek: projects/123/authorization
serviceAccountEmail

string

Eklenti geri çağırma uç noktalarına yönelik isteklerin kimliğini doğrulamak için kullanılan hizmet hesabının e-posta adresi.
oauthClientId

string

Eklenti adına bir kullanıcı için OAuth erişim jetonları almak üzere kullanılan OAuth istemci kimliği.

CreateDeploymentRequest

Dağıtım oluşturmak için istek mesajı.

Alanlar
parent

string

Zorunlu. Dağıtımın oluşturulacağı projenin adı.

Örnek: projects/my_project.

Yetkilendirme için belirtilen parent kaynağında şu IAM izni gerekir:

  • gsuiteaddons.deployments.create
deploymentId

string

Zorunlu. Bu dağıtım için kullanılacak kimlik. Oluşturulan kaynağın tam adı projects/<project_number>/deployments/<deployment_id> olacak.
deployment

Deployment

Zorunlu. Oluşturulacak dağıtım (deployment.name ayarlanamaz).

DeleteDeploymentRequest

Dağıtımı silme isteği mesajı.

Alanlar
name

string

Zorunlu. Silinecek dağıtımın tam kaynak adı.

Örnek: projects/my_project/deployments/my_deployment.

Yetkilendirme için belirtilen name kaynağında şu IAM izni gerekir:

  • gsuiteaddons.deployments.delete
etag

string

Silinecek dağıtımın etag'i. Bu değer sağlanmışsa sunucunun etag'siyle eşleşmesi gerekir.

Dağıtım

Google Workspace Eklenti dağıtımı

Alanlar
name

string

Dağıtım kaynağının adı. Örnek: projects/123/deployments/my_deployment.
oauthScopes[]

string

Eklenti uç noktası çalıştırılmadan önce son kullanıcıdan izin istenecek Google OAuth kapsamlarının listesi.
addOns

AddOns

Google Workspace eklentisi yapılandırması.
etag

string

Bu değer, sunucu tarafından depolama alanındaki dağıtımın sürümüne göre hesaplanır ve devam etmeden önce istemcinin güncel bir değere sahip olmasını sağlamak için güncelleme ve silme isteklerinde gönderilebilir.

GetAuthorizationRequest

Google Workspace eklentisi yetkilendirme bilgilerini alma isteğinde bulunun.

Alanlar
name

string

Zorunlu. Google Workspace eklentisi yetkilendirme bilgilerinin alınacağı projenin adı.

Örnek: projects/my_project/authorization.

Yetkilendirme için belirtilen name kaynağında şu IAM izni gerekir:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

Dağıtım almak için istek mesajı.

Alanlar
name

string

Zorunlu. Alınacak dağıtımın tam kaynak adı.

Örnek: projects/my_project/deployments/my_deployment.

Yetkilendirme, belirtilen kaynak name için aşağıdaki IAM iznini gerektirir:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Test dağıtımının yükleme durumunu almak için istek mesajı.

Alanlar
name

string

Zorunlu. Dağıtımın tam kaynak adı.

Örnek: projects/my_project/deployments/my_deployment/installStatus.

Yetkilendirme için belirtilen name kaynağında şu IAM izni gerekir:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

Test amacıyla dağıtım yükleme isteğinde bulunma mesajı

Alanlar
name

string

Zorunlu. Yüklenecek dağıtımın tam kaynak adı.

Örnek: projects/my_project/deployments/my_deployment.

Yetkilendirme, belirtilen kaynak name için aşağıdaki IAM iznini gerektirir:

  • gsuiteaddons.deployments.install

InstallStatus

Test dağıtımının yükleme durumu.

Alanlar
name

string

Dağıtım yükleme durumunun standart tam kaynak adı.

Örnek: projects/123/deployments/my_deployment/installStatus.
installed

BoolValue

Dağıtım kullanıcı için yüklüyse doğru değerini döndürür.

ListDeploymentsRequest

Bir projenin dağıtımlarını listelemek için istek mesajı.

Alanlar
parent

string

Zorunlu. Dağıtımın oluşturulacağı projenin adı.

Örnek: projects/my_project.

Yetkilendirme için belirtilen parent kaynağında şu IAM izni gerekir:

  • gsuiteaddons.deployments.list
pageSize

int32

Döndürülecek maksimum dağıtım sayısı. Hizmet bu değerden daha az değer döndürebilir. Belirtilmezse en fazla 1.000 dağıtım döndürülür. Olası maksimum değer 1.000'dür. 1.000'den yüksek değerler 1.000 olarak değiştirilir.
pageToken

string

Önceki bir ListDeployments çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın.

Sayfalara ayırma işlemi sırasında ListDeployments öğesine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.

ListDeploymentsResponse

Dağıtımların listelenmesiyle ilgili yanıt mesajı.

Alanlar
deployments[]

Deployment

Belirtilen projenin dağıtımlarının listesi.
nextPageToken

string

Sonraki sayfayı almak için page_token olarak gönderilebilecek bir jeton. Bu alan atlanırsa sonraki sayfalar olmaz.

ReplaceDeploymentRequest

Dağıtım oluşturmak veya değiştirmek için istek mesajı.

Alanlar
deployment

Deployment

Zorunlu. Oluşturulacak veya değiştirilecek dağıtım.

Yetkilendirme için belirtilen deployment kaynağında şu IAM izni gerekir:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Test dağıtımının kaldırılması için istek mesajı.

Alanlar
name

string

Zorunlu. Yüklenecek dağıtımın tam kaynak adı.

Örnek: projects/my_project/deployments/my_deployment.

Yetkilendirme, belirtilen kaynak name için aşağıdaki IAM iznini gerektirir:

  • gsuiteaddons.deployments.execute