Method: userProfiles.guardians.get

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

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

  • PERMISSION_DENIED: 指定した studentId に一致するユーザーがリクエスト元のユーザーに表示されない場合、リクエストしているユーザーに studentId で特定される生徒の保護者情報の閲覧を許可しない場合、該当するドメインで保護者が有効になっていない場合、またはその他のアクセスエラーの場合。
  • studentId が指定されているが、その形式を認識できない場合（studentId でも、リテラル文字列 me でもない）、INVALID_ARGUMENT。
  • NOT_FOUND: リクエストしたユーザーに、リクエストされた studentId の保護者を表示する権限はありますが、指定した guardianId に一致するその生徒の Guardian レコードが存在しない場合。

HTTP リクエスト

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians/{guardianId}

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

パスパラメータ

パラメータ
studentId

string

保護者をリクエストしている生徒。次のいずれかになります。

  • ユーザーの数値 ID
  • ユーザーのメールアドレス
  • リクエストしているユーザーを示す文字列リテラル "me"
guardianId

string

Guardian の id フィールド。

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

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

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