リクエストしているユーザーに閲覧を許可する保護者のリストを返します。ただし、リクエストに一致する保護者に限定されます。
リクエスト元の保護者が閲覧できる生徒の保護者を一覧表示するには、生徒 ID にリテラル文字 -
を使用します。
このメソッドは、次のエラーコードを返します。
PERMISSION_DENIED
:studentId
が指定されていて、"-"
がstudentId
として指定されていて、ユーザーがドメイン管理者ではない場合に、リクエスト元のユーザーにその生徒の保護者情報の閲覧が許可されていない場合対象ドメインで保護者が有効になっていない場合、ドメイン管理者以外のユーザーがinvitedEmailAddress
フィルタを設定した場合、またはその他のアクセスエラーの場合。INVALID_ARGUMENT
:studentId
が指定されているが形式を認識できない場合(メールアドレス、API のstudentId
、リテラル文字列me
ではない場合)。無効なpageToken
が指定された場合にも返されることがあります。NOT_FOUND
:studentId
が指定され、その形式を認識できるが、Classroom にその生徒の記録がない場合。
HTTP リクエスト
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
studentId |
保護者がリンクしている生徒で検索結果を絞り込む。ID は次のいずれかです。
|
クエリ パラメータ
パラメータ | |
---|---|
invitedEmailAddress |
元の招待の送信先のメールアドレスで結果をフィルタして、この保護者へのリンクを生成します。このフィルタはドメイン管理者のみが使用できます。 |
pageToken |
前の それ以外の場合は、 |
pageSize |
返されるアイテムの最大数。0 または未指定は、サーバーが最大値を割り当てる可能性があることを示します。 サーバーから返された結果の数が指定した数より少なくなる場合があります。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
保護者をリストする際の回答
JSON 表現 |
---|
{
"guardians": [
{
object ( |
フィールド | |
---|---|
guardians[] |
このページの保護者が、リクエストで指定された条件を満たす結果ページ。 |
nextPageToken |
返される結果の次のページを識別するトークン。空の場合、これ以上の結果はありません。 |
認可スコープ
次の 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
詳しくは、OAuth 2.0 の概要をご覧ください。