Method: courses.topics.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Renvoie la liste des sujets que l'utilisateur peut consulter.
Cette méthode renvoie les codes d'erreur suivants:
PERMISSION_DENIED
si l'utilisateur à l'origine de la demande n'est pas autorisé à accéder au cours demandé ou en cas d'erreurs d'accès.
INVALID_ARGUMENT
si la requête est incorrecte.
NOT_FOUND
si le cours demandé n'existe pas.
Requête HTTP
GET https://classroom.googleapis.com/v1/courses/{courseId}/topics
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres |
courseId |
string
Identifiant du cours. Cet identifiant peut être l'identifiant attribué par Classroom ou un alias .
|
Paramètres de requête
Paramètres |
pageSize |
integer
Nombre maximal d'éléments à renvoyer. Une valeur nulle ou non spécifiée indique que le serveur peut attribuer une valeur maximale. Le serveur peut renvoyer un nombre inférieur au nombre de résultats spécifié.
|
pageToken |
string
Valeur nextPageToken renvoyée par un appel list précédent, indiquant que la page de résultats suivante doit être renvoyée. La requête list doit être identique à celle qui a généré ce jeton.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse lors de la liste des sujets.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
{
"topic": [
{
object (Topic )
}
],
"nextPageToken": string
} |
Champs |
topic[] |
object (Topic )
Éléments de sujet correspondant à la requête.
|
nextPageToken |
string
Jeton identifiant la page de résultats suivante à renvoyer. Si ce champ est vide, aucun autre résultat n'est disponible.
|
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/classroom.topics.readonly
Pour en savoir plus, consultez le guide d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: courses.topics.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.ListTopicResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns the list of topics that the requester is permitted to view.\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}/topics`\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| `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.topics/list#body.ListTopicResponse.FIELDS.next_page_token) value returned from a previous [list](/workspace/classroom/reference/rest/v1/courses.topics/list#google.classroom.v1.Work.ListTopics) call, indicating that the subsequent page of results should be returned. The [list](/workspace/classroom/reference/rest/v1/courses.topics/list#google.classroom.v1.Work.ListTopics) 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 topics.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"topic\": [ { object (/workspace/classroom/reference/rest/v1/courses.topics#Topic) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------|\n| `topic[]` | `object (`[Topic](/workspace/classroom/reference/rest/v1/courses.topics#Topic)`)` Topic 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 the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.topics.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]