Package google.cloud.gsuiteaddons.v1

색인

G Suite 부가기능

Google Workspace 부가기능 배포를 관리하기 위한 서비스입니다.

배포 만들기

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

지정된 이름과 구성으로 배포를 만듭니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.
배포 삭제

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

지정된 이름의 배포를 삭제합니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.
승인 받기

rpc GetAuthorization(GetAuthorizationRequest) returns (Authorization)

지정된 프로젝트의 배포에 대한 승인 정보를 가져옵니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.
배포 가져오기

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

자세한 내용은 승인 가이드를 참고하세요.
설치 배포

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

자세한 내용은 승인 가이드를 참고하세요.
대체 배포

rpc ReplaceDeployment(ReplaceDeploymentRequest) returns (Deployment)

지정된 이름으로 배포를 만들거나 바꿉니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.
배포 제거

rpc UninstallDeployment(UninstallDeploymentRequest) returns (Empty)

사용자 계정에서 테스트 배포를 제거합니다. 자세한 내용은 부가기능 테스트하기를 참고하세요.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.

부가기능

Google Workspace 부가기능 구성입니다.

필드
common

CommonAddOnManifest

모든 Google Workspace 부가기능에 공통으로 적용되는 구성입니다.
gmail

GmailAddOnManifest

Gmail 부가기능 구성
drive

DriveAddOnManifest

Drive 부가기능 구성
calendar

CalendarAddOnManifest

캘린더 부가기능 구성
docs

DocsAddOnManifest

Docs 부가기능 구성
sheets

SheetsAddOnManifest

Sheets 부가기능 구성
slides

SlidesAddOnManifest

Slides 부가기능 구성
httpOptions

HttpOptions

부가기능 HTTP 엔드포인트에 요청을 전송하는 옵션

승인

배포 엔드포인트를 호출할 때 사용되는 승인 정보입니다.

필드
name

string

이 리소스의 정식 전체 이름입니다. 예: projects/123/authorization
serviceAccountEmail

string

부가기능 콜백 엔드포인트 요청을 인증하는 데 사용되는 서비스 계정의 이메일 주소입니다.
oauthClientId

string

부가기능을 대신하여 사용자의 OAuth 액세스 토큰을 가져오는 데 사용되는 OAuth 클라이언트 ID입니다.

CreateDeploymentRequest

배포를 만들기 위한 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 배포를 만들 프로젝트의 이름입니다.

예: projects/my_project

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • gsuiteaddons.deployments.create
deploymentId

string

필수 항목입니다. 이 배포에 사용할 ID입니다. 생성된 리소스의 전체 이름은 projects/<project_number>/deployments/<deployment_id>입니다.
deployment

Deployment

필수 항목입니다. 만들 배포입니다 (deployment.name은 설정할 수 없음).

DeleteDeploymentRequest

배포를 삭제하기 위한 요청 메시지입니다.

필드
name

string

필수 항목입니다. 삭제할 배포의 전체 리소스 이름입니다.

예: projects/my_project/deployments/my_deployment

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • gsuiteaddons.deployments.delete
etag

string

삭제할 배포의 etag입니다. 제공된 경우 서버의 etag와 일치해야 합니다.

배포

Google Workspace 부가기능 배포

필드
name

string

배포 리소스 이름입니다. 예: projects/123/deployments/my_deployment
oauthScopes[]

string

부가기능 엔드포인트를 실행하기 전에 최종 사용자에게 동의를 요청할 Google OAuth 범위 목록입니다.
addOns

AddOns

Google Workspace 부가기능 구성입니다.
etag

string

이 값은 스토리지의 배포 버전을 기준으로 서버에서 계산되며 계속하기 전에 클라이언트가 최신 값을 갖는지 확인하기 위해 업데이트 및 삭제 요청 시 전송될 수 있습니다.

GetAuthorizationRequest

Google Workspace 부가기능 승인 정보를 가져오기 위한 요청 메시지입니다.

필드
name

string

필수 항목입니다. Google Workspace 부가기능 승인 정보를 가져올 프로젝트의 이름입니다.

예: projects/my_project/authorization

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • gsuiteaddons.authorizations.get

GetDeploymentRequest

배포를 가져오기 위한 요청 메시지입니다.

필드
name

string

필수 항목입니다. 가져올 배포의 전체 리소스 이름입니다.

예: projects/my_project/deployments/my_deployment

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • gsuiteaddons.deployments.get

GetInstallStatusRequest

테스트 배포의 설치 상태를 가져오는 요청 메시지입니다.

필드
name

string

필수 항목입니다. 배포의 전체 리소스 이름입니다.

예: projects/my_project/deployments/my_deployment/installStatus

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • gsuiteaddons.deployments.installStatus

InstallDeploymentRequest

테스트용 배포를 설치하기 위한 요청 메시지입니다.

필드
name

string

필수 항목입니다. 설치할 배포의 전체 리소스 이름입니다.

예: projects/my_project/deployments/my_deployment

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • gsuiteaddons.deployments.install

설치 상태

테스트 배포의 설치 상태입니다.

필드
name

string

배포 설치 상태의 표준 전체 리소스 이름입니다.

예: projects/123/deployments/my_deployment/installStatus
installed

BoolValue

사용자에게 배포가 설치된 경우 참입니다.

ListDeploymentsRequest

프로젝트의 배포를 나열하기 위한 요청 메시지입니다.

필드
parent

string

필수 항목입니다. 배포를 만들 프로젝트의 이름입니다.

예: projects/my_project

승인을 처리하려면 지정된 리소스 parent에 대해 다음과 같은 IAM 권한이 필요합니다.

  • 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

필수 항목입니다. 만들거나 대체할 배포

승인을 처리하려면 지정된 리소스 deployment에 대해 다음과 같은 IAM 권한이 필요합니다.

  • gsuiteaddons.deployments.update

UninstallDeploymentRequest

테스트 배포를 제거하기 위한 요청 메시지입니다.

필드
name

string

필수 항목입니다. 설치할 배포의 전체 리소스 이름입니다.

예: projects/my_project/deployments/my_deployment

승인을 처리하려면 지정된 리소스 name에 대해 다음과 같은 IAM 권한이 필요합니다.

  • gsuiteaddons.deployments.execute