Method: invitations.list

Muestra una lista de invitaciones que el usuario solicitante tiene permitido ver, restringida a las que coincidan con la solicitud de lista.

Nota: Se debe proporcionar, al menos, uno de los valores userId o courseId. Se pueden proporcionar ambos campos.

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

Solicitud HTTP

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

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

Parámetros de consulta

Parámetros
userId

string

Restringe las invitaciones que se muestran a un usuario específico. 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
courseId

string

Restringe las invitaciones devueltas a los cursos con el identificador especificado.
pageSize

integer

Cantidad máxima de elementos que se mostrarán. El valor predeterminado es 500 si no se especifica o es 0.

Es posible que el servidor muestre menos resultados que la cantidad especificada.
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.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Respuesta cuando se enumeran las invitaciones

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

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

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