Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat
dokumentasi add-on untuk informasi selengkapnya.
Method: userProfiles.checkUserCapability
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
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 kemampuan untuk dirinya sendiri.
Metode ini menampilkan kode error berikut:
PERMISSION_DENIED jika pengguna yang meminta tidak diizinkan untuk memeriksa kelayakan pengguna tertentu.INVALID_ARGUMENT jika format permintaan 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 berikut ini:
- 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 ini 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.
|
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.
Kemampuan
Enum untuk merepresentasikan kemampuan.
| Enum |
CAPABILITY_UNSPECIFIED |
Tidak didukung. |
CREATE_ADD_ON_ATTACHMENT |
Kemampuan untuk membuat dan mengubah AddOnAttachment yang terkait dengan project Konsol Developer dari client ID OAuth yang digunakan untuk membuat permintaan. |
CREATE_RUBRIC |
Kemampuan untuk membuat dan mengubah Rubrik. |
UPDATE_GRADING_PERIOD_SETTINGS |
Kemampuan untuk mengubah setelan periode penilaian. |
CREATE_STUDENT_GROUP |
Kemampuan untuk membuat dan mengubah grup siswa dan anggotanya. |
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-08-06 UTC.
[null,null,["Terakhir diperbarui pada 2025-08-06 UTC."],[],[],null,["# Method: userProfiles.checkUserCapability\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CheckUserCapabilityResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Capability](#Capability)\n\n\u003cbr /\u003e\n\n| **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. This feature is available in [V1_20240930_PREVIEW](https://developers.google.com/workspace/classroom/reference/rest/v1/PreviewVersion) and later. See [Access Preview APIs](https://developers.google.com/workspace/classroom/reference/preview) to learn more.\nReturns whether a user may use the specified Classroom capability. For example, this endpoint can be used to check whether a user may create add- on attachments.\n\n\u003cbr /\u003e\n\nA requesting user can only check capabilities for themselves.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to check eligibility for the specified user.\n- `INVALID_ARGUMENT` if the request is malformed.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` Required. Identifier of the user. When specified as a parameter of a request, this identifier can be one of the following: - the numeric identifier for the user - the email address of the user - the string literal `\"me\"`, indicating the requesting user |\n\n### Query parameters\n\n| Parameters ||\n|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `capability` | `enum (`[Capability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability)`)` Required. The Capability that should be checked for this user. For example, to check whether a user can create an [add-on attachment](https://developers.google.com/workspace/classroom/reference/rest/v1/courses.courseWork.addOnAttachments#resource:-addonattachment), set this to `CREATE_ADD_ON_ATTACHMENT`. |\n| `previewVersion` | `enum (`[PreviewVersion](/workspace/classroom/reference/rest/v1/PreviewVersion)`)` Optional. The preview version of the API. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse from checking user capabilities.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"capability\": enum (/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability), \"allowed\": boolean } ``` |\n\n| Fields ||\n|--------------|---------------------------------------------------------------------------------------------------------------------------------------|\n| `capability` | `enum (`[Capability](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#Capability)`)` The Classroom capability. |\n| `allowed` | `boolean` Whether the specified capability is allowed for the user. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.courses`\n- `\n https://www.googleapis.com/auth/classroom.courses.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nCapability\n----------\n\nEnum to represent the capability.\n\n| Enums ||\n|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `CAPABILITY_UNSPECIFIED` | Not supported. |\n| `CREATE_ADD_ON_ATTACHMENT` | The capability to create and modify AddOnAttachments associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. |\n| `CREATE_RUBRIC` | The capability to create and modify Rubrics. |\n| `UPDATE_GRADING_PERIOD_SETTINGS` | The capability to modify grading period settings. |\n| `CREATE_STUDENT_GROUP` | The capability to create and modify student groups and their members. |"]]
