Method: invitations.list

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

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

Nota: Se debe proporcionar al menos uno de userId de usuario o courseId de curso. Se pueden proporcionar ambos campos.

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

Solicitud HTTP

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

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

Parámetros de consulta

Parámetros
userId

string

Restringe las invitaciones devueltas a las de un usuario específico. 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
courseId

string

Restringe las invitaciones devueltas a aquellas para un curso con el identificador especificado.

pageSize

integer

Número máximo de artículos a devolver. El valor predeterminado es 500 si no se especifica o 0 .

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

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.

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 invitaciones.

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

object ( Invitation )

Invitaciones que coinciden con la solicitud de lista.

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.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly

Para obtener más información, consulte la Descripción general de OAuth 2.0 .