Skip to main content

topics

Overview

Nametopics
TypeResource
Idgoogleworkspace.classroom.topics

Fields

NameDatatypeDescription
namestringThe name of the topic, generated by the user. Leading and trailing whitespaces, if any, are trimmed. Also, multiple consecutive whitespaces are 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.
updateTimestringThe time the topic was last updated by the system. Read-only.
courseIdstringIdentifier of the course. Read-only.
topicIdstringUnique identifier for the topic. Read-only.

Methods

NameAccessible byRequired ParamsDescription
courses_topics_getSELECTcourseId, idReturns a topic. This method returns the following error codes: PERMISSION_DENIED if the requesting user is not permitted to access the requested course or topic, or for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or topic does not exist.
courses_topics_listSELECTcourseIdReturns the list of topics that the requester is permitted to view. This method returns the following error codes: PERMISSION_DENIED if the requesting user is not permitted to access the requested course or for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist.
courses_topics_createINSERTcourseIdCreates a topic. This method returns the following error codes: PERMISSION_DENIED if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course does not exist.
courses_topics_deleteDELETEcourseId, idDeletes a topic. This method returns the following error codes: PERMISSION_DENIED if the requesting user is not allowed to delete the requested topic or for access errors. FAILED_PRECONDITION if the requested topic has already been deleted. * NOT_FOUND if no course or topic exists with the requested ID.
courses_topics_patchEXECcourseId, idUpdates one or more fields of a topic. This method returns the following error codes: PERMISSION_DENIED if the requesting developer project did not create the corresponding topic or for access errors. INVALID_ARGUMENT if the request is malformed. * NOT_FOUND if the requested course or topic does not exist