Method: courses.announcements.list

İstekte bulunan kişinin görüntülemesine izin verilen duyuruların listesini döndürür.

Kurs öğrencileri yalnızca PUBLISHED duyurularını görüntüleyebilir. Kurs öğretmenleri ve alan yöneticileri tüm duyuruları görüntüleyebilir.

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

  • İstekte bulunan kullanıcının, istenen derse erişmesine izin verilmiyorsa veya erişim hataları varsa PERMISSION_DENIED.
  • İstek hatalıysa INVALID_ARGUMENT.
  • İstenen kurs mevcut değilse NOT_FOUND.

HTTP isteği

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

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

Yol parametreleri

Parametreler
courseId

string

Kursun tanımlayıcısı. Bu tanımlayıcı, Classroom tarafından atanan tanımlayıcı veya bir alias olabilir.

Sorgu parametreleri

Parametreler
announcementStates[]

enum (AnnouncementState)

Duyuruların state tanesiyle ilgili kısıtlama döndürüldü. Bu bağımsız değişken belirtilmeden bırakılırsa varsayılan değer PUBLISHED olur.

orderBy

string

Sonuçlar için isteğe bağlı sıralama düzeni. İsteğe bağlı bir sıralama yönü anahtar kelimesi içeren virgülle ayrılmış alan listesi. updateTime alanı desteklenir. Desteklenen yol tarifi anahtar kelimeleri: asc ve desc. Belirtilmezse varsayılan davranış updateTime desc olur. Örnekler: updateTime asc, updateTime

pageSize

integer

Döndürülecek maksimum öğe sayısı. Sıfır veya belirtilmedi, sunucunun bir maksimum değer atayabileceğini gösterir.

Sunucu, belirtilen sayıdan daha az sonuç döndürebilir.

pageToken

string

nextPageToken değeri, sonraki sonuç sayfasının döndürülmesi gerektiğini belirten önceki bir list çağrısından döndürüldü.

list isteği, aksi takdirde bu jetonla sonuçlanan istekle aynı olmalıdır.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Ders çalışması listelenirken verilen yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
Alanlar
announcements[]

object (Announcement)

İstekle eşleşen duyuru öğeleri.

nextPageToken

string

Döndürülecek bir sonraki sonuç sayfasını tanımlayan jeton. Boş bırakılırsa başka sonuç yok.

Yetkilendirme kapsamları

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

  • https://www.googleapis.com/auth/classroom.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

Daha fazla bilgi için Yetkilendirme kılavuzuna göz atın.