Method: userProfiles.guardians.list

リクエスト元のユーザーが閲覧を許可されている保護者のリストを、リクエストに一致する保護者に限定して返します。

リクエスト元のユーザーが保護者を表示できる可能性のあるすべての生徒の保護者を一覧表示するには、学生 ID にリテラル文字 - を使用します。

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

  • studentId が指定されており、"-"studentId に指定されていてユーザーがドメイン管理者でない場合、リクエスト元のユーザーにその生徒の保護者情報の閲覧を許可しない場合、対象のドメインで保護者が有効になっていない場合、ドメイン管理者以外のユーザーによって invitedEmailAddress フィルタが設定されている場合、またはその他のアクセスエラーの場合。PERMISSION_DENIED
  • INVALID_ARGUMENT studentId が指定されているが、その形式を認識できない場合(メールアドレスでも、API の studentId でも、リテラル文字列でもない)me。無効な pageToken が指定された場合も返されます。
  • studentId が指定されていて、その形式を認識できるにもかかわらず、Classroom にその生徒の記録がない場合、NOT_FOUND

HTTP リクエスト

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

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

パスパラメータ

パラメータ
studentId

string

保護者がリンクされている生徒で結果をフィルタします。ID は次のいずれかです。

  • ユーザーの数値 ID
  • ユーザーのメールアドレス
  • リクエストしているユーザーを示す文字列リテラル "me"
  • 文字列リテラル "-"。リクエストしているユーザーに閲覧権限があるすべての生徒について結果が返されることを示します。

クエリ パラメータ

パラメータ
invitedEmailAddress

string

元の招待状の送信先のメールアドレスで結果をフィルタして、この保護者のリンクを作成します。このフィルタを使用できるのはドメイン管理者のみです。

pageToken

string

前の list 呼び出しから返された nextPageToken 値。結果の後続のページを返す必要があることを示します。

他の点では、list リクエストは、このトークンを取得したリクエストと同じである必要があります。

pageSize

integer

返されるアイテムの最大数。ゼロまたは未指定の場合、サーバーが最大値を割り当て可能であることを示します。

サーバーから返される結果の数よりも少ない結果が返されることがあります。

リクエスト本文

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

レスポンスの本文

保護者を一覧表示する際のレスポンス。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
フィールド
guardians[]

object (Guardian)

リクエストで指定された条件を満たす結果のこのページの保護者。

nextPageToken

string

返される結果の次のページを識別するトークン。空の場合、それ以上の結果はありません。

認可スコープ

次の 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

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