API Reference

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

本 API 參考資料是依照資源類型編排。各個資源類型都具有一或多種資料表示法,以及一或多種方法。

資源類型

  1. 簡介
  2. 變更
  3. 管道
  4. 留言
  5. 檔案
  6. 權限
  7. 回覆
  8. 修訂版本
  9. 雲端硬碟

簡介

如需資源詳細資料,請參閱資源表示法頁面。

方法 HTTP 要求 說明
除非另有註明,否則相對於 https://www.googleapis.com/drive/v3 的 URI
get GET  /about 取得使用者、雲端硬碟和系統功能的相關資訊。

必要查詢參數:fields

變更內容

如需變更資源的詳細資料,請參閱資源表示法網頁。

方法 HTTP 要求 說明
除非另有註明,否則相對於 https://www.googleapis.com/drive/v3 的 URI
getStartPageToken GET  /changes/startPageToken 取得起始權杖,用於列出未來變更。
清單 GET  /changes 列出使用者或共用雲端硬碟的變更。

必要查詢參數:pageToken

手錶 POST  /changes/watch 為使用者訂閱變更。如要使用這個方法,您必須加入 pageToken 查詢參數。

管道

如需管道資源詳細資料,請參閱資源表示法頁面。

方法 HTTP 要求 說明
除非另有註明,否則相對於 https://www.googleapis.com/drive/v3 的 URI
stop POST  /channels/stop 停止透過這個頻道觀看資源

評論

如需註解資源的詳細資料,請參閱資源表示法

方法 HTTP 要求 說明
除非另有註明,否則相對於 https://www.googleapis.com/drive/v3 的 URI
create POST  /files/fileId/comments 在檔案上建立註解。

必要查詢參數:fields

刪除 DELETE  /files/fileId/comments/commentId 刪除留言。
get GET  /files/fileId/comments/commentId 依 ID 接收留言。

必要查詢參數:fields

清單 GET  /files/fileId/comments 列出檔案的註解。

必要查詢參數:fields

update PATCH  /files/fileId/comments/commentId 使用修補程式語意更新註解。

必要查詢參數:fields

檔案

如需 Files 資源的詳細資料,請參閱資源表示法網頁。

方法 HTTP 要求 說明
除非另有註明,否則相對於 https://www.googleapis.com/drive/v3 的 URI
複製 POST  /files/fileId/copy 建立檔案複本,並使用修補語意套用任何要求更新。無法複製資料夾。
create POST
https://www.googleapis.com/upload/drive/v3/files


POST  /files
建立檔案。
刪除 DELETE  /files/fileId 永久刪除使用者擁有的檔案,但不會將檔案移至垃圾桶。如果檔案是屬於共用雲端硬碟,則使用者必須是上層主辦人。如果目標資料夾是資料夾,則使用者擁有的所有子係也會遭到刪除。
empty 垃圾桶 DELETE  /files/trash 永久刪除使用者移至垃圾桶的所有檔案。
匯出 GET  /files/fileId/export 將 Google Workspace 文件匯出至要求的 MIME 類型,並傳回匯出的位元組內容。請注意,匯出內容的大小上限為 10MB。

必要查詢參數:mimeType

generateIds GET  /files/generateIds 產生可在建立或複製要求中提供的一組檔案 ID。
get GET  /files/fileId 根據 ID 取得檔案的中繼資料或內容。
清單 GET  /files 列出或搜尋檔案。
update PATCH
https://www.googleapis.com/upload/drive/v3/files/fileId


PATCH  /files/fileId
更新檔案的中繼資料和/或內容。呼叫這個方法時,只在您要修改的要求中填入欄位。更新欄位時,有些欄位可能會自動變更,例如修改過的日期。這個方法支援修補語意。
手錶 POST  /files/fileId/watch 訂閱檔案變更。即使您已為共用雲端硬碟中的檔案建立頻道,但是變更共用雲端硬碟檔案並不會建立通知。
listLabels GET  /files/fileId/listLabels 列出檔案的標籤。
ModifyLabels POST  /files/fileId/modifyLabels 修改檔案的標籤組合。

權限

如需權限資源詳細資料,請參閱資源表示法頁面。

方法 HTTP 要求 說明
除非另有註明,否則相對於 https://www.googleapis.com/drive/v3 的 URI
create POST  /files/fileId/permissions 為檔案或共用雲端硬碟建立權限。如要進一步瞭解如何建立權限,請參閱共用檔案、資料夾和雲端硬碟一文。
刪除 DELETE  /files/fileId/permissions/permissionId 刪除權限。
get GET  /files/fileId/permissions/permissionId 根據 ID 取得權限。
清單 GET  /files/fileId/permissions 列出檔案或共用雲端硬碟的權限。
update PATCH  /files/fileId/permissions/permissionId 使用修補語意更新權限。

回覆

如需「回覆」資源的詳細資料,請參閱資源表示法網頁。

方法 HTTP 要求 說明
除非另有註明,否則相對於 https://www.googleapis.com/drive/v3 的 URI
create POST  /files/fileId/comments/commentId/replies 建立留言的回覆。

必要查詢參數:fields

刪除 DELETE  /files/fileId/comments/commentId/replies/replyId 刪除回覆。
get GET  /files/fileId/comments/commentId/replies/replyId 依 ID 接收回覆。

必要查詢參數:fields

清單 GET  /files/fileId/comments/commentId/replies 列出留言的回覆。

必要查詢參數:fields

update PATCH  /files/fileId/comments/commentId/replies/replyId 使用修補程式語意更新回覆。

必要查詢參數:fields

修訂版本

如需修訂版本資源的詳細資料,請參閱資源表示法頁面。

方法 HTTP 要求 說明
除非另有註明,否則相對於 https://www.googleapis.com/drive/v3 的 URI
刪除 DELETE  /files/fileId/revisions/revisionId 永久刪除檔案版本。你只能刪除 Google 雲端硬碟中含有二進位內容的檔案 (例如圖片或影片)。但刪除其他檔案 (例如 Google 文件或試算表) 和其餘檔案的最新版本,則無法予以刪除。
get GET  /files/fileId/revisions/revisionId 根據 ID 取得修訂版本的中繼資料或內容。
清單 GET  /files/fileId/revisions 列出檔案的修訂版本。
update PATCH  /files/fileId/revisions/revisionId 使用修補語意更新修訂版本。

雲端硬碟

如需雲端硬碟資源的詳細資料,請參閱資源表示法

方法 HTTP 要求 說明
除非另有註明,否則相對於 https://www.googleapis.com/drive/v3 的 URI
create POST  /drives 建立共用雲端硬碟。

必要查詢參數:requestId

刪除 DELETE  /drives/driveId 永久刪除使用者擔任主辦人的共用雲端硬碟。共用雲端硬碟不得包含任何未還原的項目。
get GET  /drives/driveId 根據 ID 取得共用雲端硬碟的中繼資料。
隱藏 POST  /drives/driveId/hide 預設檢視畫面會隱藏共用雲端硬碟。
清單 GET  /drives 列出使用者的共用雲端硬碟。
取消隱藏 POST  /drives/driveId/unhide 將共用雲端硬碟還原為預設檢視模式。
update PATCH  /drives/driveId 更新共用雲端硬碟的中繼資料。