Method: userProfiles.checkUserCapability

Menampilkan apakah pengguna dapat menggunakan kemampuan Classroom yang ditentukan. Misalnya, endpoint ini dapat digunakan untuk memeriksa apakah pengguna dapat membuat lampiran add-on.

Pengguna yang meminta hanya dapat memeriksa kemampuannya sendiri.

Metode ini menampilkan kode error berikut:

  • PERMISSION_DENIED jika pengguna yang meminta tidak diizinkan untuk memeriksa kelayakan untuk pengguna yang ditentukan.
  • INVALID_ARGUMENT jika permintaan memiliki format yang salah.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
userId

string

Wajib. ID pengguna.

Jika ditentukan sebagai parameter permintaan, ID ini dapat berupa salah satu dari hal berikut:

  • ID numerik untuk pengguna
  • alamat email pengguna
  • literal string "me", yang menunjukkan pengguna yang meminta

Parameter kueri

Parameter
capability

enum (Capability)

Wajib. Kemampuan yang harus diperiksa untuk pengguna ini. Misalnya, untuk memeriksa apakah pengguna dapat membuat lampiran add-on, tetapkan ke CREATE_ADD_ON_ATTACHMENT.
previewVersion

enum (PreviewVersion)

Opsional. Versi pratinjau API.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons dari pemeriksaan kemampuan pengguna.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "capability": enum (Capability),
  "allowed": boolean
}
Kolom
capability

enum (Capability)

Kemampuan Classroom.
allowed

boolean

Apakah kemampuan yang ditentukan diizinkan untuk pengguna atau tidak.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.

Kemampuan

Enum untuk merepresentasikan kemampuan.

Enum
CAPABILITY_UNSPECIFIED Tidak didukung.
CREATE_ADD_ON_ATTACHMENT Kemampuan untuk membuat dan mengubah AddOnAttachments yang terkait dengan project Konsol Play dari client ID OAuth yang digunakan untuk membuat permintaan.
UPDATE_GRADING_PERIOD_SETTINGS Kemampuan untuk mengubah setelan periode penilaian.