Method: userProfiles.guardianInvitations.get

特定の保護者の招待状を返します。

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

  • PERMISSION_DENIED: リクエスト元のユーザーが studentId で識別された生徒の保護者招待状を表示することを許可されていない場合、該当するドメインで保護者が有効になっていない場合、またはその他のアクセス エラーの場合。
  • INVALID_ARGUMENT: studentId が指定されているが、その形式が認識できない場合（メールアドレスでも、API の studentId でも、リテラル文字列 me でもない）。
  • NOT_FOUND（指定した生徒の記録が Classroom で見つからない場合）または invitationId。生徒が存在する場合でも、リクエストしたユーザーにその生徒を表示する権限がない場合は、この値が返されることもあります。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
studentId

string

保護者の招待をリクエストしている生徒の ID。
invitationId

string

リクエストされた GuardianInvitation の id フィールド。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

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

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

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