Method: userProfiles.guardianInvitations.list

リクエスト元のユーザーが表示を許可されている保護者の招待状のリストを、指定されたパラメータでフィルタして返します。

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
studentId

string

保護者の招待状を返却する生徒の ID。ID は次のいずれかです。

  • ユーザーの数字 ID
  • ユーザーのメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"
  • 文字列リテラル "-"。リクエスト元のユーザーが保護者の招待状を表示できるすべての生徒の結果を返す必要があることを示します。

クエリ パラメータ

パラメータ
invitedEmailAddress

string

指定した場合、指定された invitedEmailAddress を含む結果のみが返されます。
states[]

enum (GuardianInvitationState)

指定した場合、指定された state 値を持つ結果のみが返されます。それ以外の場合は、state が PENDING の結果が返されます。
pageToken

string

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

それ以外の場合は、list リクエストがこのトークンを生成したリクエストと同一である必要があります。
pageSize

integer

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

サーバーが指定した結果数よりも少ない結果を返すことがあります。

リクエスト本文

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

レスポンスの本文

保護者の招待状を一覧表示した場合のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

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

object (GuardianInvitation)

リスト リクエストに一致した保護者用招待状。
nextPageToken

string

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

認可スコープ

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

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

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