Package google.cloud.gsuiteaddons.v1

ดัชนี

ส่วนเสริม G Suite

บริการสำหรับการจัดการการทําให้ส่วนเสริมของ 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 ของเซิร์ฟเวอร์

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

การติดตั้งใช้งานส่วนเสริมของ 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

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

ตัวอย่าง: 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