資源:檔案
檔案的中繼資料。
部分資源方法 (例如 files.update
) 需要 fileId
。使用 files.list
方法擷取檔案 ID。
JSON 表示法 |
---|
{ "kind": string, "driveId": string, "fileExtension": string, "copyRequiresWriterPermission": boolean, "md5Checksum": string, "contentHints": { "indexableText": string, "thumbnail": { "image": string, "mimeType": string } }, "writersCanShare": boolean, "viewedByMe": boolean, "mimeType": string, "exportLinks": { string: string, ... }, "parents": [ string ], "thumbnailLink": string, "iconLink": string, "shared": boolean, "lastModifyingUser": { object ( |
欄位 | |
---|---|
kind |
僅供輸出。指出資源的類型。值:固定字串 |
driveId |
僅供輸出。檔案所屬共用雲端硬碟的 ID。只有共用雲端硬碟中的項目才會填入資料。 |
fileExtension |
僅供輸出。 |
copyRequiresWriterPermission |
設定是否要為讀者和加註者停用複製、列印或下載這個檔案的選項。 |
md5Checksum |
僅供輸出。檔案內容的 MD5 總和檢查碼。這僅適用於 Google 雲端硬碟中含有二進位內容的檔案。 |
contentHints |
檔案內容的其他資訊。這些欄位一律不會填入回應。 |
contentHints.indexableText |
要為檔案建立索引的文字,以改善全文查詢。大小上限為 128 KB,可能含有 HTML 元素。 |
contentHints.thumbnail |
檔案的縮圖。這個選單僅適用於 Google 雲端硬碟無法產生標準縮圖時。 |
contentHints.thumbnail.image |
使用網址安全 Base64 編碼的縮圖資料 (RFC 4648 第 5 節)。 Base64 編碼的字串。 |
contentHints.thumbnail.mimeType |
縮圖的 MIME 類型。 |
writersCanShare |
是否只有「 |
viewedByMe |
僅供輸出。使用者是否看過檔案。 |
mimeType |
檔案的 MIME 類型。 如果未提供任何值,Google 雲端硬碟會嘗試自動偵測上傳內容中的適當值。必須上傳新修訂版本,才能變更這個值。 如果使用 Google 文件的 MIME 類型建立檔案,系統會盡可能匯入使用者上傳的內容。支援的匯入格式會在「關於」資源中發布。 |
exportLinks |
僅供輸出。以特定格式匯出文件編輯器檔案的連結。 這個物件中包含 |
parents[] |
包含檔案的上層資料夾 ID。 如果建立要求時未指定檔案,系統會將檔案直接放在使用者的「我的雲端硬碟」資料夾中。如未在複製要求中指定,檔案會繼承來源檔案所有可搜尋的父項。file.update 要求必須使用 |
thumbnailLink |
僅供輸出。檔案的縮圖線上連結 (如有)。通常以小時順序為準。只有在要求的應用程式可存取檔案內容時,才會填入資料。如果檔案未公開共用,則必須使用憑證要求來擷取 |
iconLink |
僅供輸出。檔案圖示的未驗證靜態連結。 |
shared |
僅供輸出。檔案是否已共用。系統不會為共用雲端硬碟中的項目填入資料。 |
lastModifyingUser |
僅供輸出。最後一個修改檔案的使用者。 |
owners[] |
僅供輸出。這個檔案的擁有者。只有特定舊版檔案可以有多位擁有者。這個欄位不會針對共用雲端硬碟中的項目填入資料。 |
headRevisionId |
僅供輸出。檔案首修訂版本的 ID。這項功能目前僅適用於 Google 雲端硬碟中含有二進位內容的檔案。 |
sharingUser |
僅供輸出。與提出要求的使用者共用檔案的使用者 (如適用)。 |
webViewLink |
僅供輸出。透過連結,即可在相關的 Google 編輯器或檢視器中開啟檔案。 |
webContentLink |
僅供輸出。在瀏覽器中下載檔案內容的連結。這項功能僅適用於 Google 雲端硬碟中含有二進位內容的檔案。 |
size |
僅供輸出。blob 和第一方編輯器檔案的大小 (以位元組為單位)。如果是沒有大小限制的檔案 (例如捷徑和資料夾),則不會自動填入。 |
viewersCanCopyContent |
已淘汰:請改用 |
permissions[] |
僅供輸出。檔案的完整權限清單。只有在提出要求的使用者可共用檔案時,才能使用此功能。系統不會為共用雲端硬碟中的項目填入資料。 |
hasThumbnail |
僅供輸出。這個檔案是否有縮圖。但這並不代表提出要求的應用程式是否能存取縮圖。如要確認存取權,請檢查是否有縮圖連結欄位。 |
spaces[] |
僅供輸出。包含該檔案的聊天室清單。目前支援的值為「drive」、「appDataFolder」和「photos」。 |
folderColorRgb |
以 RGB 十六進位字串表示的資料夾或資料夾捷徑顏色。支援的顏色會列在關於資源的 如果指定不支援的顏色,會改用調色盤中最接近的顏色。 |
id |
檔案的 ID。 |
name |
檔案名稱。這在資料夾中不一定是唯一的。請注意,對於不可變更的項目,例如共用雲端硬碟的頂層資料夾、「我的雲端硬碟」根資料夾和「應用程式資料」資料夾,名稱會維持不變。 |
description |
關於檔案的簡要說明。 |
starred |
使用者是否為檔案加上星號。 |
trashed |
檔案已移至垃圾桶 (明確位置或從移至垃圾桶的上層資料夾)。只有擁有者可以將檔案移至垃圾桶,其他使用者無法查看擁有者垃圾桶中的檔案。 |
explicitlyTrashed |
僅供輸出。檔案是否已明確移至垃圾桶,而非從上層資料夾遞迴移至垃圾桶。 |
createdTime |
檔案建立時間 (RFC 3339 日期時間)。 |
modifiedTime |
上次任何人修改檔案的時間 (RFC 3339 日期時間)。 請注意,設定 |
modifiedByMeTime |
僅供輸出。使用者上次修改檔案的時間 (RFC 3339 日期時間)。 |
viewedByMeTime |
使用者上次檢視檔案的時間 (RFC 3339 日期時間)。 |
sharedWithMeTime |
僅供輸出。與使用者共用檔案的時間 (如適用,RFC 3339 日期時間)。 |
quotaBytesUsed |
僅供輸出。檔案使用的儲存空間配額位元組數。包括前端修訂版本和已啟用 |
version |
僅供輸出。檔案的單調遞增版本號碼。這項資訊反映了伺服器上的所有檔案變更,包括使用者看不到的這些變更。 |
originalFilename |
上傳內容的原始檔案名稱 (如有),或 |
ownedByMe |
僅供輸出。使用者是否擁有檔案。系統不會為共用雲端硬碟中的項目填入資料。 |
fullFileExtension |
僅供輸出。從 當 |
properties |
所有應用程式都會顯示的任意鍵/值組合。 如果項目為空值,系統會在更新和複製要求中清除。 這個物件中包含 |
appProperties |
任意鍵/值組合的集合,僅供要求應用程式使用。 如果項目為空值,系統會在更新和複製要求中清除。 這些屬性只能透過經過驗證的要求擷取。經過驗證的要求會使用以 OAuth 2 用戶端 ID 取得的存取權杖。您無法使用 API 金鑰擷取不公開屬性。 這個物件中包含 |
isAppAuthorized |
僅供輸出。該檔案是由要求應用程式建立或開啟。 |
teamDriveId |
已淘汰:僅限輸出。請改用 |
capabilities |
僅供輸出。目前使用者擁有這個檔案的功能。每項功能都對應到使用者可能採取的細部動作。 |
capabilities.canChangeViewersCanCopyContent |
已淘汰:僅限輸出。 |
capabilities.canMoveChildrenOutOfDrive |
僅供輸出。目前的使用者能否將這個資料夾的子項移至共用雲端硬碟外。如果項目不是資料夾,則為「false」。只有共用雲端硬碟中的項目才會填入資料。 |
capabilities.canReadDrive |
僅供輸出。目前的使用者是否能讀取這個檔案所屬的共用雲端硬碟。只有共用雲端硬碟中的項目才會填入資料。 |
capabilities.canEdit |
僅供輸出。目前的使用者是否能編輯這個檔案。其他因素可能會限制使用者能對檔案進行的變更類型。例如,請參閱 |
capabilities.canCopy |
僅供輸出。目前的使用者是否能複製這個檔案。針對共用雲端硬碟中的某個項目,目前使用者是否能複製這個項目的非資料夾子系;如果該項目不是資料夾,則會複製該項目本身。 |
capabilities.canComment |
僅供輸出。目前的使用者是否能對這個檔案加註。 |
capabilities.canAddChildren |
僅供輸出。目前的使用者能否在這個資料夾中新增子項。如果項目不是資料夾,則這個屬性一律為 false。 |
capabilities.canDelete |
僅供輸出。目前的使用者能否刪除這個檔案。 |
capabilities.canDownload |
僅供輸出。目前使用者是否能夠下載這個檔案。 |
capabilities.canListChildren |
僅供輸出。目前的使用者是否能列出這個資料夾的子項。如果項目不是資料夾,則這個屬性一律為 false。 |
capabilities.canRemoveChildren |
僅供輸出。目前的使用者能否移除這個資料夾中的子項。如果項目不是資料夾,則這個屬性一律為 false。如果是共用雲端硬碟中的資料夾,請改用 |
capabilities.canRename |
僅供輸出。目前的使用者是否能重新命名這個檔案。 |
capabilities.canTrash |
僅供輸出。目前的使用者是否能將這個檔案移至垃圾桶。 |
capabilities.canReadRevisions |
僅供輸出。目前的使用者是否能讀取這個檔案的修訂版本資源。可以讀取共用雲端硬碟項目的非資料夾子系修訂版本,或這個項目本身 (如果不是資料夾) 可以讀取。 |
capabilities.canReadTeamDrive |
已淘汰:僅限輸出。請改用 |
capabilities.canMoveTeamDriveItem |
已淘汰:僅限輸出。請改用 |
capabilities.canChangeCopyRequiresWriterPermission |
僅供輸出。指定目前的使用者是否能變更這個檔案的 |
capabilities.canMoveItemIntoTeamDrive |
已淘汰:僅限輸出。請改用 |
capabilities.canUntrash |
僅供輸出。指定目前的使用者是否能從垃圾桶還原這個檔案。 |
capabilities.canModifyContent |
僅供輸出。目前的使用者是否能修改這個檔案的內容。 |
capabilities.canMoveItemWithinTeamDrive |
已淘汰:僅限輸出。請改用 |
capabilities.canMoveItemOutOfTeamDrive |
已淘汰:僅限輸出。請改用 |
capabilities.canDeleteChildren |
僅供輸出。目前的使用者能否刪除這個資料夾的子項。如果項目不是資料夾,則為「false」。只有共用雲端硬碟中的項目才會填入資料。 |
capabilities.canMoveChildrenOutOfTeamDrive |
已淘汰:僅限輸出。請改用 |
capabilities.canMoveChildrenWithinTeamDrive |
已淘汰:僅限輸出。請改用 |
capabilities.canTrashChildren |
僅供輸出。目前的使用者是否能將此資料夾的子項移至垃圾桶。如果項目不是資料夾,則為「false」。只有共用雲端硬碟中的項目才會填入資料。 |
capabilities.canMoveItemOutOfDrive |
僅供輸出。指定目前使用者是否能透過變更父項,將這個項目移出這個雲端硬碟。請注意,視新增的父項而定,變更項目父項的要求可能仍會失敗。 |
capabilities.canAddMyDriveParent |
僅供輸出。目前的使用者是否能在同一個要求中為項目新增父項,而不需移除現有的父項。系統不會為共用雲端硬碟檔案填入資料。 |
capabilities.canRemoveMyDriveParent |
僅供輸出。目前的使用者是否可以在同一個要求中移除父項,而不用新增另一個父項。系統不會為共用雲端硬碟檔案填入資料。 |
capabilities.canMoveItemWithinDrive |
僅供輸出。目前使用者是否能在這個雲端硬碟中移動這個項目。請注意,視新增的父項和被移除的父項而定,變更項目父項的要求可能仍會失敗。 |
capabilities.canShare |
僅供輸出。目前的使用者是否能修改這個檔案的共用設定。 |
capabilities.canMoveChildrenWithinDrive |
僅供輸出。目前使用者是否能在這個雲端硬碟中移動這個資料夾的子項。如果項目不是資料夾,則為「false」。請注意,視目前使用者的子項和目的地資料夾的存取權而定,移動子項的要求可能仍會失敗。 |
capabilities.canModifyContentRestriction |
已淘汰:僅限輸出。請使用 |
capabilities.canAddFolderFromAnotherDrive |
僅供輸出。目前的使用者是否能將其他雲端硬碟 (不同共用雲端硬碟或「我的雲端硬碟」) 的資料夾新增至這個資料夾。如果項目不是資料夾,則為「false」。只有共用雲端硬碟中的項目才會填入資料。 |
capabilities.canChangeSecurityUpdateEnabled |
僅供輸出。指定目前的使用者是否可以變更連結共用中繼資料的 securityUpdateEnabled 欄位。 |
capabilities.canAcceptOwnership |
僅供輸出。目前的使用者是否為檔案邀請對象。系統不會為共用雲端硬碟檔案填入資料。 |
capabilities.canReadLabels |
僅供輸出。是否可讀取檔案上的標籤。 |
capabilities.canModifyLabels |
僅供輸出。目前使用者是否能夠修改檔案的標籤。 |
capabilities.canModifyEditorContentRestriction |
僅供輸出。目前使用者是否可在受編輯者限制的檔案中新增或修改內容限制。 |
capabilities.canModifyOwnerContentRestriction |
僅供輸出。是否能新增或修改僅限擁有者存取的內容限制。 |
capabilities.canRemoveContentRestriction |
僅供輸出。檔案是否設有可由目前使用者移除的內容限制。 |
hasAugmentedPermissions |
僅供輸出。你是否直接擁有這個檔案的權限。這個欄位只會針對共用雲端硬碟中的項目填入資料。 |
trashingUser |
僅供輸出。如果檔案已明確移至垃圾桶,即為移至垃圾桶的使用者。只有共用雲端硬碟中的項目才會填入資料。 |
thumbnailVersion |
僅供輸出。用於撤銷縮圖快取的縮圖版本。 |
trashedTime |
僅供輸出。項目移至垃圾桶的時間 (RFC 3339 日期時間)。只有共用雲端硬碟中的項目才會填入資料。 |
modifiedByMe |
僅供輸出。使用者是否修改過檔案。 |
permissionIds[] |
僅限輸出。file.list 權限 ID 適用於擁有此檔案存取權的使用者。 |
imageMediaMetadata |
僅供輸出。圖片媒體的其他中繼資料 (如有)。 |
imageMediaMetadata.flashUsed |
僅供輸出。相片是否使用閃光燈。 |
imageMediaMetadata.meteringMode |
僅供輸出。用於製作相片的測光模式。 |
imageMediaMetadata.sensor |
僅供輸出。用於製作相片的感應器類型。 |
imageMediaMetadata.exposureMode |
僅供輸出。用於製作相片的曝光模式。 |
imageMediaMetadata.colorSpace |
僅供輸出。相片的色域。 |
imageMediaMetadata.whiteBalance |
僅供輸出。用於製作相片的白平衡模式。 |
imageMediaMetadata.width |
僅供輸出。圖片的寬度 (以像素為單位)。 |
imageMediaMetadata.height |
僅供輸出。圖片的高度 (以像素為單位)。 |
imageMediaMetadata.location |
僅供輸出。儲存在圖片中的地理位置資訊。 |
imageMediaMetadata.location.latitude |
僅供輸出。圖片中儲存的緯度。 |
imageMediaMetadata.location.longitude |
僅供輸出。圖片中儲存的經度。 |
imageMediaMetadata.location.altitude |
僅供輸出。儲存在圖片中的海拔高度。 |
imageMediaMetadata.rotation |
僅供輸出。從圖片原始方向套用的順時針旋轉 90 度的次數。 |
imageMediaMetadata.time |
僅供輸出。相片的拍攝日期和時間 (EXIF 日期時間)。 |
imageMediaMetadata.cameraMake |
僅供輸出。用來製作相片的相機鏡頭。 |
imageMediaMetadata.cameraModel |
僅供輸出。用於製作相片的相機模型。 |
imageMediaMetadata.exposureTime |
僅供輸出。曝光的時間長度 (以秒為單位)。 |
imageMediaMetadata.aperture |
僅供輸出。用於製作相片的光圈 (f-number)。 |
imageMediaMetadata.focalLength |
僅供輸出。用於建立相片的焦距 (公釐)。 |
imageMediaMetadata.isoSpeed |
僅供輸出。用於製作相片的 ISO 速度。 |
imageMediaMetadata.exposureBias |
僅供輸出。相片的曝光偏差 (APEX 值)。 |
imageMediaMetadata.maxApertureValue |
僅供輸出。用於建立相片的焦距最小 f 數 (APEX 值)。 |
imageMediaMetadata.subjectDistance |
僅供輸出。相片主體的距離 (以公尺為單位)。 |
imageMediaMetadata.lens |
僅供輸出。用來製作相片的鏡頭。 |
videoMediaMetadata |
僅供輸出。影片媒體的其他中繼資料。相片上傳後可能不會立即顯示。 |
videoMediaMetadata.width |
僅供輸出。影片的寬度 (以像素為單位)。 |
videoMediaMetadata.height |
僅供輸出。影片的高度 (以像素為單位)。 |
videoMediaMetadata.durationMillis |
僅供輸出。影片的時間長度 (以毫秒為單位)。 |
shortcutDetails |
捷徑檔案詳細資料。僅針對 mimeType 欄位設為 |
shortcutDetails.targetId |
這個捷徑指向的檔案 ID。 |
shortcutDetails.targetMimeType |
僅供輸出。這個捷徑指向的檔案的 MIME 類型。這個欄位的值是捷徑建立時擷取的目標 MIME 類型快照。 |
shortcutDetails.targetResourceKey |
僅供輸出。目標檔案的 ResourceKey。 |
contentRestrictions[] |
存取檔案內容的相關限制。只有在這類限制存在時才會填入。 |
resourceKey |
僅供輸出。必須透過共用連結存取項目所需的金鑰。 |
linkShareMetadata |
僅供輸出。LinkShare 的相關詳細資料。包含客戶用來參照這個項目的連結網址的詳細資料。 |
linkShareMetadata.securityUpdateEligible |
僅供輸出。檔案是否符合安全性更新的資格。 |
linkShareMetadata.securityUpdateEnabled |
僅供輸出。這個檔案是否已啟用安全性更新。 |
labelInfo |
僅供輸出。檔案標籤的總覽。 |
labelInfo.labels[] |
僅供輸出。依據 |
sha1Checksum |
僅供輸出。與這個檔案相關聯的 SHA1 總和檢查碼 (如果有的話)。這個欄位只會針對儲存在 Google 雲端硬碟中的檔案填入內容,系統不會針對文件編輯器或捷徑檔案填入資料。 |
sha256Checksum |
僅供輸出。與這個檔案相關聯的 SHA256 總和檢查碼 (如果有的話)。這個欄位只會針對儲存在 Google 雲端硬碟中的檔案填入內容,系統不會針對文件編輯器或捷徑檔案填入資料。 |
ContentRestriction
存取檔案內容的限制。
JSON 表示法 |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
欄位 | |
---|---|
readOnly |
檔案內容是否為唯讀狀態。如果檔案為唯讀狀態,則可能無法新增該檔案的修訂版本、註解可能無法新增或修改,且檔案標題也可能無法修改。 |
reason |
檔案內容受限原因。只有在要求也設定 |
type |
僅供輸出。內容限制的類型。目前唯一可能的值為 |
restrictingUser |
僅供輸出。負責設定內容限制的使用者。只有在 |
restrictionTime |
僅供輸出。內容限制的設定時間 (格式化 RFC 3339 時間戳記)。只有在 |
ownerRestricted |
內容限制是否只能由擁有檔案的使用者修改或移除。針對共用雲端硬碟中的檔案,凡是具備 |
方法 |
|
---|---|
|
建立檔案副本,並使用 Patch 語意套用所有要求的更新。 |
|
建立新檔案。 |
|
永久刪除使用者擁有的檔案,但不會將檔案移至垃圾桶。 |
|
永久刪除使用者移至垃圾桶的所有檔案。 |
|
將 Google Workspace 文件匯出至要求的 MIME 類型,然後傳回匯出的位元組內容。 |
|
產生一組檔案 ID,可在建立或複製要求中提供。 |
|
依 ID 取得檔案的中繼資料或內容。 |
|
列出使用者的檔案。 |
|
列出檔案的標籤。 |
|
修改套用至檔案的標籤組合。 |
|
更新檔案的中繼資料和/或內容。 |
|
訂閱檔案變更。 |