Method: registrations.create

Registration を作成すると、指定された 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 に公開する権限が付与されていない。

HTTP リクエスト

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

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。