Method: userProfiles.guardianInvitations.patch

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

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

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

  • PERMISSION_DENIED: 現在のユーザーに保護者の管理権限がない、該当するドメインで保護者が有効になっていない場合、またはその他のアクセス エラーの場合。
  • 保護者のリンクが PENDING 状態でない場合は FAILED_PRECONDITION です。
  • INVALID_ARGUMENT: 指定された学生 ID の形式が認識できない場合（メールアドレスでも、この API の userId でもない）、渡された GuardianInvitation に COMPLETE 以外の state が含まれている場合、または 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

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

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

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

  • state

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

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

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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