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

Method: userProfiles.guardianInvitations.patch

保護者の招待を変更します。

現在、有効な唯一の変更は、statePENDING から COMPLETE に変更することです。これにより、招待が取り消されます。

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

  • PERMISSION_DENIED: 現在のドメインで保護者を管理する権限がない場合、対象のドメインで保護者が有効になっていないか、その他のアクセスエラーが発生しています。
  • FAILED_PRECONDITION: 保護者のリンクが PENDING 状態でない場合。
  • INVALID_ARGUMENT指定された学生証の形式を認識できない場合(メールアドレスでもuserIdまたは、GuardianInvitationにはstate以下を除くCOMPLETE、または、state
  • NOT_FOUND: 指定した生徒 ID が有効な生徒 ID であるにもかかわらず、その生徒の記録が Classroom にない場合、または id フィールドが Classroom で認識されている保護者宛の招待状を参照していない場合。

HTTP リクエスト

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

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

パスパラメータ

パラメータ
studentId

string

保護者の招待を変更する生徒の ID。

invitationId

string

変更する GuardianInvitationid フィールド。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

コースのどのフィールドを更新するかを識別するマスク。更新するには、このフィールドは必須です。無効なフィールドが指定されている場合、更新は失敗します。有効なフィールドは次のとおりです。

  • state

クエリ パラメータで設定する場合、このフィールドは

updateMask=<field1>,<field2>,...

完全修飾されたフィールド名のカンマ区切りリストです。(例: "user.displayName,photo")。

リクエストの本文

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

レスポンスの本文

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

認証スコープ

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

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

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