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

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