Method: invitations.list

İstekte bulunan kullanıcının görüntülemesine izin verilen, liste isteğiyle eşleşen 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

Döndürülen davetiyeleri belirli bir kullanıcınınkilerle 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")
courseId

string

Belirtilen tanımlayıcıya sahip bir kurs için döndürülen davetiyeleri kısıtlar.
pageSize

integer

İade edilecek maksimum öğe sayısı. Belirtilmemişse varsayılan değer 500'dür veya 0'dir.

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

Davetiyeleri listelerken 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 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.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

Daha fazla bilgi için Yetkilendirme kılavuzunu inceleyin.