Method: courses.courseWorkMaterials.getAddOnContext

Mendapatkan metadata untuk add-on Classroom dalam konteks postingan tertentu.

Untuk mempertahankan integritas data dan model izinnya sendiri, add-on harus memanggilnya 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 salah format.
  • NOT_FOUND jika salah satu resource yang diidentifikasi tidak ada.

Permintaan HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
courseId

string

Wajib. ID kursus.
itemId

string

ID pengumuman, courseWork, atau courseWorkMaterial tempat lampiran dilampirkan. Kolom ini wajib ada, tetapi tidak ditandai saat kami bermigrasi dari postId.

Parameter kueri

Parameter
addOnToken

string

Opsional. Token yang mengizinkan permintaan.

Token diteruskan sebagai parameter kueri saat pengguna dialihkan dari Classroom ke URL add-on.

Token otorisasi diperlukan jika tidak satu pun hal berikut berlaku:

  • Add-on memiliki lampiran di postingan.
  • Project developer yang mengajukan permintaan adalah project yang sama dengan yang membuat postingan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan berisi 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.