Method: courses.list

İstekte bulunan kullanıcının görüntülemesine izin verilen, istekle eşleşenlerle sınırlı derslerin listesini döndürür. Geri verilen kurslar, oluşturulma zamanına göre sıralanır. En son oluşturulan dersler en üstte yer alır.

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

  • Erişim hataları için PERMISSION_DENIED.
  • Sorgu bağımsız değişkeni hatalıysa INVALID_ARGUMENT.
  • Sorgu bağımsız değişkenlerinde belirtilen kullanıcılar yoksa NOT_FOUND.

HTTP isteği

GET https://classroom.googleapis.com/v1/courses

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

Sorgu parametreleri

Parametreler
studentId

string

Geri verilen dersleri, belirtilen tanımlayıcıya sahip öğrencisi olanlarla kısıtlar. Tanımlayıcı aşağıdakilerden biri olabilir:

  • kullanıcının sayısal tanımlayıcısı
  • kullanıcının e-posta adresi
  • istekte bulunan kullanıcıyı gösteren "me" dize değeri
teacherId

string

Döndürülen dersleri, belirtilen tanımlayıcıya sahip bir öğretmeni olan derslerle kısıtlar. Tanımlayıcı aşağıdakilerden biri olabilir:

  • kullanıcının sayısal tanımlayıcısı
  • kullanıcının e-posta adresi
  • istekte bulunan kullanıcıyı gösteren "me" dize değeri
courseStates[]

enum (CourseState)

Döndürülen dersleri, belirtilen durumlardan birinde olanlarla kısıtlar. Varsayılan değer ETKİN, ARŞİVLEND, SAĞLANDI, REDDEDİLDİ'dir.
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

Kurs listelenirken verilen yanıt.

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

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

object (Course)

Liste isteğiyle eşleşen dersler.
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.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

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