Method: userProfiles.guardians.list

Devuelve una lista de tutores que el usuario solicitante puede ver, restringida a aquellos que coincidan con la solicitud.

Si quieres enumerar los tutores de cualquier estudiante para los que el usuario solicitante puede ver los tutores, usa el carácter literal - para el ID de estudiante.

Este método muestra los siguientes códigos de error:

  • PERMISSION_DENIED si se especifica un studentId y el usuario que realiza la solicitud no tiene permiso para ver la información del tutor de ese estudiante, si "-" se especifica como studentId y el usuario no es un administrador del dominio, si los tutores no están habilitados para el dominio en cuestión, si un usuario que no es administrador del dominio o por otros errores de acceso establece el filtro invitedEmailAddress.
  • INVALID_ARGUMENT si se especifica una studentId, pero no se puede reconocer su formato (no es una dirección de correo electrónico, ni una studentId de la API ni la string literal me). También se puede devolver si se proporciona un pageToken no válido.
  • NOT_FOUND si se especifica un studentId y se puede reconocer su formato, pero Classroom no tiene registro de ese estudiante.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
studentId

string

Filtra los resultados por el estudiante al que está vinculado el tutor. El identificador puede ser uno de los siguientes:

  • el identificador numérico del usuario
  • la dirección de correo electrónico del usuario
  • el literal de string "me", que indica el usuario solicitante
  • el literal de string "-", lo que indica que los resultados se deben mostrar a todos los estudiantes a los que el usuario solicitante tiene acceso de visualización.

Parámetros de consulta

Parámetros
invitedEmailAddress

string

Filtra los resultados por la dirección de correo electrónico a la que se envió la invitación original, lo que da como resultado este vínculo para tutores. Solo los administradores de dominio pueden utilizar este filtro.
pageToken

string

Es el valor de nextPageToken que se muestra desde una llamada a list anterior, lo que indica que se debe mostrar la página de resultados posterior.

La solicitud list debe ser idéntica a la que generó este token.
pageSize

integer

Cantidad máxima de elementos que se mostrarán. Cero o sin especificar indica que el servidor puede asignar un máximo.

Es posible que el servidor muestre menos resultados que la cantidad especificada.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Responder cuando se enumeren a los tutores.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "guardians": [
    {
      object (Guardian)
    }
  ],
  "nextPageToken": string
}
Campos
guardians[]

object (Guardian)

Tutores en esta página de resultados que cumplieron con los criterios especificados en la solicitud.
nextPageToken

string

Token que identifica la página siguiente de resultados que se mostrarán. Si está vacío, no habrá más resultados disponibles.

Alcances de autorización

Se necesita uno de los siguientes permisos de 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

Para obtener más información, consulta la Guía de autorización.