Method: userProfiles.guardianInvitations.create

保護者宛ての招待状を作成し、保護者宛てに、ご自身が生徒の保護者であることを確認するメールを送信します。

保護者が招待を承諾すると、state が COMPLETED に変わり、保護者への通知が届くようになります。アクティブな保護者を表す Guardian リソースも作成されます。

リクエスト オブジェクトには、studentId フィールドと invitedEmailAddress フィールドを設定する必要があります。これらのフィールドを設定しなかった場合、またはリクエストで他のフィールドを設定すると、エラーが発生します。

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

  • PERMISSION_DENIED: 現在のユーザーが保護者を管理する権限を持っていない場合、対象の保護者がすでにその生徒のリクエストを拒否しすぎている場合、対象のドメインに対して保護者が有効になっていない場合、またはその他のアクセスエラーが発生している場合。
  • RESOURCE_EXHAUSTED（生徒または保護者が保護者とのリンクできる上限を超えている場合）。
  • INVALID_ARGUMENT: 保護者のメールアドレスが有効でない（長すぎるなど）場合、または提供された学生 ID の形式を認識できない場合（メールアドレスでも、この API の userId でもありません）。このエラーは、読み取り専用フィールドが設定されている場合や、state フィールドが PENDING 以外の値に設定されている場合にも返されます。
  • 提供された学生 ID が有効な学生 ID であるにもかかわらず、Classroom にその生徒の記録がない場合は NOT_FOUND。
  • ALREADY_EXISTS（生徒と invitedEmailAddress が保留中の保護者からの招待がすでに存在している場合、または提供された invitedEmailAddress がこのユーザーの既存の Guardian の Google アカウントと一致している場合）。

HTTP リクエスト

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

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

パスパラメータ

パラメータ
guardianInvitation.studentId

string

生徒の ID（標準形式）

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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