推送通知

本文档介绍了如何使用推送通知，以便在资源发生变化时通知您的应用。

概览

Directory API 提供推送通知，让您可以监控资源的变化。您可以使用此功能来提升应用的性能。这样，您就可以消除轮询资源以确定其是否发生更改所涉及的额外网络和计算费用。每当被监控的资源发生变化时，Directory API 都会通知您的应用。

如需使用推送通知，您必须执行以下两项操作：

  • 设置接收网址或“网络钩子”回调接收器。

    这是一个 HTTPS 服务器，用于处理在资源发生更改时触发的 API 通知消息。

  • 为您要监控的每个资源端点设置一个通知渠道。

    渠道用于指定通知消息的路由信息。在渠道设置过程中，您必须指明要接收通知的具体网址。每当渠道的资源发生变化时，Directory API 都会将通知消息作为 POST 请求发送到该网址。

目前，Directory API 支持针对 Users 资源的更改发送通知。

创建通知渠道

如需请求推送通知，您必须为要监控的每个资源设置通知渠道。设置通知渠道后，Directory API 会在任何受监视资源发生变化时通知您的应用。

发出观看请求

每个可监控的 Directory API 资源都有一个关联的 watch 方法，其 URI 的格式如下：

https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch

如需为有关特定资源更改的消息设置通知渠道，请向相应资源的 watch 方法发送 POST 请求。

每个通知渠道都与特定用户和特定资源（或一组资源）相关联。除非当前用户或服务账号拥有此资源或有权访问此资源，否则 watch 请求将不会成功。

示例

针对单个网域的 User 资源的所有监控请求都采用以下通用格式：

POST https://admin.googleapis.com/admin/directory/v1/users/watch?domain=domain&event=event
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab", // Your channel ID.
  "type": "web_hook",
  "address": "https://mydomain.com/notifications", // Your receiving URL.
  ...
  "token": "target=myApp-myFilesChannelDest", // (Optional) Your channel token.
  "params": {
    "ttl": 3600 // (Optional) Your requested time-to-live for this channel.
  }
}

使用 domain 和 event 参数指定您希望接收通知的网域和事件类型。

针对客户的“User”资源的所有监控请求都采用以下通用格式：

POST https://admin.googleapis.com/admin/directory/users/v1/watch?customer=customer&event=event
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab", // Your channel ID.
  "type": "web_hook",
  "address": "https://mydomain.com/notifications", // Your receiving URL.
  ...
  "token": "target=myApp-myFilesChannelDest", // (Optional) Your channel token.
  "params": {
    "ttl": 3600 // (Optional) Your requested time-to-live for this channel.
  }
}

使用 customer 和 event 参数指定客户 Google 账号的唯一 ID，以及您希望接收通知的事件类型。

event 的可能值包括：

  • add：用户创建的事件
  • delete：用户删除事件
  • makeAdmin：用户管理员状态更改事件
  • undelete：用户取消删除事件
  • update：用户更新了事件

注意：以下示例省略了请求正文，以便于理解。

监控网域 mydomain.com 的用户创建事件：

POST https://admin.googleapis.com/admin/directory/v1/users/watch?domain=mydomain.com&event=add

监控客户 my_customer 的用户创建事件：

POST https://admin.googleapis.com/admin/directory/v1/users/watch?customer=my_customer&event=add

必要属性

在每个 watch 请求中，您都必须提供以下字段：

  • 一个 id 属性字符串，用于唯一标识项目中的此新通知渠道。我们建议您使用通用唯一标识符 (UUID) 或任何类似的唯一字符串。长度上限：64 个字符。

    您设置的 ID 值会在您收到的每个此渠道通知消息的 X-Goog-Channel-Id HTTP 标头中回传。

  • 设置为值 web_hook 的 type 属性字符串。

  • 一个 address 属性字符串，设置为监听并响应此通知渠道的通知的网址。这是您的 webhook 回调网址，必须使用 HTTPS。

    请注意，只有在您的网站服务器上安装了有效的 SSL 证书时，Directory API 才能向此 HTTPS 地址发送通知。无效的证书包括：

    • 自签发证书
    • 由不受信任的来源签发的证书
    • 已被撤消的证书
    • 证书的主题与目标主机名不匹配。

可选属性

您还可以通过 watch 请求指定以下可选字段：

  • token 属性，用于指定要用作频道令牌的任意字符串值。您可以将通知渠道令牌用于多种用途。例如，您可以使用令牌验证每个传入消息是否适用于您的应用创建的渠道（以确保通知未被伪造），或者根据此渠道的用途将消息路由到应用内的正确目的地。长度上限： 256 个字符。

    该令牌包含在您的应用针对此频道收到的每条通知消息的 X-Goog-Channel-Token HTTP 标头中。

    如果您使用通知渠道令牌，我们建议您：

    • 使用可扩展的编码格式，例如网址查询参数。示例：forwardTo=hr&createdBy=mobile

    • 请勿包含 OAuth 令牌等敏感数据。

  • 一个 expiration 属性字符串，设置为您希望 Directory API 停止为此通知渠道发送消息的日期和时间的 Unix 时间戳（以毫秒为单位）。

    如果某个渠道具有到期时间，则该时间会作为 X-Goog-Channel-Expiration HTTP 标头的值（采用人类可读格式）包含在您的应用针对此渠道收到的每条通知消息中。

如需详细了解该请求，请参阅 API 参考文档中 Users 资源的 watch 方法。

观看回复

如果 watch 请求成功创建通知渠道，则会返回 HTTP 200 OK 状态代码。

监视器响应的正文会提供有关您刚刚创建的通知渠道的信息，如以下示例所示。

{
  "kind": "api#channel",
  "id": "01234567-89ab-cdef-0123456789ab", // ID you specified for this channel.
  "resourceId": "B4ibMJiIhTjAQd7Ff2K2bexk8G4", // ID of the watched resource.
  "resourceUri": "https://admin.googleapis.com/admin/directory/v1/users?domain=domain&event=event", // Version-specific ID of the watched resource.
  "token": "target=myApp-myFilesChannelDest", // Present only if one was provided.
  "expiration": 1384823632000, // Actual expiration time as Unix timestamp (in ms), if applicable.
}

除了您在请求中发送的属性之外，返回的信息还包含 resourceId 和 resourceUri，用于标识在此通知渠道上正在监控的资源。

您可以将返回的信息传递给其他通知渠道操作，例如当您想停止接收通知时。

如需详细了解响应，请参阅 API 参考文档中 Users 资源的 watch 方法。

同步消息

创建用于监控资源的通知渠道后，Directory API 会发送 sync 消息，以指示通知即将开始。这些消息的 X-Goog-Resource-State HTTP 标头值为 sync。由于网络时间问题，您甚至可能在收到 watch 方法响应之前就收到 sync 消息。

您可以放心地忽略 sync 通知，但也可以使用它。例如，如果您决定不想保留该渠道，可以在调用中使用 X-Goog-Channel-ID 和 X-Goog-Resource-ID 值来停止接收通知。您还可以使用 sync 通知执行一些初始化操作，为后续事件做好准备。

Directory API 发送到接收网址的 sync 消息的格式如下所示。

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

同步消息的 X-Goog-Message-Number HTTP 标头值始终为 1。此渠道的每个后续通知的消息编号都比上一个消息编号大，但消息编号不会是顺序的。

续订通知渠道

通知渠道可以具有到期时间，其值由您的请求或任何 Directory API 内部限制或默认值（使用更严格的值）决定。watch 方法返回的信息中会包含频道的失效时间（如果有）作为 Unix 时间戳（以毫秒为单位）。此外，您的应用针对此渠道收到的每个通知消息的 X-Goog-Channel-Expiration HTTP 标头中都会包含到期日期和时间（以人类可读的格式）。

目前，没有自动续订通知渠道的方法。当某个渠道即将过期时，您必须调用 watch 方法将其替换为新渠道。一如既往，您必须为新渠道的 id 属性使用不重复的值。请注意，当同一资源的两个通知渠道都处于活跃状态时，可能会出现“重叠”时间段。

接收通知

每当被监控的资源发生变化时，您的应用都会收到一条描述相应更改的通知消息。Directory API 会将这些消息作为 HTTPS POST 请求发送到您为此通知渠道指定的 address 属性网址。

解读通知消息格式

所有通知消息都包含一组带有 X-Goog- 前缀的 HTTP 标头。 某些类型的通知还可以包含消息正文。

标头

Directory API 向您的接收网址发布的通知消息包含以下 HTTP 标头：

标题 说明
始终存在
X-Goog-Channel-ID 您提供的用于标识此通知渠道的 UUID 或其他唯一字符串。
X-Goog-Message-Number 用于标识此通知渠道中此消息的整数。对于 sync 消息，值始终为 1。频道上的每条后续消息都会增加消息编号，但这些编号并非顺序编号。
X-Goog-Resource-ID 用于标识所监控资源的不透明值。此 ID 在各个 API 版本中保持稳定。
X-Goog-Resource-State 触发通知的新资源状态。 可能的值：sync 或事件名称。
X-Goog-Resource-URI 所监控资源的 API 版本专用标识符。
有时存在
X-Goog-Channel-Expiration 通知渠道到期日期和时间，采用人类可读的格式。仅在定义的情况下才会存在。
X-Goog-Channel-Token 由您的应用设置的通知渠道令牌，可用于验证通知来源。仅在定义的情况下才存在。

面向用户的通知消息在请求正文中包含以下信息：

属性 说明
kind 将其标识为用户资源。值：固定字符串“admin#directory#user”。
id 用户资源的唯一标识符。
etag 通知消息的 ETag。不同于“User”资源的 ETag。
primaryEmail 用户的主电子邮件地址。

示例

User 资源事件的通知消息采用以下一般格式：

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: directoryApiId
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 29 Oct 2013 20:32:02 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: 'https://admin.googleapis.com/admin/directory/v1/users?domain=domain&event=event
X-Goog-Resource-State:  event
X-Goog-Message-Number: 10

{
  "kind": "admin#directory#user",
  "id": long,
  "etag": string,
  "primaryEmail": string
}

用户删除的活动示例：

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 189
X-Goog-Channel-ID: deleteChannel
X-Goog-Channel-Token: 245t1234tt83trrt333
X-Goog-Channel-Expiration: Mon, 09 Dec 2013 22:24:23 GMT
X-Goog-Resource-ID:  B4ibMJiIhTjAQd7Ff2K2bexk8G4
X-Goog-Resource-URI: https://admin.googleapis.com/admin/directory/v1/users?domain=mydomain.com&event=delete&alt=json
X-Goog-Resource-State:  delete
X-Goog-Message-Number: 236440

{
  "kind": "admin#directory#user",
  "id": "111220860655841818702",
  "etag": "\"Mf8RAmnABsVfQ47MMT_18MHAdRE/evLIDlz2Fd9zbAqwvIp7Pzq8UAw\"",
  "primaryEmail": "user@mydomain.com"
}

有关通知的操作

如需指示成功，您可以返回以下任一状态代码：200、201、202、204 或 102。

如果您的服务使用 Google 的 API 客户端库并返回 500、502、503 或 504，则目录 API 会采用指数退避进行重试。 所有其他返回状态代码均被视为消息传送失败。

停止通知

expiration 属性用于控制何时自动停止显示通知。您可以选择在特定渠道过期之前停止接收该渠道的通知，方法是调用以下 URI 中的 stop 方法：

https://www.googleapis.com/admin/directory_v1/channels/stop

此方法要求您至少提供渠道的 id 和 resourceId 属性，如以下示例所示。请注意，如果 Directory API 有多个具有 watch 方法的资源类型，则只有一个 stop 方法。

只有拥有适当权限的用户才能停止频道。具体而言：

  • 如果渠道是由常规用户账号创建的，则只有创建渠道的同一客户端（由身份验证令牌中的 OAuth 2.0 客户端 ID 标识）中的同一用户才能停止该渠道。
  • 如果频道是由服务账号创建的，则同一客户端中的任何用户都可以停止该频道。

以下代码示例展示了如何停止接收通知：

POST https://www.googleapis.com/admin/directory_v1/channels/stop
  
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a66",
  "resourceId": "ret08u3rv24htgh289g"
}