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)

非空默认值。订阅到期时的时间戳（世界协调时间）。无论输入源使用了什么内容，始终在输出中显示。

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 协议绑定。