Method: courses.get

コースを返します。

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

  • リクエストしたユーザーがリクエストされたコースにアクセスできない場合、またはアクセス エラーが発生した場合の PERMISSION_DENIED。
  • リクエストされた ID のコースが存在しない場合は NOT_FOUND。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
id

string

返すコースの識別子。この識別子は、Classroom 割り当ての識別子または alias のいずれかです。

クエリ パラメータ

パラメータ
previewVersion

enum (PreviewVersion)

省略可。API のプレビュー バージョン。プレビュー プログラムでデベロッパーが利用できる新しい API 機能にアクセスするには、この設定を行う必要があります。

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文には Course のインスタンスが含まれます。

認可スコープ

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

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

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