Method: courses.studentGroups.list

Devuelve una lista de los grupos de un curso.

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

  • NOT_FOUND si el curso no existe.

Solicitud HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/studentGroups

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

Parámetros de ruta de acceso

Parámetros
courseId

string

Es obligatorio. Es el identificador del curso.

Parámetros de consulta

Parámetros
pageSize

integer

Es la cantidad máxima de elementos que se devolverán. Si se especifica cero o no se especifica, se indica que el servidor puede asignar un máximo, que actualmente está establecido en 75 elementos.

Es posible que el servidor devuelva menos resultados de los que se especificaron.
pageToken

string

Valor de nextPageToken que se devolvió de una llamada list anterior, lo que indica que se debe devolver la página siguiente de resultados.

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

enum (PreviewVersion)

Opcional. Es la versión preliminar de la API. Se debe configurar para acceder a las nuevas capacidades de la API que se ponen a disposición de los desarrolladores en el Programa de versión preliminar.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es la respuesta cuando se enumeran los grupos de estudiantes.

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

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

object (StudentGroup)

Son los grupos de estudiantes.
nextPageToken

string

Es un token que identifica la siguiente página de resultados que se devolverá. Si está vacío, no hay más resultados disponibles.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

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