Method: courses.list

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

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

  • PERMISSION_DENIED için erişim hataları.
  • INVALID_ARGUMENT sorgu bağımsız değişkeni yanlış biçimlendirilmişse
  • NOT_FOUND Sorgu bağımsız değişkenlerinde belirtilen kullanıcılardan herhangi biri mevcut değilse.

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

Döndürülen kursları, belirtilen tanımlayıcıya sahip bir öğrencinin bulunduğu kurslarla sınırlar. 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
  • İstekte bulunan kullanıcıyı belirten "me" dize değişmezi

Belirtilmesi durumunda teacherId boş olmalıdır.
teacherId

string

Döndürülen kursları, belirtilen tanımlayıcıya sahip bir öğretmeni olanlarla sınırlar. 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
  • İstekte bulunan kullanıcıyı belirten "me" dize değişmezi

Belirtilmesi durumunda studentId boş olmalıdır.
courseStates[]

enum (CourseState)

Döndürülen kursları belirtilen durumlardan birinde olanlarla sınırlar. Varsayılan değer ACTIVE, ARCHIVED, PROVISIONED, DECLINED'dır.
pageSize

integer

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

Sunucu, belirtilen sonuç sayısından daha az sonuç döndürebilir.
pageToken

string

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

list isteği, bu jetonla sonuçlanan istekle başka açılardan aynı olmalıdır.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

Kursları listelerken 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 kurslar.
nextPageToken

string

Döndürülecek sonuçların sonraki sayfasını tanımlayan jeton. Boşsa başka sonuç yok demektir.

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ılavuzu'na bakın.