資源:檔案
檔案的中繼資料。
部分資源方法 (例如 files.update
) 需要 fileId
。使用 files.list
方法擷取檔案的 ID。
JSON 表示法 |
---|
{ "kind": string, "userPermission": { object ( |
欄位 | |
---|---|
kind |
僅供輸出。檔案類型。這個值一律為 |
userPermission |
僅供輸出。已驗證使用者對此檔案的權限。 |
fileExtension |
僅供輸出。 |
md5Checksum |
僅供輸出。此檔案內容的 MD5 總和檢查碼。這個欄位只會填入內容儲存在 Google 雲端硬碟的檔案,不會填入 Google 文件編輯器或捷徑檔案。 |
selfLink |
僅供輸出。返回此檔案的連結。 |
ownerNames[] |
僅供輸出。這個檔案的擁有者名稱。不會填入共用雲端硬碟中的項目。 |
lastModifyingUserName |
僅供輸出。上次修改此檔案的使用者名稱。 |
editable |
僅供輸出。已淘汰:請改用 |
writersCanShare |
作者是否可以與其他使用者共用文件。不會填入共用雲端硬碟中的項目。 |
downloadUrl |
僅供輸出。檔案的短效下載網址。只有儲存在 Google 雲端硬碟中的檔案才會填入這個欄位,Google 文件或捷徑檔案不會填入這個欄位。 |
mimeType |
檔案的 MIME 類型。只有在上傳新內容時,才能在更新時變更。這個欄位可以留空,系統會根據上傳內容的 MIME 類型決定 mimetype。 |
exportLinks |
僅供輸出。將 Google 文件編輯器檔案匯出為特定格式的連結。 這個物件中包含 |
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 雲端硬碟中的檔案填入內容,不會為 Google 文件編輯器或捷徑檔案填入內容。 |
properties[] |
房源清單。 |
copyable |
僅供輸出。已淘汰:請改用 |
etag |
僅供輸出。檔案的 ETag。 |
sharingUser |
僅供輸出。與目前使用者共用項目的使用者 (如有)。 |
alternateLink |
僅供輸出。在相關 Google 編輯器或檢視器中開啟檔案的連結。 |
embedLink |
僅供輸出。嵌入檔案的連結。 |
webContentLink |
僅供輸出。使用 Cookie 型驗證在瀏覽器中下載檔案內容的連結。如果內容是公開分享,則無須任何憑證就能下載。 |
fileSize |
僅供輸出。blob 和第一方編輯器檔案的大小 (以位元組為單位)。系統不會為沒有大小的檔案填入這項資料,例如捷徑和資料夾。 |
copyRequiresWriterPermission |
是否應停用讀者和評論者的檔案複製、列印或下載選項。 |
permissions[] |
僅供輸出。擁有此檔案存取權的使用者權限清單。不會填入共用雲端硬碟中的項目。 |
hasThumbnail |
僅供輸出。這個檔案是否有縮圖。這不會指出要求應用程式是否有權存取縮圖。如要檢查存取權,請查看是否有 thumbnailLink 欄位。 |
spaces[] |
僅供輸出。包含檔案的聊天室清單。支援的值為 |
folderColorRgb |
如果檔案是資料夾或資料夾的捷徑,則資料夾顏色會以 RGB 十六進位字串的形式顯示。如要查看支援的顏色清單,請在「關於」資源的 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 雲端硬碟的檔案,不會填入 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 時間戳記格式)。只有共用雲端硬碟中的項目會填入這項資料。 |
permissionIds[] |
僅供輸出。files.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 |
僅供輸出。從圖片原始方向順時針旋轉的次數。 |
imageMediaMetadata.date |
僅供輸出。相片的拍攝日期和時間 (EXIF 格式時間戳記)。 |
imageMediaMetadata.cameraMake |
僅供輸出。用於拍攝相片的相機品牌。 |
imageMediaMetadata.cameraModel |
僅供輸出。用於拍攝相片的相機型號。 |
imageMediaMetadata.exposureTime |
僅供輸出。曝光時間長度 (以秒為單位)。 |
imageMediaMetadata.aperture |
僅供輸出。用於拍攝相片的光圈 (f 值)。 |
imageMediaMetadata.focalLength |
僅供輸出。用於建立相片的焦距,以毫米為單位。 |
imageMediaMetadata.isoSpeed |
僅供輸出。用於拍攝相片的 ISO 速度。 |
imageMediaMetadata.exposureBias |
僅供輸出。相片的曝光偏差 (APEX 值)。 |
imageMediaMetadata.maxApertureValue |
僅供輸出。用於拍攝相片的焦距下,鏡頭的最小光圈值 (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 雲端硬碟的檔案,不會填入 Google 文件編輯器或捷徑檔案。 |
sha256Checksum |
僅供輸出。與此檔案相關聯的 SHA256 檢查碼 (如有)。這個欄位只會為儲存在 Google 雲端硬碟中的檔案填入內容,不會為 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 取得檔案的中繼資料或內容。 |
|
插入新檔案。 |
|
列出使用者的檔案。 |
|
列出檔案中的標籤。 |
|
修改套用至檔案的標籤組合。 |
|
更新檔案的中繼資料和/或內容。 |
|
將檔案的更新時間設為目前的伺服器時間。 |
|
將檔案移至垃圾桶。 |
|
從垃圾桶還原檔案。 |
|
更新檔案的中繼資料和/或內容。 |
|
訂閱檔案變更。 |