Method: userProfiles.guardianInvitations.list

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

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

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

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 値を持つ結果のみが返されます。それ以外の場合、statePENDING の結果が返されます。

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

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