Method: invitations.create

招待状を作成します。ユーザーとコースの招待は一度に 1 つのみ存在できます。変更を加えるには、招待状を削除して再作成します。

このメソッドは、次のエラーコードを返します。

  • PERMISSION_DENIED: リクエストしたユーザーにこのコースへの招待状を作成する権限がない場合、またはアクセス エラーの場合。
  • コースまたはユーザーが存在しない場合: NOT_FOUND
  • FAILED_PRECONDITION:
    • リクエストされたユーザーのアカウントが無効になっている場合。
    • ユーザーにこのロールまたはより大きな権限を持つロールがすでに割り当てられている場合。
    • 次のリクエスト エラーの場合:
      • IneligibleOwner
  • 指定されたユーザーとコースの招待がすでに存在する場合は ALREADY_EXISTS。

HTTP リクエスト

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

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

  • https://www.googleapis.com/auth/classroom.rosters

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