Method: courses.aliases.list

コースのエイリアスのリストを返します。

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

  • リクエスト元のユーザーにコースへのアクセスを許可されていない場合、またはアクセスエラーの場合は PERMISSION_DENIED。
  • コースが存在しない場合は NOT_FOUND。

HTTP リクエスト

GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases

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

パスパラメータ

パラメータ
courseId

string

コースの ID。この識別子は、Classroom によって割り当てられた識別子か alias のいずれかです。

クエリ パラメータ

パラメータ
pageSize

integer

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

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

string

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

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

リクエスト本文

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

レスポンスの本文

コースのエイリアスを一覧表示するときのレスポンス。

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

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

object (CourseAlias)

コースのエイリアス。
nextPageToken

string

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

認可スコープ

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

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

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