Method: invitations.list

リクエスト元のユーザーに表示が許可されている招待のリストを返します。このリストは、リクエストされた招待に一致するものに限られます。

注: userId または courseId の少なくとも 1 つを指定する必要があります。どちらのフィールドも指定できます。

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

HTTP リクエスト

GET https://classroom.googleapis.com/v1/invitations

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

クエリ パラメータ

パラメータ
userId

string

返される招待状を特定のユーザーに限定します。ID は次のいずれかになります。

  • ユーザーの数値識別子
  • ユーザーのメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"
courseId

string

返される招待を、指定された ID を持つコースの招待状に限定します。
pageSize

integer

返されるアイテムの最大数。指定しない場合のデフォルトは 500、または 0 です。

サーバーが返す結果の数は、指定した数より少ないことがあります。
pageToken

string

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

それ以外の点では、list リクエストは、このトークンの生成元となったリクエストと同じである必要があります。

リクエスト本文

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

レスポンスの本文

招待をリストする際のレスポンス。

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

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

object (Invitation)

リストのリクエストに一致する招待。
nextPageToken

string

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

認可スコープ

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

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

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