Method: userProfiles.guardians.list

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

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

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

  • PERMISSION_DENIED: studentId が指定され、リクエスト元のユーザーがその生徒の保護者情報を表示できない場合、"-" が studentId として指定されていて、ユーザーがドメイン管理者でない場合、該当するドメインで保護者が有効になっていない場合、invitedEmailAddress フィルタがドメイン管理者以外のユーザーによって設定されている場合、またはその他のアクセスエラーの場合。
  • studentId が指定されているが、その形式を認識できない場合は INVALID_ARGUMENT です（メールアドレスでも、API の studentId でもなく、リテラル文字列 me でもない場合）。無効な pageToken が指定された場合にも返される可能性があります。
  • studentId が指定され、その形式を認識できる場合は NOT_FOUND ですが、Classroom にはその生徒の記録がありません。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
studentId

string

保護者がリンクされている生徒で結果をフィルタします。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

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