Method: userProfiles.guardians.get

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

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

  • PERMISSION_DENIED: 指定された studentId に一致するユーザーがリクエスト元のユーザーに表示されない、リクエスト元のユーザーが studentId で識別された生徒の保護者情報を表示できない、該当するドメインで保護者が有効になっていない場合、またはその他のアクセス エラーの場合。
  • INVALID_ARGUMENT: studentId が指定されているが、その形式が認識できない場合（メールアドレスでも、API の studentId でも、リテラル文字列 me でもない）。
  • 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

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