Google Classroom add-ons are now generally available to developers! Please see the
add-ons documentation for more information.
Method: courses.checkAddOnCreationEligibility
Stay organized with collections
Save and categorize content based on your preferences.
Returns whether a user is eligible to create add-on attachments in a given course.
This method is deprecated. Use UserProfiles.checkUserCapability
This method returns the following error codes:
PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors.INVALID_ARGUMENT if the request is malformed.NOT_FOUND if the requested course does not exist.
HTTP request
GET https://classroom.googleapis.com/v1/courses/{courseId}:checkAddOnCreationEligibility
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
courseId |
string
Required. Identifier of the course.
|
Request body
The request body must be empty.
Response body
Whether a teacher user is allowed to create add-on attachments for a given course.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"courseId": string,
"isCreateAttachmentEligible": boolean
} |
| Fields |
courseId |
string
Immutable. Identifier of the course.
|
isCreateAttachmentEligible |
boolean
Whether the teacher is allowed to create add-on attachments in this course.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/classroom.addons.teacher
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-17 UTC.
[null,null,["Last updated 2025-04-17 UTC."],[],[],null,["# Method: courses.checkAddOnCreationEligibility\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CheckAddOnCreationEligibilityResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\n| This item is deprecated!\nReturns whether a user is eligible to create add-on attachments in a given course.\n\nThis method is deprecated. Use [`UserProfiles.checkUserCapability`](/workspace/classroom/reference/rest/v1/userProfiles/checkUserCapability#body.PATH_PARAMETERS.user_id) instead.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if the requested course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}:checkAddOnCreationEligibility`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|----------------------------------------------|\n| `courseId` | `string` Required. Identifier of the course. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nWhether a teacher user is allowed to create add-on attachments for a given course.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------|\n| ``` { \"courseId\": string, \"isCreateAttachmentEligible\": boolean } ``` |\n\n| Fields ||\n|------------------------------|---------------------------------------------------------------------------------------|\n| `courseId` | `string` Immutable. Identifier of the course. |\n| `isCreateAttachmentEligible` | `boolean` Whether the teacher is allowed to create add-on attachments in this course. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.addons.teacher`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
