コースのエイリアスのリストを返します。
このメソッドは、次のエラーコードを返します。
PERMISSION_DENIED
: リクエスト元のユーザーがコースへのアクセスを許可されていない場合、またはアクセスエラーのため。- コースが存在しない場合は
NOT_FOUND
。
HTTP リクエスト
GET https://classroom.googleapis.com/v1/courses/{courseId}/aliases
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
courseId |
コースの ID。この識別子は、Classroom で割り当てられた識別子または |
クエリ パラメータ
パラメータ | |
---|---|
pageSize |
返されるアイテムの最大数。ゼロまたは未指定の場合、サーバーが最大値を割り当て可能であることを示します。 サーバーから返される結果の数よりも少ない結果が返されることがあります。 |
pageToken |
前の 他の点では、 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
コースのエイリアスを一覧表示する場合のレスポンス。
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"aliases": [
{
object ( |
フィールド | |
---|---|
aliases[] |
コースのエイリアス。 |
nextPageToken |
返される結果の次のページを識別するトークン。空の場合、それ以上の結果はありません。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
詳細については、承認ガイドをご覧ください。