Package google.cloud.gsuiteaddons.v1

Chỉ mục

GSuiteAddOns

Một dịch vụ giúp quản lý việc triển khai các tiện ích bổ sung của Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Tạo một đợt triển khai có tên và cấu hình đã chỉ định.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

Xoá bản triển khai có tên đã cho.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
GetAuthorization

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

Lấy thông tin uỷ quyền cho các lượt triển khai trong một dự án nhất định.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

Lấy thông tin triển khai có tên đã chỉ định.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
GetInstallStatus

rpc GetInstallStatus(GetInstallStatusRequest) returns (InstallStatus)

Xem trạng thái cài đặt của một đợt triển khai kiểm thử.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
InstallDeployment

rpc InstallDeployment(InstallDeploymentRequest) returns (Empty)

Cài đặt một phiên triển khai cho tài khoản của bạn để thử nghiệm. Để biết thêm thông tin, hãy xem phần Kiểm thử tiện ích bổ sung

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Liệt kê tất cả phiên triển khai trong một dự án cụ thể.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
ReplaceDeployment

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

Tạo hoặc thay thế quá trình triển khai bằng tên đã chỉ định.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.
UninstallDeployment

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

Gỡ cài đặt một bản triển khai thử nghiệm khỏi tài khoản của người dùng. Để biết thêm thông tin, hãy xem bài viết Kiểm thử tiện ích bổ sung.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

AddOns

Cấu hình tiện ích bổ sung của Google Workspace.

Trường
common

CommonAddOnManifest

Đây là cấu hình phổ biến trên tất cả tiện ích bổ sung của Google Workspace.
gmail

GmailAddOnManifest

Cấu hình tiện ích bổ sung Gmail.
drive

DriveAddOnManifest

Cấu hình tiện ích bổ sung Drive.
calendar

CalendarAddOnManifest

Cấu hình tiện ích bổ sung Lịch.
docs

DocsAddOnManifest

Cấu hình tiện ích bổ sung của Tài liệu.
sheets

SheetsAddOnManifest

Cấu hình tiện ích bổ sung của Trang tính.
slides

SlidesAddOnManifest

Cấu hình tiện ích bổ sung của Trang trình bày.
httpOptions

HttpOptions

Các tuỳ chọn để gửi yêu cầu đến điểm cuối HTTP của tiện ích bổ sung

Ủy quyền

Thông tin uỷ quyền được dùng khi gọi các điểm cuối triển khai.

Trường
name

string

Tên đầy đủ chuẩn hoá của tài nguyên này. Ví dụ: projects/123/authorization
serviceAccountEmail

string

Địa chỉ email của tài khoản dịch vụ dùng để xác thực các yêu cầu đến điểm cuối gọi lại của tiện ích bổ sung.
oauthClientId

string

Mã ứng dụng khách OAuth được dùng để thay mặt tiện ích bổ sung lấy mã truy cập OAuth cho người dùng.

CreateDeploymentRequest

Yêu cầu tạo thông báo triển khai.

Trường
parent

string

Bắt buộc. Tên của dự án mà bạn muốn tạo đợt triển khai.

Ví dụ: projects/my_project

Việc uỷ quyền yêu cầu quyền IAM sau đây trên tài nguyên parent đã chỉ định:

  • gsuiteaddons.deployments.create
deploymentId

string

Bắt buộc. Mã nhận dạng để sử dụng cho lần triển khai này. Tên đầy đủ của tài nguyên được tạo sẽ là projects/<project_number>/deployments/<deployment_id>.
deployment

Deployment

Bắt buộc. Quá trình triển khai cần tạo (không thể đặt deployment.name).

DeleteDeploymentRequest

Yêu cầu tin nhắn để xoá một đợt triển khai.

Trường
name

string

Bắt buộc. Tên tài nguyên đầy đủ của quá trình triển khai cần xoá.

Ví dụ: projects/my_project/deployments/my_deployment

Việc uỷ quyền yêu cầu quyền IAM sau đây trên tài nguyên name đã chỉ định:

  • gsuiteaddons.deployments.delete
etag

string

Etag của bản triển khai cần xoá. Nếu được cung cấp, thì mã này phải khớp với thẻ etag của máy chủ.

Triển khai

Một lượt triển khai tiện ích bổ sung của Google Workspace

Trường
name

string

Tên tài nguyên triển khai. Ví dụ: projects/123/deployments/my_deployment
oauthScopes[]

string

Danh sách các phạm vi OAuth của Google cần yêu cầu người dùng cuối đồng ý trước khi thực thi điểm cuối tiện ích bổ sung.
addOns

AddOns

Cấu hình của tiện ích bổ sung Google Workspace.
etag

string

Giá trị này do máy chủ tính toán dựa trên phiên bản triển khai trong bộ nhớ và có thể được gửi theo yêu cầu cập nhật và xoá để đảm bảo ứng dụng có giá trị mới nhất trước khi tiếp tục.

GetAuthorizationRequest

Thông báo yêu cầu lấy thông tin uỷ quyền cho Tiện ích bổ sung dành cho Google Workspace.

Trường
name

string

Bắt buộc. Tên dự án mà bạn muốn nhận thông tin về việc uỷ quyền Tiện ích bổ sung của Google Workspace.

Ví dụ: projects/my_project/authorization

Việc uỷ quyền đòi hỏi quyền IAM sau đây đối với tài nguyên được chỉ định name:

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

Yêu cầu thông báo để nhận một bản triển khai.

Trường
name

string

Bắt buộc. Tên tài nguyên đầy đủ của quá trình triển khai cần tải.

Ví dụ: projects/my_project/deployments/my_deployment

Việc uỷ quyền đòi hỏi quyền IAM sau đây đối với tài nguyên được chỉ định name:

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

Yêu cầu thông báo để biết trạng thái cài đặt của một bản triển khai thử nghiệm.

Trường
name

string

Bắt buộc. Tên tài nguyên đầy đủ của bản triển khai.

Ví dụ: projects/my_project/deployments/my_deployment/installStatus

Việc uỷ quyền đòi hỏi quyền IAM sau đây đối với tài nguyên được chỉ định name:

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

Yêu cầu cài đặt một bản triển khai để kiểm thử.

Trường
name

string

Bắt buộc. Tên tài nguyên đầy đủ của bản triển khai cần cài đặt.

Ví dụ: projects/my_project/deployments/my_deployment

Việc uỷ quyền yêu cầu quyền IAM sau đây trên tài nguyên name đã chỉ định:

  • gsuiteaddons.deployments.install

InstallStatus

Trạng thái cài đặt của một bản triển khai thử nghiệm.

Trường
name

string

Tên tài nguyên đầy đủ chuẩn hoá của trạng thái cài đặt triển khai.

Ví dụ: projects/123/deployments/my_deployment/installStatus
installed

BoolValue

Đúng nếu người dùng đã cài đặt bản triển khai.

ListDeploymentsRequest

Thông báo yêu cầu liệt kê các lượt triển khai cho một dự án.

Trường
parent

string

Bắt buộc. Tên của dự án mà bạn muốn tạo đợt triển khai.

Ví dụ: projects/my_project

Việc uỷ quyền yêu cầu quyền IAM sau đây trên tài nguyên parent đã chỉ định:

  • gsuiteaddons.deployments.list
pageSize

int32

Số lượng phiên bản triển khai tối đa cần trả về. Dịch vụ có thể trả về ít hơn giá trị này. Nếu không chỉ định, hệ thống sẽ trả về tối đa 1.000 lượt triển khai. Giá trị tối đa có thể là 1.000; các giá trị lớn hơn 1.000 được thay đổi thành 1.000.
pageToken

string

Mã thông báo trang, nhận được từ lệnh gọi ListDeployments trước đó. Cung cấp mã này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các tham số khác được cung cấp cho ListDeployments phải khớp với lệnh gọi đã cung cấp mã thông báo trang.

ListDeploymentsResponse

Thông báo phản hồi để liệt kê các lượt triển khai.

Trường
deployments[]

Deployment

Danh sách phiên bản triển khai của dự án đã cho.
nextPageToken

string

Mã thông báo có thể được gửi dưới dạng page_token để truy xuất trang tiếp theo. Nếu trường này bị bỏ qua thì sẽ không có trang tiếp theo.

ReplaceDeploymentRequest

Yêu cầu tạo hoặc thay thế một bản triển khai.

Trường
deployment

Deployment

Bắt buộc. Quá trình triển khai để tạo hoặc thay thế.

Việc uỷ quyền đòi hỏi quyền IAM sau đây đối với tài nguyên được chỉ định deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Yêu cầu gỡ cài đặt một bản triển khai thử nghiệm.

Trường
name

string

Bắt buộc. Tên tài nguyên đầy đủ của bản triển khai cần cài đặt.

Ví dụ: projects/my_project/deployments/my_deployment

Việc uỷ quyền yêu cầu quyền IAM sau đây trên tài nguyên name đã chỉ định:

  • gsuiteaddons.deployments.execute