Patch
|
|||||
|
|
||||
Updates one or more fields of a topic.
This method returns the following error codes:
PERMISSION_DENIEDif the requesting developer project did not create the corresponding topic or for access errors.INVALID_ARGUMENTif the request is malformed.NOT_FOUNDif the requested course or topic 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
Input
This building block consumes 7 input parameters
| Name | Format | Description |
|---|---|---|
courseId Required |
STRING |
Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias |
id Required |
STRING |
Identifier of the topic |
updateMask |
ANY |
Mask that identifies which fields on the topic to update.
This field is required to do an update. The update fails if invalid
fields are specified. If a field supports empty values, it can be cleared
by specifying it in the update mask and not in the Topic object. If a
field that does not support empty values is included in the update mask and
not set in the Topic object, an The following fields may be specified:
|
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 |
topicId |
STRING |
Unique identifier for the topic. Read-only |
courseId |
STRING |
Identifier of the course. Read-only |
updateTime |
ANY |
The time the topic was last updated by the system. Read-only |
= Parameter name
= Format
|
courseId STRING Required Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias |
|
id STRING Required Identifier of the topic |
|
updateMask ANY Mask that identifies which fields on the topic to update.
This field is required to do an update. The update fails if invalid
fields are specified. If a field supports empty values, it can be cleared
by specifying it in the update mask and not in the Topic object. If a
field that does not support empty values is included in the update mask and
not set in the Topic object, an The following fields may be specified:
|
|
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 |
|
topicId STRING Unique identifier for the topic. Read-only |
|
courseId STRING Identifier of the course. Read-only |
|
updateTime ANY The time the topic was last updated by the system. Read-only |
Output
This building block provides 4 output parameters
| Name | Format | Description |
|---|---|---|
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 |
topicId |
STRING |
Unique identifier for the topic. Read-only |
courseId |
STRING |
Identifier of the course. Read-only |
updateTime |
ANY |
The time the topic was last updated by the system. Read-only |
= Parameter name
= Format
|
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 |
|
topicId STRING Unique identifier for the topic. Read-only |
|
courseId STRING Identifier of the course. Read-only |
|
updateTime ANY The time the topic was last updated by the system. Read-only |