Method: registrations.create

创建 Registration,这会导致 Google 课堂开始将提供的 feed 的通知发送到 cloudPubSubTopic 中提供的目的地。

返回已创建的 Registration。目前,这与实参相同,但会填充服务器分配的字段,例如 expiryTimeid

请注意,为 expiryTimeid 字段指定的任何值都将被忽略。

尽管 Google 课堂可能会尽最大努力验证 cloudPubSubTopic 并返回错误,但调用方有责任确保其存在,并且 Google 课堂有权发布该文件。

此方法可能会返回以下错误代码:

  • PERMISSION_DENIED,如果出现以下情况:
    • 经过身份验证的用户无权从所请求的字段接收通知;或者
    • 当前用户未针对所请求的 Feed 为当前 Cloud 项目授予了适当范围的访问权限。请注意,目前不支持全网域授权功能。如果请求具有适当的范围,但不存在授权,系统会返回 [请求错误][@MissingGrant 错误]。
    • 又遇到了一个访问错误
  • INVALID_ARGUMENT,如果出现以下情况:
    • 未指定 cloudPubsubTopic,或指定的 cloudPubsubTopic 无效;或者
    • 未指定 feed 或指定的 feed 无效。
  • NOT_FOUND,如果出现以下情况:
    • 找不到指定的 feed,或者发出请求的用户无权确定是否存在;或者
    • 找不到指定的 cloudPubsubTopic,或已授权 Google 课堂发布内容。

HTTP 请求

POST https://classroom.googleapis.com/v1/registrations

网址采用 gRPC 转码语法。

请求正文

请求正文包含一个 Registration 实例。

响应正文

如果成功,响应正文将包含一个新创建的 Registration 实例。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/classroom.push-notifications

如需了解详情,请参阅授权指南