List
|
|||||
|
|
||||
Returns the list of topics that the requester is permitted to view.
This method returns the following error codes:
PERMISSION_DENIEDif the requesting user is not permitted to access the requested course or for access errors.INVALID_ARGUMENTif the request is malformed.NOT_FOUNDif the requested course does not exist
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- See, create, and edit topics in Google Classroom
- View topics in Google Classroom
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
courseId Required |
STRING |
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias |
pageToken |
STRING |
nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token |
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 |
= Parameter name
= Format
|
courseId STRING Required Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias |
|
pageToken STRING nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token |
|
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 |
Output
This building block provides 6 output parameters
| Name | Format | Description |
|---|---|---|
nextPageToken |
STRING |
Token identifying the next page of results to return. If empty, no further results are available |
topic[] |
OBJECT |
Topic created by a teacher for the course |
topic[].name |
STRING |
The name of the topic, generated by the user. Leading and trailing whitespaces, if any, will be trimmed. Also, multiple consecutive whitespaces will be collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters |
topic[].topicId |
STRING |
Unique identifier for the topic. Read-only |
topic[].courseId |
STRING |
Identifier of the course. Read-only |
topic[].updateTime |
ANY |
The time the topic was last updated by the system. Read-only |
= Parameter name
= Format
|
nextPageToken STRING Token identifying the next page of results to return. If empty, no further results are available |
|
topic[] OBJECT Topic created by a teacher for the course |
|
topic[].name STRING The name of the topic, generated by the user. Leading and trailing whitespaces, if any, will be trimmed. Also, multiple consecutive whitespaces will be collapsed into one inside the name. The result must be a non-empty string. Topic names are case sensitive, and must be no longer than 100 characters |
|
topic[].topicId STRING Unique identifier for the topic. Read-only |
|
topic[].courseId STRING Identifier of the course. Read-only |
|
topic[].updateTime ANY The time the topic was last updated by the system. Read-only |