資源:檔案
檔案的中繼資料,
部分資源方法 (例如 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[] |
檔案所屬上層資料夾的 ID。 一個檔案只能有一個上層資料夾;不支援指定多個上層。 如果您並未要求加入插入,檔案就會直接放在使用者的「我的雲端硬碟」資料夾。如未在複製要求中指定,檔案會沿用來源檔案的任何可偵測父項。files.update 要求必須使用 |
thumbnailLink |
僅供輸出。檔案縮圖的短期連結 (如有)。一般情況下,持續時間為小時數。不適合因為跨源資源共享 (CORS) 而直接用於網頁應用程式,請考慮使用 Proxy 伺服器。只有在要求的應用程式可以存取檔案內容時,才需要填入資料。如果檔案未公開共用,則必須使用憑證要求擷取 |
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 時間戳記)。只有在 setModifyDate 參數設定的情況下,這個屬性才能在更新時修改。 |
modifiedByMeDate |
僅供輸出。使用者上次修改這個檔案的時間 (格式為 RFC 3339 時間戳記)。請注意,設定 modifyDate 後,也會為設定日期的使用者更新 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[] |
僅供輸出。擁有這個檔案存取權的使用者權限 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 取得檔案的中繼資料或內容。 |
|
插入新檔案。 |
|
列出使用者的檔案。 |
|
列出檔案中的標籤。 |
|
修改檔案套用的標籤組合。 |
|
更新檔案的中繼資料和/或內容。 |
|
將檔案更新時間設為目前的伺服器時間。 |
|
將檔案移至垃圾桶。 |
|
還原垃圾桶中的檔案。 |
|
更新檔案的中繼資料和/或內容。 |
|
訂閱檔案變更。 |