Method: courses.announcements.getAddOnContext

Belirli bir yayın bağlamında Classroom eklentilerinin meta verilerini alır.

Kendi veri ve izin modelinin bütünlüğünü korumak için eklenti, bir iframe içinde açıldığında sorgu parametrelerini ve istek gönderen kullanıcının rolünü doğrulamak üzere bu işlevi çağırmalıdır.

Bu yöntem aşağıdaki hata kodlarını döndürür:

  • PERMISSION_DENIED için erişim hataları.
  • INVALID_ARGUMENT ise istek yanlış biçimlendirilmiştir.
  • Tanımlanmış kaynaklardan biri mevcut değilse NOT_FOUND.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
courseId

string

Zorunlu. Dersin tanımlayıcısıdır.
itemId

string

Ekin eklenmiş olduğu Announcement, CourseWork veya CourseWorkMaterial öğesinin tanımlayıcısıdır. Bu alan zorunludur ancak postId'den taşınırken bu şekilde işaretlenmemiştir.

Sorgu parametreleri

Parametreler
addOnToken

string

İsteğe bağlı. İsteği yetkilendiren jeton.

Kullanıcı Classroom'dan eklentinin URL'sine yönlendirildiğinde jeton bir sorgu parametresi olarak iletilir.

Aşağıdakilerden hiçbiri doğru olmadığında yetkilendirme jetonu gereklidir:

  • Eklenti, yayında ek içeriyor.
  • İsteği gönderen geliştirici projesi, yayını oluşturan projeyle aynıdır.
attachmentId

string

İsteğe bağlı. Ekin tanımlayıcısıdır. Bu alan, kullanıcı Ek Keşfi iframe'inde olmadığı sürece tüm istekler için gereklidir.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, AddOnContext öğesinin bir örneğini içerir.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.