Method: invitations.list

İstekte bulunan kullanıcının görüntülemesine izin verilen, liste isteğiyle eşleşenlerle sınırlı davetiyelerin listesini döndürür.

Not: userId veya courseId özelliklerinden en az biri sağlanmalıdır. Her iki alan da sağlanabilir.

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

HTTP isteği

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

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

Sorgu parametreleri

Parametreler
userId

string

Geri verilen davetiyeleri belirli bir kullanıcının davetleriyle 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
courseId

string

Geri verilen davetleri, belirtilen tanımlayıcıya sahip bir dersle ilgili davetlerle kısıtlar.
pageSize

integer

Döndürülecek maksimum öğe sayısı. Belirtilmemişse varsayılan değer 500 veya 0'dir.

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

Davetiyeler listelenirken verilen yanıt.

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

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

object (Invitation)

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

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