Package google.cloud.gsuiteaddons.v1

ดัชนี

GSuiteAddOns

บริการสำหรับจัดการการติดตั้งใช้งานส่วนเสริมของ Google Workspace

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

สร้างการทำให้ใช้งานได้ที่มีชื่อและการกำหนดค่าที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

ลบการทำให้ใช้งานได้ด้วยชื่อที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

รับข้อมูลการให้สิทธิ์สําหรับการติดตั้งใช้งานในโปรเจ็กต์หนึ่งๆ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
GetDeployment

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

ติดตั้งการติดตั้งใช้งานไปยังบัญชีของคุณเพื่อทำการทดสอบ ดูข้อมูลเพิ่มเติมได้ที่ทดสอบส่วนเสริม

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

แสดงรายการการทำให้ใช้งานได้ทั้งหมดในโปรเจ็กต์ที่เฉพาะเจาะจง

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

สร้างหรือแทนที่การติดตั้งใช้งานด้วยชื่อที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

สำหรับข้อมูลเพิ่มเติม โปรดดูที่คู่มือการให้สิทธิ์
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

ถอนการติดตั้งการติดตั้งใช้งานทดสอบออกจากบัญชีของผู้ใช้ ดูข้อมูลเพิ่มเติมได้ที่ทดสอบส่วนเสริม

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์

AddOns

การกําหนดค่าส่วนเสริม 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 ให้กับผู้ใช้ในนามของส่วนเสริม

CreateDeploymentRequest

ข้อความคําขอสร้างการติดตั้ง

ช่อง
parent

string

ต้องระบุ ชื่อโปรเจ็กต์ที่จะสร้างการทำให้ใช้งานได้

ตัวอย่าง: projects/my_project

การให้สิทธิ์ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ parent:

  • gsuiteaddons.deployments.create
deploymentId

string

ต้องระบุ รหัสที่จะใช้สำหรับการทำให้ใช้งานได้นี้ ชื่อเต็มของทรัพยากรที่สร้างจะเป็น projects/<project_number>/deployments/<deployment_id>
deployment

Deployment

ต้องระบุ การทำให้ใช้งานได้ที่จะสร้าง (ตั้งDeployment.name ไม่ได้)

DeleteDeploymentRequest

ข้อความขอให้ลบการทำให้ใช้งานได้

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรแบบเต็มของการติดตั้งใช้งานที่จะลบ

ตัวอย่าง: projects/my_project/deployments/my_deployment

การให้สิทธิ์ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ name:

  • gsuiteaddons.deployments.delete
etag

string

etag ของการทำให้ใช้งานได้ที่จะลบ หากระบุ etag นี้ etag ดังกล่าวต้องตรงกับ etag ของเซิร์ฟเวอร์

การทำให้ใช้งานได้

การติดตั้งใช้งานส่วนเสริม Google Workspace

ช่อง
name

string

ชื่อทรัพยากรการทำให้ใช้งานได้ ตัวอย่าง: projects/123/deployments/my_deployment
oauthScopes[]

string

รายการขอบเขต OAuth ของ Google ที่จะขอความยินยอมจากผู้ใช้ปลายทางก่อนเรียกใช้ปลายทางส่วนเสริม
addOns

AddOns

การกำหนดค่าส่วนเสริมของ Google Workspace
etag

string

ค่านี้จะคำนวณโดยเซิร์ฟเวอร์โดยอิงตามเวอร์ชันของการติดตั้งใช้งานในพื้นที่เก็บข้อมูล และอาจส่งเมื่อคำขออัปเดตและลบเพื่อให้มั่นใจว่าไคลเอ็นต์มีค่าเป็นปัจจุบันก่อนดำเนินการต่อ

GetAuthorizationRequest

ข้อความขอข้อมูลการให้สิทธิ์ส่วนเสริมของ 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

InstallDeploymentRequest

ข้อความขอติดตั้งเพื่อทดสอบการใช้งาน

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรแบบเต็มของการติดตั้งที่จะติดตั้ง

ตัวอย่าง: projects/my_project/deployments/my_deployment

การให้สิทธิ์ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ name:

  • gsuiteaddons.deployments.install

InstallStatus

สถานะการติดตั้งของการติดตั้งใช้งานทดสอบ

ช่อง
name

string

ชื่อทรัพยากรแบบเต็มตามมาตรฐานของสถานะการติดตั้งการทำให้ใช้งานได้

ตัวอย่าง: projects/123/deployments/my_deployment/installStatus
installed

BoolValue

เป็นจริงหากติดตั้งการทำให้ใช้งานได้สำหรับผู้ใช้แล้ว

ListDeploymentsRequest

ข้อความคําขอแสดงรายการการทําให้ใช้งานได้สําหรับโปรเจ็กต์

ช่อง
parent

string

ต้องระบุ ชื่อโปรเจ็กต์ที่จะสร้างการทำให้ใช้งานได้

ตัวอย่าง: projects/my_project

การให้สิทธิ์ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ parent:

  • gsuiteaddons.deployments.list
pageSize

int32

จํานวนสูงสุดของการติดตั้งใช้งานที่จะแสดง บริการอาจแสดงผลน้อยกว่าค่านี้ หากไม่ระบุ ระบบจะแสดงผลการทำให้ใช้งานได้ไม่เกิน 1,000 รายการ ค่าสูงสุดที่เป็นไปได้คือ 1,000 ส่วนค่าที่มากกว่า 1,000 จะเปลี่ยนเป็น 1,000
pageToken

string

โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListDeployments ครั้งก่อน โปรดระบุข้อมูลนี้เพื่อเรียกข้อมูลหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ ListDeployments ต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ

ListDeploymentsResponse

ข้อความตอบกลับเพื่อแสดงรายการการทำให้ใช้งานได้

ช่อง
deployments[]

Deployment

รายการการทำให้ใช้งานได้ของโปรเจ็กต์หนึ่งๆ
nextPageToken

string

โทเค็นซึ่งสามารถส่งเป็น page_token เพื่อเรียกข้อมูลหน้าถัดไป หากเว้นช่องนี้ไว้ จะไม่มีหน้าลำดับต่อมา

ReplaceDeploymentRequest

ข้อความคําขอสร้างหรือแทนที่การติดตั้งใช้งาน

ช่อง
deployment

Deployment

ต้องระบุ การทำให้ใช้งานได้ที่จะสร้างหรือแทนที่

การให้สิทธิ์ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากรที่ระบุ deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

ข้อความคําขอถอนการติดตั้งการติดตั้งใช้งานทดสอบ

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรแบบเต็มของการติดตั้งที่จะติดตั้ง

ตัวอย่าง: projects/my_project/deployments/my_deployment

การให้สิทธิ์ต้องใช้สิทธิ์ IAM ต่อไปนี้ในทรัพยากร name ที่ระบุ

  • gsuiteaddons.deployments.execute