資源:File
檔案的中繼資料。
部分資源方法 (例如 files.update
) 需要 fileId
。使用 files.list
方法擷取檔案的 ID。
JSON 表示法 |
---|
{ "ownerNames": [ string ], "exportLinks": { string: string, ... }, "parents": [ { object ( |
欄位 | |
---|---|
ownerNames[] |
僅供輸出。這個檔案的擁有者名稱。共用雲端硬碟中的項目不會填入這項資訊。 |
exportLinks |
僅供輸出。將 Google 文件編輯器檔案匯出為特定格式的連結。 這個物件中包含 |
parents[] |
含有該檔案的上層資料夾 ID。 檔案只能有一個上層資料夾,系統不支援指定多個上層資料夾。 如果未在插入要求中指定,檔案會直接放在使用者的「我的雲端硬碟」資料夾中。如果未在複製要求中指定,檔案會沿用來源檔案可探索到的任何上層項目。files.update 要求必須使用 |
owners[] |
僅供輸出。這個檔案的擁有者。只有特定舊版檔案可能有多位擁有者。如果是共用雲端硬碟中的項目,系統就不會填入這個欄位。 |
openWithLinks |
僅供輸出。使用者每個應用程式的 ID 對應至可透過該應用程式開啟這個檔案的連結。只有在使用 drive.apps.readonly 範圍時才會填入。 這個物件中包含 |
properties[] |
屬性清單。 |
permissions[] |
僅供輸出。這份清單列出有權存取這個檔案的使用者,共用雲端硬碟中的項目不會填入這項資訊。 |
spaces[] |
僅供輸出。含有該檔案的聊天室清單。支援的值為 |
permissionIds[] |
僅供輸出。files.list,可存取這個檔案的使用者權限 ID。 |
contentRestrictions[] |
存取檔案內容的限制。只有在有這類限制時才會填入。 |
kind |
僅供輸出。檔案類型。這個值一律為 |
userPermission |
僅供輸出。已驗證使用者對這個檔案的權限。 |
fileExtension |
僅供輸出。 |
md5Checksum |
僅供輸出。這個檔案內容的 MD5 檢查碼。這個欄位只會填入儲存在 Google 雲端硬碟中的檔案內容,不會填入文件編輯器或捷徑檔案。 |
selfLink |
僅供輸出。這個檔案的連結。 |
lastModifyingUserName |
僅供輸出。上次修改這個檔案的使用者名稱。 |
editable |
僅供輸出。已淘汰:請改用 |
writersCanShare |
撰稿人是否可以與其他使用者共用文件。共用雲端硬碟中的項目不會填入這項資訊。 |
downloadUrl |
僅供輸出。檔案的下載網址,效期很短。這個欄位只會填入儲存在 Google 雲端硬碟中的檔案內容,不會填入 Google 文件或捷徑檔案。 |
mimeType |
檔案的 MIME 類型。上傳新內容時,只能在更新時變更這項設定。這個欄位可以留空,系統會根據上傳內容的 MIME 類型判斷 MIME 類型。 |
driveId |
僅供輸出。檔案所屬的共用雲端硬碟 ID。只有共用雲端硬碟中的項目會填入這項資料。 |
thumbnailLink |
僅供輸出。檔案縮圖的短期連結 (如有)。通常會持續數小時。由於跨源資源共享 (CORS),不建議在網頁應用程式上直接使用,請考慮使用 Proxy 伺服器。只有在要求存取權的應用程式可以存取檔案內容時,才會填入這個欄位。如果檔案未公開分享,則必須使用經過驗證的要求,擷取 |
appDataContents |
僅供輸出。這個檔案是否位於「應用程式資料」資料夾中。 |
webViewLink |
僅供輸出。這個連結僅適用於公開資料夾,可透過 Google 雲端硬碟的網站代管服務,查看靜態網站資產 (HTML、CSS、JS 等)。 |
iconLink |
僅供輸出。檔案圖示的連結。 |
shared |
僅供輸出。檔案是否已共用。共用雲端硬碟中的項目不會填入這項資訊。 |
lastModifyingUser |
僅供輸出。上次修改這個檔案的使用者。只有在上次修改是由已登入的使用者執行時,系統才會填寫這個欄位。 |
defaultOpenWithLink |
僅供輸出。這個檔案的連結,可透過使用者預設的應用程式開啟檔案。只有在使用 drive.apps.readonly 範圍時,才會填入這個欄位。 |
headRevisionId |
僅供輸出。檔案最新修訂版本的 ID。這個欄位只會填入儲存在 Google 雲端硬碟中的檔案內容,不會填入文件編輯器或捷徑檔案。 |
copyable |
僅供輸出。已淘汰:請改用 |
etag |
僅供輸出。檔案的 ETag。 |
sharingUser |
僅供輸出。與目前使用者共用項目的使用者 (如有)。 |
alternateLink |
僅供輸出。開啟檔案的連結,可使用相關的 Google 編輯器或檢視器。 |
embedLink |
僅供輸出。用於嵌入檔案的連結。 |
webContentLink |
僅供輸出。使用 Cookie 型驗證在瀏覽器中下載檔案內容的連結。如果內容是公開分享,使用者不需憑證即可下載。 |
fileSize |
僅供輸出。blob 和第一方編輯器檔案的大小 (以位元組為單位)。系統不會為沒有大小的檔案 (例如捷徑和資料夾) 填入這項資訊。 |
copyRequiresWriterPermission |
是否要禁止讀者和加註者複製、列印或下載這個檔案。 |
hasThumbnail |
僅供輸出。這個檔案是否有縮圖。這不代表要求應用程式是否能存取縮圖。如要檢查存取權,請查看是否有 thumbnailLink 欄位。 |
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 時間戳記格式)。請注意,設定 modifiedDate 也會更新設定日期的使用者之 modifiedByMe 日期。 |
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 |
僅供輸出。檔案是否有內容限制,且可由目前使用者移除。 |
capabilities.canDisableInheritedPermissions |
僅供輸出。使用者是否可以停用沿用權限。 |
capabilities.canEnableInheritedPermissions |
僅供輸出。使用者是否可以重新啟用沿用權限。 |
hasAugmentedPermissions |
僅供輸出。這個檔案是否具有直接權限。這個欄位只會填入共用雲端硬碟中的項目。 |
trashingUser |
僅供輸出。如果檔案已明確移至垃圾桶,則為移至垃圾桶的使用者。只有共用雲端硬碟中的項目會填入這項資料。 |
canReadRevisions |
僅供輸出。已淘汰:請改用 |
thumbnailVersion |
僅供輸出。用於縮圖快取失效的縮圖版本。 |
trashedDate |
僅供輸出。項目遭到刪除的時間 (RFC 3339 時間戳記格式)。只有共用雲端硬碟中的項目會填入這項資料。 |
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 值)。 |
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。 |
resourceKey |
僅供輸出。透過共用連結存取項目時所需的金鑰。 |
linkShareMetadata |
僅供輸出。LinkShare 相關詳細資料。包含用戶端用來參照這個項目的連結網址詳細資料。 |
linkShareMetadata.securityUpdateEligible |
僅供輸出。檔案是否符合安全性更新資格。 |
linkShareMetadata.securityUpdateEnabled |
僅供輸出。這個檔案是否已啟用安全性更新。 |
labelInfo |
僅供輸出。檔案標籤總覽。 |
labelInfo.labels[] |
僅供輸出。檔案上的一組標籤,由 |
sha1Checksum |
僅供輸出。與這個檔案相關聯的 SHA1 總和檢查碼 (如有)。這個欄位只會填入儲存在 Google 雲端硬碟中的檔案內容,不會填入文件編輯器或捷徑檔案。 |
sha256Checksum |
僅供輸出。與這個檔案相關聯的 SHA256 檢查碼 (如有)。這個欄位只會填入儲存在 Google 雲端硬碟中的檔案內容,不會填入文件編輯器或捷徑檔案。 |
inheritedPermissionsDisabled |
這個檔案是否已停用繼承權限。系統預設會啟用沿用權限。 |
ContentRestriction
存取檔案內容的限制。
JSON 表示法 |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
欄位 | |
---|---|
readOnly |
檔案內容是否為唯讀。如果檔案為唯讀,可能無法新增檔案修訂版本、新增或修改註解,以及修改檔案標題。 |
reason |
檔案內容受限的原因。只有在要求也設定 |
type |
僅供輸出。內容限制類型。目前唯一可用的值為 |
restrictingUser |
僅供輸出。設定內容限制的使用者。只有在 |
restrictionDate |
僅供輸出。設定內容限制的時間 (RFC 3339 時間戳記格式)。只有在 |
ownerRestricted |
內容限制是否只能由檔案擁有者修改或移除。如果是共用雲端硬碟中的檔案,具備 |
systemRestricted |
僅供輸出。內容限制是否由系統套用,例如因為電子簽名。使用者無法修改或移除系統限制內容限制。 |
方法 |
|
---|---|
|
建立指定檔案的副本。 |
|
永久刪除使用者擁有的檔案,且不會將檔案移至垃圾桶。 |
|
永久刪除使用者垃圾桶中的所有檔案。 |
|
將 Google Workspace 文件匯出為要求的 MIME 類型,並傳回匯出的位元組內容。 |
|
產生一組檔案 ID,可用於插入或複製要求。 |
|
依 ID 取得檔案的中繼資料或內容。 |
|
插入新檔案。 |
|
列出使用者的檔案。 |
|
列出檔案的標籤。 |
|
修改套用至檔案的標籤集。 |
|
更新檔案的中繼資料和/或內容。 |
|
將檔案的更新時間設為目前的伺服器時間。 |
|
將檔案移至垃圾桶。 |
|
從垃圾桶還原檔案。 |
|
更新檔案的中繼資料和/或內容。 |
|
訂閱檔案變更。 |