ユーザーが Classroom と Google Meet を使用している場合は、Google Meet コースの生徒の出席状況を確認する Apps Script クイックスタートをご覧ください。

Method: userProfiles.guardianInvitations.create

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

保護者が招待を承諾すると、保護者が stateCOMPLETED に変更し、保護者からの通知を受け取るようになります。アクティブな保護者を表す Guardian リソースも作成されます。

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

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

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

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

詳しくは、OAuth 2.0 の概要をご覧ください。