ユーザーが Classroom と Google Meet を使用している場合は、Google Meet コースの生徒の出席状況を確認する Apps Script クイックスタートをご覧ください。

Method: courses.aliases.list

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

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

コースの ID。この ID は、Classroom で割り当てられた ID または alias のいずれかです。

クエリ パラメータ

パラメータ
pageSize

integer

返されるアイテムの最大数。0 または未指定は、サーバーが最大値を割り当てる可能性があることを示します。

サーバーから返された結果の数が指定した数より少なくなる場合があります。

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

詳しくは、OAuth 2.0 の概要をご覧ください。