Method: invitations.list

Zwraca listę zaproszeń, które użytkownik wysyłający prośbę może wyświetlić, ograniczoną do tych, które pasują do żądania listy.

Uwaga: należy podać co najmniej jedną z tych właściwości: userId lub courseId. Można podać oba pola.

Ta metoda zwraca te kody błędów:

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
userId

string

Ogranicza liczbę zwróconych zaproszeń dla określonego użytkownika. Może to być jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika,
  • literał ciągu "me", który wskazuje użytkownika wysyłającego żądanie
courseId

string

Ogranicza zwrócone zaproszenia do tych osób na zajęcia o określonym identyfikatorze.
pageSize

integer

Maksymalna liczba produktów do zwrotu. Wartość domyślna to 500, jeśli nie określono inaczej lub 0.

Serwer może zwrócić mniej wyników niż określona liczba.
pageToken

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, co oznacza, że powinna zostać zwrócona kolejna strona wyników.

Żądanie list musi być identyczne z żądaniem, które spowodowało wygenerowanie tego tokena.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania listy zaproszeń.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "invitations": [
    {
      object (Invitation)
    }
  ],
  "nextPageToken": string
}
Pola
invitations[]

object (Invitation)

Zaproszenia pasujące do żądania wyświetlenia listy.
nextPageToken

string

Token określający następną stronę wyników do zwrócenia. Jeśli pole jest puste, nie są dostępne żadne dalsze wyniki.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.