Method: courses.list

İstekte bulunan kullanıcının görüntülemesine izin verilen kursların listesini, istekle eşleşen kurslarla sınırlı olacak şekilde döndürür. Geri verilen kurslar, oluşturulma zamanına göre sıralanır. En yeni oluşturulan kurslar ilk sırada 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 bozuksa INVALID_ARGUMENT.
  • Sorgu bağımsız değişkenlerinde belirtilen kullanıcı 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

Döndürülen dersleri, belirtilen tanımlayıcıya sahip bir öğrencinin bulunduğu 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ı belirten dize değişmez değeri ("me")
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ı belirten dize değişmez değeri ("me")
courseStates[]

enum (CourseState)

Döndürülen kursları belirtilen durumlardan birindekilerle kısıtlar. Varsayılan değer: ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize

integer

İade edilecek maksimum öğe sayısı. Sıfır veya belirtilmedi olarak, sunucunun maksimum değer atayabileceğini gösterir.

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

string

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

Aksi takdirde, list isteği, bu jetonu sağlayan istekle aynı olmalıdır.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Kurslar listelenirken yanıt alın.

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

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ılavuzunu inceleyin.