資源:檔案
檔案的中繼資料,
部分資源方法 (例如 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 |
要為檔案建立索引的文字,以改善 fullText 查詢。長度不得超過 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。 一個檔案只能有一個上層資料夾;不支援指定多個上層。 如未在建立要求中指定,檔案會直接存放在使用者的「我的雲端硬碟」資料夾。如未在複製要求中指定,檔案會沿用來源檔案的任何可偵測父項。files.update 要求必須使用 |
thumbnailLink |
僅供輸出。檔案縮圖的短期連結 (如有)。一般情況下,持續時間為小時數。由於跨源資源共用 (CORS) 政策禁止直接用於網頁應用程式,請考慮使用 Proxy 伺服器。只有在要求的應用程式可以存取檔案內容時,才需要填入資料。如果檔案未公開共用,則必須使用憑證要求擷取 |
iconLink |
僅供輸出。連至檔案圖示且未經驗證的靜態連結。 |
shared |
僅供輸出。檔案是否已共用。未針對共用雲端硬碟中的項目填入資料。 |
lastModifyingUser |
僅供輸出。最後一位修改檔案的使用者。這個欄位只有在上次修改的情況下,是由已登入的使用者執行。 |
owners[] |
僅供輸出。這個檔案的擁有者。只有特定舊版檔案可能有多位擁有者。系統不會針對共用雲端硬碟中的項目填入這個欄位。 |
headRevisionId |
僅供輸出。檔案頭部修訂版本的 ID。這項功能目前僅適用於 Google 雲端硬碟中有二進位內容的檔案。 |
sharingUser |
僅供輸出。與提出要求的使用者共用檔案的使用者 (如適用)。 |
webViewLink |
僅供輸出。連結,以便在瀏覽器中使用相關的 Google 編輯器或檢視器開啟檔案。 |
webContentLink |
僅供輸出。在瀏覽器中下載檔案內容的連結。這項功能僅適用於 Google 雲端硬碟中有二進位內容的檔案。 |
size |
僅供輸出。blob 和第一方編輯器檔案的大小 (以位元組為單位)。如果檔案沒有大小限制 (例如捷徑和資料夾),系統不會填入資料。 |
viewersCanCopyContent |
已淘汰:請改用 |
permissions[] |
僅供輸出。檔案權限的完整清單。只有在提出要求的使用者能共用檔案時,才能使用這個選項。未針對共用雲端硬碟中的項目填入資料。 |
hasThumbnail |
僅供輸出。這個檔案是否包含縮圖。但這不會指出發出要求的應用程式是否有權存取縮圖。如要檢查存取權,請找出縮圖連結欄位是否存在。 |
spaces[] |
僅供輸出。包含檔案的聊天室清單。目前支援的值為「drive」、「appDataFolder」和「相片」 |
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[] |
僅供輸出。擁有這個檔案存取權的使用者權限 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 |
內容限制是否只能由擁有該檔案的使用者修改或移除。如果是共用雲端硬碟中的檔案,凡是具備 |
systemRestricted |
僅供輸出。內容限制是否由系統套用,例如因電子簽名。使用者無法修改或移除系統受限內容限制。 |
方法 |
|
---|---|
|
建立檔案副本,並使用 patch 語意套用所有要求的更新。 |
|
建立新檔案。 |
|
永久刪除使用者擁有的檔案,而不移至垃圾桶。 |
|
永久刪除使用者移至垃圾桶的所有檔案。 |
|
將 Google Workspace 文件匯出為要求的 MIME 類型,並傳回匯出的位元組內容。 |
|
產生一組可在建立或複製要求中提供的檔案 ID。 |
|
根據 ID 取得檔案的中繼資料或內容。 |
|
列出使用者的檔案。 |
|
列出檔案中的標籤。 |
|
修改檔案套用的標籤組合。 |
|
更新檔案的中繼資料和/或內容。 |
|
訂閱檔案變更。 |