REST Resource: subscriptions

{
  "name": string,
  "uid": string,
  "targetResource": string,
  "eventTypes": [
    string
  ],
  "payloadOptions": {
    object (PayloadOptions)
  },
  "notificationEndpoint": {
    object (NotificationEndpoint)
  },
  "state": enum (State),
  "suspensionReason": enum (ErrorType),
  "authority": string,
  "createTime": string,
  "updateTime": string,
  "reconciling": boolean,
  "etag": string,

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}

string

선택사항입니다. 변경할 수 없습니다. 식별자. 구독의 리소스 이름입니다.

형식: subscriptions/{subscription}

string

출력 전용입니다. 시스템에서 할당한 정기 결제의 고유 식별자입니다.

string

필수 항목입니다. 변경할 수 없습니다. 이벤트를 모니터링하는 Google Workspace 리소스로, 전체 리소스 이름 형식으로 지정됩니다. 대상 리소스 및 대상 리소스에서 지원하는 이벤트에 대해 자세히 알아보려면 지원되는 Google Workspace 이벤트를 참고하세요.

사용자는 앱이 주어진 대상 리소스에 하나의 구독을 만들도록 승인만 할 수 있습니다. 앱에서 동일한 사용자 인증 정보로 다른 정기 결제를 만들려고 하면 요청에서 ALREADY_EXISTS 오류가 반환됩니다.

string

필수 항목입니다. 변경할 수 없습니다. 순서가 지정되지 않은 목록입니다. 구독 생성을 위한 입력입니다. 그렇지 않으면 출력 전용입니다. 타겟 리소스에 대해 수신할 하나 이상의 이벤트 유형입니다. CloudEvents 사양에 따라 형식이 지정됩니다.

지원되는 이벤트 유형은 구독의 타겟 리소스에 따라 다릅니다. 자세한 내용은 지원되는 Google Workspace 일정을 참고하세요.

기본적으로 정기 결제의 수명 주기에 관한 이벤트도 수신합니다. 이 필드에는 수명 주기 이벤트를 지정할 필요가 없습니다.

대상 리소스에 존재하지 않는 이벤트 유형을 지정하면 요청에서 HTTP 400 Bad Request 상태 코드가 반환됩니다.

object (PayloadOptions)

선택사항입니다. 이벤트 페이로드에 포함할 데이터에 대한 옵션입니다. Google Chat 이벤트에서만 지원됩니다.

object (NotificationEndpoint)

필수 항목입니다. 변경할 수 없습니다. 구독이 Pub/Sub 주제와 같은 이벤트를 전달하는 엔드포인트입니다.

enum (State)

출력 전용입니다. 정기 결제의 상태입니다. 구독이 이벤트를 수신하여 알림 엔드포인트로 전달할 수 있는지 여부를 결정합니다.

enum (ErrorType)

출력 전용입니다. 구독을 정지한 오류입니다.

정기 결제를 다시 활성화하려면 오류를 해결하고 subscriptions.reactivate 메서드를 호출합니다.

string

출력 전용입니다. 구독 생성을 승인한 사용자입니다.

형식: users/{user}

Google Workspace 사용자의 경우 {user} 값은 Directory API의 user.id 필드입니다.

string (Timestamp format)

출력 전용입니다. 구독이 생성된 시간입니다.

string (Timestamp format)

출력 전용입니다. 구독이 마지막으로 업데이트된 시간입니다.

boolean

출력 전용입니다. true인 경우 정기 결제가 업데이트되는 중입니다.

string

선택사항입니다. 이 체크섬은 서버에서 다른 필드의 값을 기반으로 계산하며, 계속하기 전에 클라이언트에 최신 값이 있는지 확인하기 위해 업데이트 요청 시 전송될 수 있습니다.

string (Timestamp format)

비어 있지 않은 기본값입니다. 정기 결제가 만료되는 타임스탬프(UTC)입니다. 입력에 사용된 것과 관계없이 항상 출력에 표시됩니다.

string (Duration format)

입력 전용입니다. 구독의 TTL (수명) 또는 기간입니다. 지정하지 않거나 0로 설정하면 가능한 최대 기간을 사용합니다.

{
  "includeResource": boolean,
  "fieldMask": string
}

boolean

선택사항입니다. 이벤트 페이로드에 변경된 리소스에 대한 데이터가 포함되어 있는지 여부 예를 들어 Google Chat 메시지가 생성된 이벤트의 경우 페이로드에 Message 리소스에 대한 데이터가 포함되어 있는지 확인합니다. false인 경우 이벤트 페이로드에는 변경된 리소스의 이름만 포함됩니다.

string (FieldMask format)

선택사항입니다. includeResource가 true로 설정된 경우 이벤트 페이로드에 포함할 필드 목록입니다. 필드는 쉼표로 구분합니다. 예를 들어 Google Chat 메시지 발신자를 포함하고 시간을 만들려면 message.sender,message.createTime를 입력합니다. 생략하면 페이로드에 리소스의 모든 필드가 포함됩니다.

리소스에 존재하지 않는 필드를 지정하면 시스템은 해당 필드를 무시합니다.

{

  // Union field endpoint can be only one of the following:
  "pubsubTopic": string
  // End of list of possible types for union field endpoint.
}

string

변경할 수 없습니다. 구독에 대한 이벤트를 수신하는 Cloud Pub/Sub 주제입니다.

형식: projects/{project}/topics/{topic}

이 구독을 만드는 것과 동일한 Google Cloud 프로젝트에서 주제를 만들어야 합니다.

주제가 이벤트를 수신하면 이벤트가 Cloud Pub/Sub 메시지로 인코딩됩니다. 자세한 내용은 CloudEvents용 Google Cloud Pub/Sub 프로토콜 바인딩을 참조하세요.