Add-on Google Classroom kini tersedia secara umum untuk developer. Lihat
dokumentasi add-on untuk informasi selengkapnya.
Method: courses.courseWork.getAddOnContext
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Mendapatkan metadata untuk add-on Classroom dalam konteks postingan tertentu.
Untuk mempertahankan integritas data dan model izinnya sendiri, add-on harus memanggil ini untuk memvalidasi parameter kueri dan peran pengguna yang meminta setiap kali add-on dibuka di iframe.
Metode ini menampilkan kode error berikut:
PERMISSION_DENIED untuk error akses.INVALID_ARGUMENT jika permintaan memiliki format yang salah.NOT_FOUND jika salah satu resource yang diidentifikasi tidak ada.
Permintaan HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWork/{itemId}/addOnContext
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
| Parameter |
courseId |
string
Wajib. ID kursus.
|
itemId |
string
ID Announcement, CourseWork, atau CourseWorkMaterial tempat lampiran dilampirkan. Kolom ini wajib diisi, tetapi tidak ditandai demikian saat kami melakukan migrasi dari postId.
|
Parameter kueri
| Parameter |
postId
(deprecated) |
string
Opsional. Tidak digunakan lagi, sebagai gantinya gunakan itemId.
|
addOnToken |
string
Opsional. Token yang memberikan otorisasi pada permintaan. Token diteruskan sebagai parameter kueri saat pengguna dialihkan dari Classroom ke URL add-on. Token otorisasi diperlukan jika salah satu hal berikut tidak terpenuhi:
- Add-on memiliki lampiran di postingan.
- Project developer yang mengeluarkan permintaan adalah project yang sama dengan yang membuat postingan.
|
attachmentId |
string
Opsional. ID lampiran. Kolom ini diperlukan untuk semua permintaan, kecuali jika pengguna berada di iframe Penemuan Lampiran.
|
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat instance AddOnContext.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/classroom.addons.student
https://www.googleapis.com/auth/classroom.addons.teacher
Untuk informasi selengkapnya, lihat Panduan otorisasi.
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-07-25 UTC.
[null,null,["Terakhir diperbarui pada 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)."]]
