Method: registrations.create

Registration を作成します。これにより、Classroom は指定された feed から cloudPubSubTopic で指定された宛先への通知の送信を開始します。

作成された Registration を返します。現時点では、これは引数と同じですが、サーバーによって割り当てられたフィールド（expiryTime や id など）が入力されます。

expiryTime または id フィールドに指定された値は無視されます。

Classroom は cloudPubSubTopic を検証し、ベスト エフォート ベースでエラーを返すことがありますが、その存在と Classroom に公開する権限があることを確認する責任は呼び出し元にあります。

このメソッドは、次のエラーコードを返すことがあります。

  • 次の場合は PERMISSION_DENIED。
    • 認証済みユーザーに、リクエストされたフィールドから通知を受け取る権限がない。
    • 現在のユーザーが、リクエストされたフィードに適したスコープのアクセス権を現在の Cloud プロジェクトに付与していない。現在、この目的のためにドメイン全体の権限の委任はサポートされていません。リクエストに適切なスコープが設定されていても、権限が付与されていない場合は、[リクエスト エラー][@MissingGrant エラー] が返されます。
    • 別のアクセスエラーが発生します。
  • 次の場合は INVALID_ARGUMENT。
    • cloudPubsubTopic が指定されていないか、指定された cloudPubsubTopic が無効です。
    • feed が指定されていないか、指定された feed が無効です。
  • 次の場合は NOT_FOUND。
    • 指定された feed が見つからないか、要求したユーザーに、その存在の有無を判断する権限がありません。
    • 指定した cloudPubsubTopic が見つからないか、Classroom への公開権限が Classroom に付与されていません。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

リクエスト本文

リクエストの本文には Registration のインスタンスが含まれています。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された Registration のインスタンスが含まれます。

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、承認ガイドをご覧ください。