Method: userProfiles.guardianInvitations.create

保護者の招待状を作成し、保護者に生徒の保護者であることを確認するよう求めるメールを送信します。

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

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

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

  • PERMISSION_DENIED: 現在のユーザーに保護者の管理権限がない、該当する保護者がその生徒のリクエストをすでに拒否しすぎている、該当するドメインで保護者が有効になっていない場合、またはその他のアクセス エラーの場合。
  • RESOURCE_EXHAUSTED: 生徒または保護者が保護者リンクの上限を超えている場合。
  • INVALID_ARGUMENT: 保護者のメールアドレスが有効でない場合（長すぎる場合など）、または指定された生徒 ID の形式が認識できない場合（メールアドレスでも、この API の userId でもない場合）。このエラーは、読み取り専用フィールドが設定されている場合や、state フィールドが PENDING 以外の値に設定されている場合にも返されます。
  • NOT_FOUND: 指定された生徒 ID が有効な生徒 ID であるにもかかわらず、Classroom にその生徒の記録がない。
  • 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

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