Los complementos de Google Classroom ya están en fase de disponibilidad general para desarrolladores. Consulta la
documentación sobre complementos para obtener más información.
Method: courses.announcements.list
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
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.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[null,null,["Última actualización: 2025-07-25 (UTC)"],[],[],null,["# Method: courses.announcements.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAnnouncementsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `NOT_FOUND` if the requested course does not exist.\n\n### HTTP request\n\n`GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `courseId` | `string` Identifier of the course. This identifier can be either the Classroom-assigned identifier or an [alias](/workspace/classroom/reference/rest/v1/courses.aliases#CourseAlias). |\n\n### Query parameters\n\n| Parameters ||\n|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `announcementStates[]` | `enum (`[AnnouncementState](/workspace/classroom/reference/rest/v1/courses.announcements#AnnouncementState)`)` Restriction on the `state` of announcements returned. If this argument is left unspecified, the default value is `PUBLISHED`. |\n| `orderBy` | `string` Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime` |\n| `pageSize` | `integer` Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results. |\n| `pageToken` | `string` [nextPageToken](/workspace/classroom/reference/rest/v1/courses.announcements/list#body.ListAnnouncementsResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.announcements/list#google.classroom.v1.Work.ListAnnouncements) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.announcements/list#google.classroom.v1.Work.ListAnnouncements) request must be otherwise identical to the one that resulted in this token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse when listing course work.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"announcements\": [ { object (/workspace/classroom/reference/rest/v1/courses.announcements#Announcement) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `announcements[]` | `object (`[Announcement](/workspace/classroom/reference/rest/v1/courses.announcements#Announcement)`)` Announcement items that match the request. |\n| `nextPageToken` | `string` Token identifying the next page of results to return. If empty, no further results are available. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/classroom.announcements`\n- `\n https://www.googleapis.com/auth/classroom.announcements.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]