Method: userProfiles.guardians.list

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

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

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

  • PERMISSION_DENIED , если указан studentId , и запрашивающему пользователю не разрешено просматривать информацию об опекуне для этого студента, если в качестве studentId указано "-" , и пользователь не является администратором домена, если опекуны не включены для рассматриваемого домена , если фильтр invitedEmailAddress установлен пользователем, не являющимся администратором домена, или при других ошибках доступа .
  • INVALID_ARGUMENT если указан studentId , но его формат не может быть распознан (это не адрес электронной почты, не studentId из API и не литеральная строка me ). Также может быть возвращено, если указан недопустимый pageToken .
  • NOT_FOUND , если указан studentId и его формат можно распознать, но в Классе нет записей об этом студенте.

HTTP-запрос

GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians

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

Параметры пути

Параметры
studentId

string

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

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

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

Параметры
invitedEmailAddress

string

Отфильтруйте результаты по адресу электронной почты, на который было отправлено исходное приглашение, в результате чего появится эта контрольная ссылка. Этот фильтр могут использовать только администраторы домена.

pageToken

string

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

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

pageSize

integer

Максимальное количество товаров для возврата. Ноль или не указано означает, что сервер может назначить максимум.

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

Тело запроса

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

Тело ответа

Ответ при перечислении опекунов.

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

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

object ( Guardian )

Хранители на этой странице результатов, соответствующих критериям, указанным в запросе.

nextPageToken

string

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

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

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

  • https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly
  • https://www.googleapis.com/auth/classroom.guardianlinks.students

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