Are your users using Classroom with Google Meet? Check out the Apps Script quickstart covering how to check student attendance in Google Meet courses.

Method: userProfiles.guardians.list

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

Para enumerar los tutores de cualquier estudiante cuyos tutores pueda ver el usuario solicitante, use el carácter literal - para la identificación del estudiante.

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

  • PERMISSION_DENIED si se especifica un studentId . de estudiante y el usuario solicitante no tiene permiso para ver la información del tutor de ese estudiante, si se especifica "-" como studentId . de estudiante y el usuario no es un administrador de dominio, si los tutores no están habilitados para el dominio en cuestión , si el filtro invitedEmailAddress está configurado por un usuario que no es administrador del dominio, o por otros errores de acceso .
  • INVALID_ARGUMENT si se especifica un studentId de estudiante, pero no se puede reconocer su formato (no es una dirección de correo electrónico, ni un studentId de estudiante de la API, ni la cadena literal me ). También se puede devolver si se proporciona un pageToken de página no válido.
  • NOT_FOUND si se especifica un studentId de estudiante 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 transcodificación de gRPC .

Parámetros de ruta

Parámetros
studentId

string

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

  • el identificador numérico para el usuario
  • la dirección de correo electrónico del usuario
  • el literal de cadena "me" , que indica el usuario solicitante
  • el literal de cadena "-" , que indica que los resultados deben devolverse para todos los estudiantes a los que el usuario solicitante tiene acceso para ver.

Parámetros de consulta

Parámetros
invitedEmailAddress

string

Filtre 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 enlace de tutor. Este filtro solo lo pueden usar los administradores de dominio.

pageToken

string

nextPageToken valor devuelto de una llamada de list anterior, lo que indica que se debe devolver la página de resultados posterior.

La solicitud de list debe ser, por lo demás, idéntica a la que dio como resultado este token.

pageSize

integer

Número máximo de artículos a devolver. Cero o no especificado indica que el servidor puede asignar un máximo.

El servidor puede devolver un número de resultados inferior al especificado.

cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de respuesta

Si tiene éxito, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Respuesta al listar tutores.

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 siguiente página de resultados a devolver. Si está vacío, no hay más resultados disponibles.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos 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, consulte la Descripción general de OAuth 2.0 .