Method: courses.aliases.list

Bir kursun takma adlarının listesini döndürür.

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

  • PERMISSION_DENIED ise istek gönderen kullanıcının kursa erişmesine izin verilmez veya erişim hataları yaşanır.
  • Kurs mevcut değilse NOT_FOUND.

HTTP isteği

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

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

Yol parametreleri

Parametreler
courseId

string

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

Sorgu parametreleri

Parametreler
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

Kurs takma adlarını listelemede verilen yanıt.

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

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

object (CourseAlias)

Kurs takma adları.
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.