Method: courses.courseWork.getAddOnContext

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
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.