Method: courses.announcements.list

Devuelve una lista de anuncios que el solicitante puede ver.

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

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

  • Se utiliza PERMISSION_DENIED si el usuario que realizó la solicitud no tiene permiso para acceder al curso solicitado o si tiene errores de acceso.
  • Es INVALID_ARGUMENT si la solicitud no tiene el formato correcto.
  • 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 para el state de los anuncios que se muestran. Si no se especifica este argumento, el valor predeterminado es PUBLISHED.
orderBy

string

Orden de clasificación opcional de los resultados. Una lista de campos separados por comas con una palabra clave opcional de dirección de orden. El campo admitido 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

Cantidad máxima de elementos que se mostrarán. Cero o sin especificar indica que el servidor puede asignar un máximo.

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 al enumerar 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

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

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