Method: invitations.list

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

Not: userId veya courseId'ten 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

İade edilen davetiyeleri belirli bir kullanıcıya gönderilen davetiyelerle 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
courseId

string

Döndürülen davetleri, belirtilen tanımlayıcıya sahip bir kursa ait davetlerle kısıtlar.
pageSize

integer

Döndürülecek maksimum öğe sayısı. Belirtilmezse veya 0 ise varsayılan değer 500'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. 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

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.