리소스: 구독
Google Workspace 리소스에 대한 이벤트를 수신하는 구독입니다. 구독에 대한 자세한 내용은 Google Workspace Events API 개요를 참고하세요.
JSON 표현 |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
입력란 | |
---|---|
name |
선택사항입니다. 변경할 수 없습니다. 식별자. 구독의 리소스 이름입니다. 형식: |
uid |
출력 전용. 시스템에서 할당한 구독의 고유 식별자입니다. |
targetResource |
필수 항목입니다. 변경할 수 없습니다. 이벤트를 모니터링하는 Google Workspace 리소스로, 전체 리소스 이름 형식으로 지정됩니다. 대상 리소스 및 해당 리소스가 지원하는 이벤트에 대해 알아보려면 지원되는 Google Workspace 이벤트를 참고하세요. 사용자는 지정된 대상 리소스에 대해 구독을 하나만 만들도록 앱을 승인할 수 있습니다. 앱에서 동일한 사용자 인증 정보로 다른 정기 결제를 만들려고 하면 요청에서 |
eventTypes[] |
필수 항목입니다. 변경할 수 없습니다. 순서가 지정되지 않은 목록입니다. 구독을 만들기 위한 입력입니다. 그렇지 않으면 출력만 가능합니다. 타겟 리소스에 관해 수신할 하나 이상의 이벤트 유형입니다. CloudEvents 사양에 따라 형식이 지정됩니다. 지원되는 이벤트 유형은 정기 결제의 대상 리소스에 따라 다릅니다. 자세한 내용은 지원되는 Google Workspace 이벤트를 참고하세요. 기본적으로 구독의 수명 주기에 대한 이벤트도 수신합니다. 이 필드에는 수명 주기 이벤트를 지정할 필요가 없습니다. 대상 리소스에 없는 이벤트 유형을 지정하면 요청이 HTTP |
payloadOptions |
선택사항입니다. 이벤트 페이로드에 포함할 데이터에 대한 옵션입니다. Google Chat 이벤트에만 지원됩니다. |
notificationEndpoint |
필수 항목입니다. 변경할 수 없습니다. 구독이 Pub/Sub 주제와 같은 이벤트를 전달하는 엔드포인트입니다. |
state |
출력 전용. 구독 상태입니다. 구독이 이벤트를 수신하여 알림 엔드포인트로 전송할 수 있는지 여부를 결정합니다. |
suspensionReason |
출력 전용. 구독을 정지한 오류입니다. 정기 결제를 다시 활성화하려면 오류를 해결하고 |
authority |
출력 전용. 정기 결제 생성을 승인한 사용자입니다. 형식: Google Workspace 사용자의 경우 |
createTime |
출력 전용. 구독이 생성된 시간입니다. |
updateTime |
출력 전용. 구독이 마지막으로 업데이트된 시간입니다. |
reconciling |
출력 전용. |
etag |
선택사항입니다. 이 체크섬은 다른 필드의 값을 기준으로 서버에서 계산되며, 계속 진행하기 전에 클라이언트가 최신 값을 유지하도록 업데이트 요청 시 전송될 수 있습니다. |
통합 필드 최대 만료 시간은 구독에
구독이 만료되면 자동으로 삭제됩니다. 구독이 만료되기 12시간 1시간 전에 정기 결제가 만료되지 않도록 하려면 |
|
expireTime |
비어 있지 않은 기본값입니다. 정기 결제가 만료되는 시점의 타임스탬프(UTC 기준) 입력에 사용된 항목과 관계없이 항상 출력에 표시됩니다. |
ttl |
입력 전용. 구독의 TTL (수명) 또는 기간입니다. 지정하지 않거나 |
PayloadOptions
이벤트 페이로드에 포함할 데이터에 대한 옵션입니다. Google Chat 이벤트에만 지원됩니다.
JSON 표현 |
---|
{ "includeResource": boolean, "fieldMask": string } |
입력란 | |
---|---|
includeResource |
선택사항입니다. 이벤트 페이로드에 변경된 리소스에 대한 데이터가 포함되어 있는지 여부입니다. 예를 들어 Google Chat 메시지가 생성된 이벤트의 경우 페이로드에 |
fieldMask |
선택사항입니다. 리소스에 존재하지 않는 필드를 지정하면 시스템은 해당 필드를 무시합니다. |
NotificationEndpoint
구독에서 이벤트를 전송하는 엔드포인트입니다.
JSON 표현 |
---|
{ // Union field |
입력란 | |
---|---|
통합 필드
|
|
pubsubTopic |
변경할 수 없습니다. 구독 이벤트를 수신하는 Cloud Pub/Sub 주제입니다. 형식: 이 구독을 만든 동일한 Google Cloud 프로젝트에서 주제를 만들어야 합니다. 주제가 이벤트를 수신하면 이벤트가 Cloud Pub/Sub 메시지로 인코딩됩니다. 자세한 내용은 CloudEvents를 위한 Google Cloud Pub/Sub 프로토콜 바인딩을 참조하세요. |
상태
가능한 구독 상태입니다.
열거형 | |
---|---|
STATE_UNSPECIFIED |
기본값 이 값은 사용되지 않습니다. |
ACTIVE |
구독이 활성 상태이며 이벤트를 수신하고 알림 엔드포인트로 전송할 수 있습니다. |
SUSPENDED |
오류로 인해 구독에서 이벤트를 수신할 수 없습니다. 오류를 식별하려면 필드를 참조하세요. |
DELETED |
구독이 삭제되었습니다. |
ErrorType
구독에 발생할 수 있는 오류입니다.
열거형 | |
---|---|
ERROR_TYPE_UNSPECIFIED |
기본값 이 값은 사용되지 않습니다. |
USER_SCOPE_REVOKED |
승인하는 사용자가 하나 이상의 OAuth 범위 권한을 취소했습니다. Google Workspace 승인에 대해 자세히 알아보려면 OAuth 동의 화면 구성하기를 참고하세요. |
RESOURCE_DELETED |
구독의 대상 리소스가 더 이상 존재하지 않습니다. |
USER_AUTHORIZATION_FAILURE |
구독 생성을 승인한 사용자는 더 이상 구독의 대상 리소스에 액세스할 수 없습니다. |
ENDPOINT_PERMISSION_DENIED |
Google Workspace 애플리케이션에 구독의 알림 엔드포인트로 이벤트를 전송할 수 있는 액세스 권한이 없습니다. |
ENDPOINT_NOT_FOUND |
구독의 알림 엔드포인트가 존재하지 않거나 구독을 만든 Google Cloud 프로젝트에서 엔드포인트를 찾을 수 없습니다. |
ENDPOINT_RESOURCE_EXHAUSTED |
할당량 부족 또는 비율 제한에 도달하여 구독의 알림 엔드포인트에서 이벤트를 수신할 수 없습니다. |
OTHER |
알 수 없는 오류가 발생했습니다. |
방법 |
|
---|---|
|
Google Workspace 구독을 만듭니다. |
|
Google Workspace 구독을 삭제합니다. |
|
Google Workspace 구독에 대한 세부정보를 가져옵니다. |
|
Google Workspace 구독을 나열합니다. |
|
Google Workspace 구독을 업데이트 또는 갱신합니다. |
|
정지된 Google Workspace 구독을 재활성화합니다. |