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 kurslar önce gelir.

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

  • PERMISSION_DENIED için erişim hataları.
  • INVALID_ARGUMENT değerini döndürür.
  • Sorgu bağımsız değişkenlerinde belirtilen kullanıcılar mevcut değilse 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 kursları, belirtilen tanımlayıcıya sahip bir öğrencisi olan kurslarla 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
  • İstekte bulunan kullanıcıyı belirten "me" değişmez dizesi
teacherId

string

Döndürülen kursları, belirtilen tanımlayıcıya sahip bir öğretmeni olan kurslarla sınırlandırır. 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" değişmez dizesi
courseStates[]

enum (CourseState)

Döndürülen kursları, belirtilen durumlardan birinde olan kurslarla kısıtlar. Varsayılan değer ACTIVE, ARCHIVED, PROVISIONED, DECLINED'dir.
pageSize

integer

Döndürülecek maksimum öğe sayısı. Sıfır veya belirtilmemiş, sunucunun maksimum bir 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. Sonuçların sonraki sayfasının döndürülmesi gerektiğini belirtir.

list isteği, bu jetonla sonuçlanan istekte belirtilenlerle aynı olmalıdır.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Kursları listelediğinizde 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 kurslar.
nextPageToken

string

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

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