Package google.cloud.gsuiteaddons.v1

Chỉ mục

Tiện ích bổ sung G Suite

Dịch vụ quản lý việc triển khai tiện ích bổ sung cho Google Workspace.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

Tạo một quá trình 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á quá trình 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)

Nhận hoạt động triển khai với 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)

Nhận trạng thái cài đặt của một lượt triển khai thử nghiệm.

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 phiên bản triển khai vào tài khoản của bạn để kiểm thử. Để 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.
ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

Liệt kê tất cả quy trình 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 phiê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.

Các trường
common

CommonAddOnManifest

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 dành cho 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 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 các điểm cuối HTTP bổ sung

Ủy quyền

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

Các trường
name

string

Tên đầy đủ của trang chính tắc 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 yêu cầu tới các điểm cuối gọi lại bổ sung.
oauthClientId

string

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

CreateDeploymentRequest

Thông báo yêu cầu tạo quá trình triển khai.

Các trường
parent

string

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

Ví dụ: projects/my_project

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

  • gsuiteaddons.deployments.create
deploymentId

string

Bắt buộc. Mã nhận dạng để sử dụng cho quá trình 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. Quy trình triển khai cần tạo (không thể đặt Deployment.name).

DeleteDeploymentRequest

Thông báo yêu cầu xoá một đợt triển khai.

Các 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 đối với tài nguyên được chỉ định name:

  • gsuiteaddons.deployments.delete
etag

string

Thẻ (etag) của quá trình triển khai cần xoá. Nếu được cung cấp, giá trị này phải khớp với thẻ của máy chủ.

Triển khai

Triển khai tiện ích bổ sung của Google Workspace

Các 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 mà bạn cần yêu cầu người dùng cuối đồng ý trước khi thực thi điểm cuối của tiện ích bổ sung.
addOns

AddOns

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

string

Giá trị này được 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 khi có các yêu cầu cập nhật và xoá để đảm bảo ứng dụng có giá trị cập nhật trước khi tiếp tục.

GetAuthorizationRequest

Yêu cầu gửi tin nhắn để nhận thông tin về việc uỷ quyền đối với tiện ích bổ sung trên Google Workspace.

Các trường
name

string

Bắt buộc. Tên của dự án cần tải thông tin cấp quyền truy cập vào Tiện ích bổ sung của Google Workspace.

Ví dụ: projects/my_project/authorization

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

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

Tin nhắn yêu cầu để triển khai.

Các 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 lấy.

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

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

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

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

Các trường
name

string

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

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

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

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

Thông báo yêu cầu cài đặt bản triển khai để kiểm thử.

Các trường
name

string

Bắt buộc. Tên tài nguyên đầy đủ của quá trình triển khai để 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 đối với tài nguyên được chỉ định name:

  • gsuiteaddons.deployments.install

InstallStatus

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

Các trường
name

string

Tên tài nguyên đầy đủ chính tắc 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 quy trình triển khai được cài đặt cho người dùng.

ListDeploymentsRequest

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

Các trường
parent

string

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

Ví dụ: projects/my_project

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

  • gsuiteaddons.deployments.list
pageSize

int32

Số lượt 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ả lại tối đa 1.000 lượt triển khai. Giá trị tối đa có thể là 1.000; các giá trị trê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 thông 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 cho danh sách triển khai.

Các trường
deployments[]

Deployment

Danh sách nội dung triển khai cho dự án cụ thể.
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ì không có trang tiếp theo nào.

ReplaceDeploymentRequest

Thông báo yêu cầu tạo hoặc thay thế quá trình triển khai.

Các 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 yêu cầu quyền IAM sau đây đối với tài nguyên được chỉ định deployment:

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

Thông báo yêu cầu gỡ cài đặt một bản triển khai thử nghiệm.

Các trường
name

string

Bắt buộc. Tên tài nguyên đầy đủ của quá trình triển khai để 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 đối với tài nguyên được chỉ định name:

  • gsuiteaddons.deployments.execute