Method: userProfiles.checkUserCapability

ユーザーが指定された Classroom 機能を使用できるかどうかを返します。たとえば、このエンドポイントを使用して、ユーザーがアドオン アタッチメントを作成できるかどうかを確認できます。

リクエストしたユーザーは、自分の権限のみを確認できます。

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

  • PERMISSION_DENIED: リクエストしたユーザーが、指定したユーザーの利用資格を確認できない場合。
  • INVALID_ARGUMENT: リクエストの形式が正しくない場合。

HTTP リクエスト

GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability

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

パスパラメータ

パラメータ
userId

string

必須。ユーザーの ID。

リクエストのパラメータとして指定する場合、この識別子は次のいずれかになります。

  • ユーザーの数値識別子
  • ユーザーのメールアドレス
  • リクエスト元のユーザーを示す文字列リテラル "me"

クエリ パラメータ

パラメータ
capability

enum (Capability)

必須。このユーザーに対してチェックされる機能。たとえば、ユーザーがアドオン アタッチメントを作成できるかどうかを確認するには、この値を CREATE_ADD_ON_ATTACHMENT に設定します。
previewVersion

enum (PreviewVersion)

省略可。API のプレビュー バージョン。

リクエスト本文

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

レスポンスの本文

ユーザー機能の確認に対するレスポンス。

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

JSON 表現 
{
  "capability": enum (Capability),
  "allowed": boolean
}
フィールド
capability

enum (Capability)

Classroom の機能。
allowed

boolean

指定された機能がユーザーに対して許可されているかどうか。

認可スコープ

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

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

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

能力

機能を表す列挙型。

列挙型
CAPABILITY_UNSPECIFIED サポートされていません。
CREATE_ADD_ON_ATTACHMENT リクエストに使用された OAuth クライアント ID の Developer Console プロジェクトに関連付けられた AddOnAttachment を作成および変更する機能。
UPDATE_GRADING_PERIOD_SETTINGS 採点期間の設定を変更する機能。