資源:檔案
檔案的中繼資料。
部分資源方法 (例如 files.update
) 需要 fileId
。使用 files.list
方法擷取檔案 ID。
JSON 表示法 |
---|
{ "kind": string, "userPermission": { object ( |
欄位 | |
---|---|
kind |
僅供輸出。檔案類型。一律為 |
userPermission |
僅供輸出。這個檔案中已驗證使用者的權限。 |
fileExtension |
僅供輸出。 |
md5Checksum |
僅供輸出。這個檔案內容的 MD5 總和檢查碼。這個欄位只會針對儲存在 Google 雲端硬碟中的檔案填入內容,系統不會針對文件編輯器或捷徑檔案填入資料。 |
selfLink |
僅供輸出。指向這個檔案的連結。 |
ownerNames[] |
僅供輸出。這個檔案擁有者的名稱。系統不會為共用雲端硬碟中的項目填入資料。 |
lastModifyingUserName |
僅供輸出。最後一位修改這個檔案的使用者名稱。 |
editable |
僅供輸出。已淘汰:請改用 |
writersCanShare |
寫入者能否與其他使用者共用文件。系統不會為共用雲端硬碟中的項目填入資料。 |
downloadUrl |
僅供輸出。檔案的簡短下載網址。這個欄位只會針對儲存在 Google 雲端硬碟中的內容填入檔案,不會針對 Google 文件或捷徑檔案填入資料。 |
mimeType |
檔案的 MIME 類型。只有在上傳新內容時,才需要變動內容。這個欄位可以留空,系統會根據上傳內容的 MIME 類型決定 MIME 類型。 |
exportLinks |
僅供輸出。以特定格式匯出文件編輯器檔案的連結。 這個物件中包含 |
driveId |
僅供輸出。檔案所屬共用雲端硬碟的 ID。只有共用雲端硬碟中的項目才會填入資料。 |
parents[] |
含有這個檔案的上層資料夾集合。 如未在插入要求中指定,檔案會直接放在使用者的「我的雲端硬碟」資料夾中。如未在複製要求中指定,檔案會繼承來源檔案所有可供搜尋的父項。file.update 要求也可以使用 |
thumbnailLink |
僅供輸出。檔案的縮圖線上連結 (如有)。通常以小時順序為準。只有在要求的應用程式可存取檔案內容時,才會填入資料。如果檔案未公開共用,則必須使用憑證要求來擷取 |
appDataContents |
僅供輸出。這個檔案是否在「Application Data」資料夾中。 |
webViewLink |
僅供輸出。連結只有在公用資料夾中,才會透過 Google 雲端硬碟的網站代管服務查看靜態網頁資產 (HTML、CSS、JS 等)。 |
iconLink |
僅供輸出。檔案圖示的連結。 |
shared |
僅供輸出。檔案是否已共用。系統不會為共用雲端硬碟中的項目填入資料。 |
lastModifyingUser |
僅供輸出。最後一個修改了這個檔案的使用者。 |
owners[] |
僅供輸出。這個檔案的擁有者。只有特定舊版檔案可以有多位擁有者。這個欄位不會針對共用雲端硬碟中的項目填入資料。 |
openWithLinks |
僅供輸出。使用者各個應用程式 ID 的地圖,會連結至可透過該應用程式開啟這個檔案的連結。只有在使用 drive.apps.readonly 範圍時,才會填入此項目。 這個物件中包含 |
defaultOpenWithLink |
僅供輸出。透過使用者的預設應用程式開啟這個檔案的連結。只有在使用 drive.apps.readonly 範圍時,才會填入資料。 |
headRevisionId |
僅供輸出。檔案首修訂版本的 ID。這個欄位只會針對儲存在 Google 雲端硬碟中的檔案填入內容,系統不會針對文件編輯器或捷徑檔案填入資料。 |
properties[] |
屬性清單。 |
copyable |
僅供輸出。已淘汰:請改用 |
etag |
僅供輸出。檔案的 ETag。 |
sharingUser |
僅供輸出。與目前使用者共用項目的使用者 (如果有的話)。 |
alternateLink |
僅供輸出。可在相關 Google 編輯器或檢視器中開啟檔案的連結。 |
embedLink |
僅供輸出。嵌入檔案的連結。 |
webContentLink |
僅供輸出。這個連結可讓你透過 Cookie 式驗證功能,在瀏覽器中下載檔案內容。針對公開分享的內容,即使沒有憑證,也能下載這些內容。 |
fileSize |
僅供輸出。blob 和第一方編輯器檔案的大小 (以位元組為單位)。如果是沒有大小限制的檔案 (例如捷徑和資料夾),則不會自動填入。 |
copyRequiresWriterPermission |
設定是否要為讀者和加註者停用複製、列印或下載這個檔案的選項。 |
permissions[] |
僅供輸出。有權存取這個檔案的使用者權限清單。系統不會為共用雲端硬碟中的項目填入資料。 |
hasThumbnail |
僅供輸出。這個檔案是否有縮圖。但這並不代表提出要求的應用程式是否能存取縮圖。如要確認存取權,請檢查是否有縮圖連結欄位。 |
spaces[] |
僅供輸出。包含該檔案的聊天室清單。支援的值為 |
folderColorRgb |
如果檔案是資料夾或資料夾捷徑,則以 RGB 十六進位字串格式呈現資料夾顏色。支援顏色的清單會出現在「About」資源的「folderColorPalette」欄位中。如果指定不支援的顏色,會在調色盤中變更為最接近的顏色。 |
id |
檔案的 ID。 |
title |
這個檔案的標題。請注意,對於不可變更的項目,例如共用雲端硬碟的頂層資料夾、「我的雲端硬碟」根資料夾和「應用程式資料」資料夾,標題會維持不變。 |
description |
關於檔案的簡要說明。 |
labels |
檔案的一組標籤。 |
labels.viewed |
使用者是否檢視過這個檔案。 |
labels.restricted |
僅供輸出。已淘汰:請改用 |
labels.starred |
使用者是否為這個檔案加上星號。 |
labels.hidden |
僅供輸出。已淘汰。 |
labels.trashed |
這個檔案是否已移至垃圾桶。這個標籤會套用至所有使用者,但只有擁有者可以查看及移出檔案。 |
labels.modified |
僅供輸出。使用者是否修改過檔案。 |
explicitlyTrashed |
僅供輸出。這個檔案是否已明確移至垃圾桶,而非週期性移至垃圾桶。 |
createdDate |
僅供輸出。這個檔案的建立時間 (格式化 RFC 3339 時間戳記)。 |
modifiedDate |
任何人上次修改這個檔案的時間 (格式化的 RFC 3339 時間戳記)。只有在已設定 setModifiedDate 參數時,這項變更才會變更。 |
modifiedByMeDate |
僅供輸出。使用者上次修改這個檔案的時間 (格式化的 RFC 3339 時間戳記)。請注意,設定 editDate 後,系統也會為設定日期的使用者更新 modifyByMe 日期。 |
lastViewedByMeDate |
使用者上次檢視這個檔案的時間 (格式化的 RFC 3339 時間戳記)。 |
markedViewedByMeDate |
僅供輸出。已淘汰。 |
sharedWithMeDate |
僅供輸出。與使用者共用檔案的時間 (格式化 RFC 3339 時間戳記)。 |
quotaBytesUsed |
僅供輸出。這個檔案使用的配額位元組數。 |
version |
僅供輸出。檔案的單調遞增版本號碼。這反映了伺服器上對檔案所做的所有變更,即使是提出要求的使用者看不見這些變更,也包含在內。 |
indexableText |
檔案的可建立索引文字屬性 (只能寫入) |
indexableText.text |
要為這個檔案建立索引的文字。 |
originalFilename |
上傳內容的原始檔案名稱 (如有),或 |
ownedByMe |
僅供輸出。檔案是否由目前使用者所擁有。系統不會為共用雲端硬碟中的項目填入資料。 |
canComment |
僅供輸出。已淘汰:請改用 |
shareable |
僅供輸出。已淘汰:請改用 |
fullFileExtension |
僅供輸出。從標題中擷取的完整副檔名。可能包含多個串連的擴充功能,例如「tar.gz」。移除標題中的副檔名並不會清除這個欄位;但變更標題的副檔名,就會更新這個欄位。這個欄位只會針對儲存在 Google 雲端硬碟中的檔案填入內容,系統不會針對文件編輯器或捷徑檔案填入資料。 |
isAppAuthorized |
僅供輸出。該檔案是由要求應用程式建立或開啟。 |
teamDriveId |
僅供輸出。已淘汰:請改用 |
capabilities |
僅供輸出。目前使用者擁有這個檔案的功能。每項功能都對應到使用者可能採取的細部動作。 |
capabilities.canChangeRestrictedDownload |
僅供輸出。已淘汰。 |
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 |
僅供輸出。如果檔案已明確移至垃圾桶,即為移至垃圾桶的使用者。只有共用雲端硬碟中的項目才會填入資料。 |
canReadRevisions |
僅供輸出。已淘汰:請改用 |
thumbnailVersion |
僅供輸出。用於撤銷縮圖快取的縮圖版本。 |
trashedDate |
僅供輸出。項目移至垃圾桶的時間 (格式化 RFC 3339 時間戳記)。只有共用雲端硬碟中的項目才會填入資料。 |
permissionIds[] |
僅限輸出。file.list 權限 ID 適用於擁有此檔案存取權的使用者。 |
thumbnail |
檔案的縮圖。只有在無法產生標準縮圖時,系統才會使用這個縮圖。 |
thumbnail.image |
縮圖的安全網址 Base64 編碼位元組。必須符合 RFC 4648 第 5 節的規定。 Base64 編碼的字串。 |
thumbnail.mimeType |
縮圖的 MIME 類型。 |
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.date |
僅供輸出。相片的拍攝日期和時間 (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 |
僅供輸出。負責設定內容限制的使用者。只有在 |
restrictionDate |
僅供輸出。內容限制的設定時間 (格式化 RFC 3339 時間戳記)。只有在 |
ownerRestricted |
內容限制是否只能由擁有檔案的使用者修改或移除。針對共用雲端硬碟中的檔案,凡是具備 |
systemRestricted |
僅供輸出。是否由系統套用內容限制 (例如出於電子簽名)。使用者無法修改或移除系統限制的內容限制。 |
方法 |
|
---|---|
|
建立指定檔案的副本。 |
|
永久刪除使用者擁有的檔案,但不會將檔案移至垃圾桶。 |
|
永久刪除使用者移至垃圾桶的所有檔案。 |
|
將 Google Workspace 文件匯出至要求的 MIME 類型,然後傳回匯出的位元組內容。 |
|
產生一組可在插入或複製要求中提供的檔案 ID。 |
|
依 ID 取得檔案的中繼資料或內容。 |
|
插入新檔案。 |
|
列出使用者的檔案。 |
|
列出檔案的標籤。 |
|
修改套用至檔案的標籤組合。 |
|
更新檔案的中繼資料和/或內容。 |
|
將檔案的更新時間設為目前的伺服器時間。 |
|
將檔案移至垃圾桶。 |
|
還原垃圾桶中的檔案。 |
|
更新檔案的中繼資料和/或內容。 |
|
訂閱檔案變更。 |