Method: courses.announcements.list

Muestra una lista de los anuncios que el solicitante puede ver.

Los estudiantes del curso solo pueden ver los anuncios de PUBLISHED. Los profesores del curso y los administradores de dominios pueden ver todos los anuncios.

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

  • PERMISSION_DENIED si el usuario solicitante no tiene permiso para acceder al curso solicitado o por errores de acceso.
  • INVALID_ARGUMENT si la solicitud tiene un formato incorrecto.
  • NOT_FOUND si el curso solicitado no existe.

Solicitud HTTP

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

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

Parámetros de ruta de acceso

Parámetros
courseId

string

Es el identificador del curso. Este identificador puede ser el asignado por Classroom o un alias.

Parámetros de consulta

Parámetros
announcementStates[]

enum (AnnouncementState)

Restricción en el state de los anuncios que se muestran. Si no se especifica este argumento, el valor predeterminado es PUBLISHED.
orderBy

string

Es el orden de clasificación opcional para los resultados. Es una lista de campos separados por comas con una palabra clave opcional de dirección de ordenamiento. El campo compatible es updateTime. Las palabras clave de dirección admitidas son asc y desc. Si no se especifica, updateTime desc es el comportamiento predeterminado. Ejemplos: updateTime asc, updateTime
pageSize

integer

Es la cantidad máxima de elementos que se mostrarán. Cero o no especificado indica que el servidor puede asignar un máximo.

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 enumera el trabajo del curso

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

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

object (Announcement)

Elementos de anuncio que coinciden con la solicitud.
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.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

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