Method: userProfiles.guardianInvitations.list

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

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
studentId

string

保護者宛ての招待状を返す生徒の 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

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