Method: userProfiles.guardianInvitations.get

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

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

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

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

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