Method: invitations.list

Возвращает список приглашений, которые запрашивающему пользователю разрешено просматривать, ограниченный теми, которые соответствуют запросу списка.

Примечание. Необходимо указать хотя бы один userId или courseId . Оба поля могут быть заполнены.

Этот метод возвращает следующие коды ошибок:

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры запроса

Параметры
userId

string

Ограничивает возвращаемые приглашения приглашениями для конкретного пользователя. Идентификатор может быть одним из следующих:

  • числовой идентификатор пользователя
  • адрес электронной почты пользователя
  • строковый литерал "me" , указывающий запрашивающего пользователя
courseId

string

Ограничивает возвращаемые приглашения только приглашениями на курс с указанным идентификатором.

pageSize

integer

Максимальное количество товаров для возврата. Значение по умолчанию — 500, если не указано, или 0 .

Сервер может вернуть меньшее количество результатов, чем указано.

pageToken

string

Значение nextPageToken возвращенное из предыдущего вызова list , указывает, что должна быть возвращена следующая страница результатов.

В остальном запрос list должен быть идентичен тому, который привел к получению этого токена.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ при перечислении приглашений.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "invitations": [
    {
      object (Invitation)
    }
  ],
  "nextPageToken": string
}
Поля
invitations[]

object ( Invitation )

Приглашения, соответствующие запросу списка.

nextPageToken

string

Токен, идентифицирующий следующую страницу результатов, которую нужно вернуть. Если пусто, дальнейшие результаты недоступны.

Области авторизации

Требуется одна из следующих областей OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .