Method: invitations.list

Muestra 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 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 aquellas de 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 cadena "me", que indica el usuario solicitante
courseId

string

Restringe las invitaciones que se muestran a aquellas de un curso con el identificador especificado.
pageSize

integer

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

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

string

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

De lo contrario, 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 muestran invitaciones en la ficha.

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

Es un token que identifica la siguiente página de resultados que se mostrará. Si está vacío, significa que 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.