Method: invitations.list

リクエスト元のユーザーが表示を許可されている招待状のリストを返します。リスト リクエストに一致する招待状のみが返されます。

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

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
userId

string

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

  • ユーザーの数字 ID
  • お客様のメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"
courseId

string

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

integer

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

サーバーが指定した結果数よりも少ない結果を返すことがあります。
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

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