Method: userProfiles.guardianInvitations.patch

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

現時点で有効な変更は、state を PENDING から COMPLETE に変更することです。これにより、招待が取り消されます。

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

  • PERMISSION_DENIED: 現在のユーザーに保護者を管理する権限がない場合、該当するドメインで保護者が有効になっていない場合、またはその他のアクセスエラーのため。
  • 保護者のリンクが PENDING の状態でない場合は FAILED_PRECONDITION。
  • 提供された学生 ID の形式を認識できない場合（メールアドレスでもこの API の userId でもない場合）、または渡された GuardianInvitation に COMPLETE 以外の state が含まれている場合、または state 以外のフィールドが変更された場合は、INVALID_ARGUMENT。
  • 提供された学生 ID が有効な学生 ID であるものの、Classroom にその生徒の記録がない場合、または id 項目が Classroom で認識されている保護者からの招待に対応していない場合は、NOT_FOUND。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
studentId

string

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

string

変更する GuardianInvitation の id フィールド。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

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

  • state

クエリ パラメータで設定する場合、このフィールドは次のように指定します。

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

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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