Dodatki do Google Classroom są teraz ogólnie dostępne dla programistów. Więcej informacji znajdziesz w
dokumentacji dodatków.
Method: courses.courseWork.getAddOnContext
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Pobiera metadane dodatków do Classroom w kontekście konkretnego posta.
Aby zachować integralność własnych danych i modelu uprawnień, wtyczka powinna wywoływać tę funkcję w celu sprawdzania parametrów zapytania i roli użytkownika przesyłającego żądanie, gdykolwiek wtyczka jest otwierana w iframe.
Ta metoda zwraca te kody błędów:
PERMISSION_DENIED w przypadku błędów dostępu.INVALID_ARGUMENT jeśli żądanie ma nieprawidłowy format.NOT_FOUND jeśli jeden z identyfikowanych zasobów nie istnieje.
Żądanie HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Adres URL używa składni transkodowania gRPC.
Parametry ścieżki
| Parametry |
courseId |
string
Wymagane. Identyfikator kursu.
|
itemId |
string
Identyfikator Announcement, CourseWork lub CourseWorkMaterial, pod którym załącznik jest załączony. To pole jest wymagane, ale nie jest oznaczone jako takie podczas migracji z postId.
|
Parametry zapytania
| Parametry |
postId
(deprecated) |
string
Opcjonalnie. Wycofane. Zamiast tego używaj zasady itemId.
|
addOnToken |
string
Opcjonalnie. Token autoryzujący żądanie. Token jest przekazywany jako parametr zapytania, gdy użytkownik jest przekierowywany z Classroom do adresu URL dodatku. Token autoryzacji jest wymagany, gdy nie jest spełniony żaden z tych warunków:
- Dodatek zawiera załączniki w poście.
- Projekt dewelopera, który wysyła żądanie, to ten sam projekt, który utworzył wpis.
|
attachmentId |
string
Opcjonalnie. Identyfikator załącznika. To pole jest wymagane we wszystkich żądaniach, z wyjątkiem sytuacji, gdy użytkownik znajduje się w ramce iframe usługi Odkrywanie załączników.
|
Treść żądania
Treść żądania musi być pusta.
Treść odpowiedzi
W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu AddOnContext.
Zakresy autoryzacji
Wymaga jednego z tych zakresów OAuth:
https://www.googleapis.com/auth/classroom.addons.student
https://www.googleapis.com/auth/classroom.addons.teacher
Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.
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-07-25 UTC.
[null,null,["Ostatnia aktualizacja: 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)."]]
