Method: courses.courseWork.getAddOnContext
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Получает метаданные для надстроек Класса в контексте определенного сообщения.
Чтобы поддерживать целостность своей собственной модели данных и разрешений, надстройка должна вызывать это для проверки параметров запроса и роли запрашивающего пользователя всякий раз, когда надстройка открывается в iframe .
Этот метод возвращает следующие коды ошибок:
-
PERMISSION_DENIED для ошибок доступа . -
INVALID_ARGUMENT , если запрос имеет неверный формат. -
NOT_FOUND , если один из идентифицированных ресурсов не существует.
HTTP-запрос
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
| Параметры |
|---|
courseId | string Необходимый. Идентификатор курса. |
itemId | string Идентификатор Announcement , CourseWork или CourseWorkMaterial , к которому прикреплено вложение. Это поле является обязательным, но не помечено как таковое при переходе с postId. |
Параметры запроса
| Параметры |
|---|
postId
(deprecated) | string Необязательный. Устарело, вместо этого используйте itemId . |
addOnToken | string Необязательный. Токен, авторизующий запрос. Токен передается в качестве параметра запроса, когда пользователь перенаправляется из Класса на URL-адрес надстройки. Токен авторизации требуется, если не выполняется ни одно из следующих условий: - Дополнение имеет вложения к сообщению.
- Проект разработчика, выдающий запрос, — это тот же проект, в котором было создано сообщение.
|
attachmentId | string Необязательный. Идентификатор вложения. Это поле является обязательным для всех запросов, за исключением случаев, когда пользователь находится в iframe обнаружения вложений . |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
В случае успеха тело ответа содержит экземпляр AddOnContext .
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/classroom.addons.student -
https://www.googleapis.com/auth/classroom.addons.teacher
Дополнительную информацию см. в руководстве по авторизации .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[],[],null,["# Method: courses.courseWork.getAddOnContext\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- [Authorization scopes](#body.aspect)\n\nGets metadata for Classroom add-ons in the context of a specific post.\n\nTo maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview).\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if one of the identified resources does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext`\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| `itemId` | `string` Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from postId. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `postId` **(deprecated)** | `string` Optional. Deprecated, use `itemId` instead. |\n| `addOnToken` | `string` Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: - The add-on has attachments on the post. - The developer project issuing the request is the same project that created the post. |\n| `attachmentId` | `string` Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [AddOnContext](/workspace/classroom/reference/rest/v1/AddOnContext).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.addons.student`\n- `\n https://www.googleapis.com/auth/classroom.addons.teacher`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
