Method: invitations.list

Zwraca listę zaproszeń, które użytkownik może wyświetlić, ograniczając się do tych, które pasują do żądania listy.

Uwaga: musisz 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 zwracane zaproszenia do zaproszeń wysłanych do konkretnego użytkownika. Identyfikator może być jednym z tych elementów:

  • identyfikator liczbowy użytkownika;
  • adres e-mail użytkownika.
  • ciąg znaków "me" wskazujący użytkownika, który wysłał żądanie;
courseId

string

Ogranicza zwracane zaproszenia do tych dotyczących kursu o określonym identyfikatorze.
pageSize

integer

Maksymalna liczba elementów do zwrócenia. Jeśli nie zostanie podana wartość, domyślnie zostanie użyta wartość 500 lub 0.

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

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, wskazująca, że należy zwrócić kolejną stronę wyników.

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania 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, które pasują do żądania listy;
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli jest puste, nie ma dostępnych dalszych wyników.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.