Google Classroom 外掛程式現已全面開放開發人員使用!詳情請參閱
外掛程式說明文件。
Method: courses.topics.patch
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
更新主題的一或多個欄位。
這個方法會傳回下列錯誤代碼:
PERMISSION_DENIED
如果要求的開發人員專案未建立對應的主題,或發生存取錯誤。
INVALID_ARGUMENT
:如果要求格式錯誤。
FAILED_PRECONDITION
,如果課程中已有同名主題。
NOT_FOUND
:如果要求的課程或主題不存在
HTTP 要求
PATCH https://classroom.googleapis.com/v1/courses/{courseId}/topics/{id}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
courseId |
string
課程的 ID。這個 ID 可以是 Classroom 指派的 ID 或 alias 。
|
id |
string
主題的 ID。
|
查詢參數
參數 |
updateMask |
string (FieldMask format)
用於識別要更新的主題欄位。這是更新時的必填欄位。如果指定無效欄位,更新作業就會失敗。如果欄位支援空值,您可以在更新遮罩中指定該欄位,而非在 Topic 物件中指定,即可清除該欄位。如果更新遮罩中包含不支援空值的欄位,且未在 Topic 物件中設定,系統會傳回 INVALID_ARGUMENT 錯誤。 您可以指定下列欄位:
這是以半形逗號分隔的完整欄位名稱清單。範例:"user.displayName,photo" 。
|
回應主體
如果成功,回應主體會包含 Topic
的執行例項。
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/classroom.topics
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[],[],null,["# Method: courses.topics.patch\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- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates one or more fields of a topic.\n\nThis method returns the following error codes:\n\n- `PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for [access errors](/workspace/classroom/reference/Access.Errors).\n- `INVALID_ARGUMENT` if the request is malformed.\n- `FAILED_PRECONDITION` if there exists a topic in the course with the same name.\n- `NOT_FOUND` if the requested course or topic does not exist\n\n### HTTP request\n\n`PATCH https://classroom.googleapis.com/v1/courses/{courseId}/topics/{id}`\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| `id` | `string` Identifier of the topic. |\n\n### Query parameters\n\n| Parameters ||\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` 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 `INVALID_ARGUMENT` error is returned. The following fields may be specified: - `name` This is a comma-separated list of fully qualified names of fields. Example: `\"user.displayName,photo\"`. |\n\n### Request body\n\nThe request body contains an instance of [Topic](/workspace/classroom/reference/rest/v1/courses.topics#Topic).\n\n### Response body\n\nIf successful, the response body contains an instance of [Topic](/workspace/classroom/reference/rest/v1/courses.topics#Topic).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/classroom.topics`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]