Dodatki do Google Classroom są teraz ogólnie dostępne dla programistów. Więcej informacji znajdziesz w
dokumentacji dodatków.
Method: userProfiles.checkUserCapability
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Zwraca informację, czy użytkownik może korzystać z określonej funkcji Classroom. Możesz na przykład użyć tego punktu końcowego, aby sprawdzić, czy użytkownik może tworzyć załączniki dodatków.Użytkownik wysyłający prośbę może sprawdzić uprawnienia tylko dla siebie.
Ta metoda zwraca te kody błędów:
PERMISSION_DENIED jeśli użytkownik wysyłający żądanie nie ma uprawnień do sprawdzania uprawnień określonego użytkownika.INVALID_ARGUMENT, jeśli żądanie jest nieprawidłowo sformatowane.
Żądanie HTTP
GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
userId |
string
Wymagany. Identyfikator użytkownika. Jeśli ten identyfikator jest określony jako parametr żądania, może mieć jedną z tych wartości:
- identyfikator numeryczny użytkownika;
- adres e-mail użytkownika;
- ciąg literału
"me", który wskazuje użytkownika wysyłającego żądanie;
|
Parametry zapytania
| Parametry |
capability |
enum (Capability)
Wymagany. Funkcja, która powinna być sprawdzana w przypadku tego użytkownika. Aby na przykład sprawdzić, czy użytkownik może utworzyć załącznik dodatku, ustaw tę wartość na CREATE_ADD_ON_ATTACHMENT.
|
previewVersion |
enum (PreviewVersion)
Opcjonalnie. Wersja przedpremierowa interfejsu API.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
Odpowiedź z sprawdzania uprawnień użytkownika.
W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:
| Zapis JSON |
{
"capability": enum (Capability),
"allowed": boolean
} |
| Pola |
capability |
enum (Capability)
funkcja Classroom,
|
allowed |
boolean
Określa, czy określona funkcja jest dozwolona dla użytkownika.
|
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/classroom.courses
https://www.googleapis.com/auth/classroom.courses.readonly
Więcej informacji znajdziesz w przewodniku po autoryzacji.
Możliwości
Wyliczenie reprezentujące uprawnienia.
| Wartości w polu enum |
CAPABILITY_UNSPECIFIED |
Nieobsługiwane. |
CREATE_ADD_ON_ATTACHMENT |
Możliwość tworzenia i modyfikowania obiektów AddOnAttachment powiązanych z projektem w Developer Console, w którym znajduje się identyfikator klienta OAuth użyty do wysłania żądania. |
CREATE_RUBRIC |
Możliwość tworzenia i modyfikowania rubryk. |
UPDATE_GRADING_PERIOD_SETTINGS |
możliwość modyfikowania ustawień okresu oceniania; |
CREATE_STUDENT_GROUP |
możliwość tworzenia i modyfikowania grup uczniów oraz ich członków; |
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0, a fragmenty kodu są dostępne na licencji Apache 2.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-08-06 UTC.
[null,null,["Ostatnia aktualizacja: 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. |"]]
