資源:File
檔案的中繼資料。
部分資源方法 (例如 files.update) 需要 fileId。使用 files.list 方法擷取檔案的 ID。
| JSON 表示法 | 
|---|
| { "exportLinks": { string: string, ... }, "parents": [ string ], "owners": [ { object ( | 
| 欄位 | |
|---|---|
| exportLinks | 
 僅供輸出。將 Google 文件編輯器檔案匯出為特定格式的連結。 這個物件中包含  | 
| parents[] | 
 含有該檔案的上層資料夾 ID。 檔案只能有一個上層資料夾,不支援指定多個上層資料夾。 如果未在建立要求中指定,檔案會直接放在使用者的「我的雲端硬碟」資料夾中。如果未在複製要求中指定,檔案會沿用來源檔案可探索到的任何上層項目。更新要求必須使用  | 
| owners[] | 
 僅供輸出。這個檔案的擁有者。只有特定舊版檔案可能有多位擁有者。如果是共用雲端硬碟中的項目,系統就不會填入這個欄位。 | 
| permissions[] | 
 僅供輸出。檔案的完整權限清單。只有在要求存取的使用者可以共用檔案時,才能使用這項功能。共用雲端硬碟中的項目不會填入這項資訊。 | 
| spaces[] | 
 僅供輸出。含有該檔案的聊天室清單。目前支援的值為  | 
| properties | 
 任意鍵/值組合的集合,所有應用程式都能看到。 在更新和複製要求中,含有空值的項目會遭到清除。 這個物件中包含  | 
| appProperties | 
 任意鍵/值組合的集合,要求應用程式專用。 在更新和複製要求中,含有空值的項目會遭到清除。 這些屬性只能透過已驗證的要求擷取。經過驗證的要求會使用透過 OAuth 2.0 用戶端 ID 取得的存取權杖。您無法使用 API 金鑰擷取私人資源。 這個物件中包含  | 
| permissionIds[] | 
 僅供輸出。可存取這個檔案的使用者權限 ID 清單。 | 
| contentRestrictions[] | 
 存取檔案內容的限制。只有在有這類限制時才會填入。 | 
| 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 類型建立,系統會盡可能匯入上傳的內容。支援的匯入格式會發布在  | 
| thumbnailLink | 
 僅供輸出。檔案縮圖的短期連結 (如有)。通常會持續數小時。由於跨源資源共享 (CORS) 政策,不適合直接在網路應用程式中使用。請考慮使用 Proxy 伺服器。只有在要求存取權的應用程式可以存取檔案內容時,才會填入這個欄位。如果檔案未公開分享,則必須使用經過驗證的要求,擷取  | 
| iconLink | 
 僅供輸出。檔案圖示的靜態未驗證連結。 | 
| shared | 
 僅供輸出。檔案是否已共用。共用雲端硬碟中的項目不會填入這項資訊。 | 
| lastModifyingUser | 
 僅供輸出。上次修改檔案的使用者。只有在上次修改是由已登入的使用者執行時,系統才會填寫這個欄位。 | 
| headRevisionId | 
 僅供輸出。檔案最新修訂版本的 ID。這項功能目前僅適用於 Google 雲端硬碟中有二進位內容的檔案。 | 
| sharingUser | 
 僅供輸出。與要求存取權的使用者共用檔案的使用者 (如適用)。 | 
| webViewLink | 
 僅供輸出。在瀏覽器中開啟檔案的連結,可使用相關的 Google 編輯器或檢視器。 | 
| webContentLink | 
 僅供輸出。在瀏覽器中下載檔案內容的連結。僅適用於 Google 雲端硬碟中有二進位內容的檔案。 | 
| size | 
 僅供輸出。blob 和 Google Workspace 編輯器檔案的大小 (以位元組為單位)。系統不會為沒有大小的檔案 (例如捷徑和資料夾) 填入這項資訊。 | 
| viewersCanCopyContent | 
 已淘汰:請改用  | 
| hasThumbnail | 
 僅供輸出。這個檔案是否有縮圖。這不代表要求應用程式有權存取縮圖。如要檢查存取權,請查看是否有 thumbnailLink 欄位。 | 
| 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 | 
 僅供輸出。從  當  | 
| isAppAuthorized | 
 僅供輸出。檔案是否由要求存取權的應用程式建立或開啟。 | 
| teamDriveId | 
 已淘汰:僅供輸出。請改用  | 
| capabilities | 
 僅供輸出。目前使用者對這個檔案擁有的功能。每項功能都對應到使用者可能採取的細部動作。詳情請參閱「瞭解檔案功能」。 | 
| capabilities.canChangeViewersCanCopyContent | 
 已淘汰:僅供輸出。 | 
| capabilities.canMoveChildrenOutOfDrive | 
 僅供輸出。目前使用者是否可將這個資料夾的子項移出共用雲端硬碟。如果項目不是資料夾,則為  | 
| capabilities.canReadDrive | 
 僅供輸出。目前使用者是否可以讀取檔案所屬的共用雲端硬碟。只有共用雲端硬碟中的項目會填入這項資料。 | 
| capabilities.canEdit | 
 僅供輸出。目前使用者是否可以編輯這個檔案。其他因素可能會限制使用者可對檔案進行的變更類型。例如  | 
| capabilities.canCopy | 
 僅供輸出。目前使用者是否可以複製這個檔案。如果是共用雲端硬碟中的項目,則表示目前使用者是否可以複製這個項目的非資料夾後代,或這個項目 (如果不是資料夾)。 | 
| capabilities.canComment | 
 僅供輸出。目前使用者是否可對這個檔案加上註解。 | 
| capabilities.canAddChildren | 
 僅供輸出。目前使用者是否可以在這個資料夾中新增子項。如果項目不是資料夾,則一律為  | 
| capabilities.canDelete | 
 僅供輸出。目前使用者是否可以刪除這個檔案。 | 
| capabilities.canDownload | 
 僅供輸出。目前使用者是否可以下載這個檔案。 | 
| capabilities.canListChildren | 
 僅供輸出。目前使用者是否可以列出這個資料夾的子項。如果項目不是資料夾,則一律為  | 
| capabilities.canRemoveChildren | 
 僅供輸出。目前使用者是否可以從這個資料夾移除子項。如果項目不是資料夾,則一律為  | 
| capabilities.canRename | 
 僅供輸出。目前使用者是否可以重新命名這個檔案。 | 
| capabilities.canTrash | 
 僅供輸出。目前使用者是否可將這個檔案移至垃圾桶。 | 
| capabilities.canReadRevisions | 
 僅供輸出。目前使用者是否可以讀取這個檔案的修訂版本資源。如果是共用雲端硬碟項目,則可讀取這個項目的非資料夾後代修訂版本,或這個項目 (如果不是資料夾)。 | 
| capabilities.canReadTeamDrive | 
 已淘汰:僅供輸出。請改用  | 
| capabilities.canMoveTeamDriveItem | 
 已淘汰:僅供輸出。請改用  | 
| capabilities.canChangeCopyRequiresWriterPermission | 
 僅供輸出。目前使用者是否可以變更這個檔案的 | 
| capabilities.canMoveItemIntoTeamDrive | 
 已淘汰:僅供輸出。請改用  | 
| capabilities.canUntrash | 
 僅供輸出。目前使用者是否可從垃圾桶還原這個檔案。 | 
| capabilities.canModifyContent | 
 僅供輸出。目前使用者是否可以修改這個檔案的內容。 | 
| capabilities.canMoveItemWithinTeamDrive | 
 已淘汰:僅供輸出。請改用  | 
| capabilities.canMoveItemOutOfTeamDrive | 
 已淘汰:僅供輸出。請改用  | 
| capabilities.canDeleteChildren | 
 僅供輸出。目前使用者是否可以刪除這個資料夾的子項。如果項目不是資料夾,則為  | 
| capabilities.canMoveChildrenOutOfTeamDrive | 
 已淘汰:僅供輸出。請改用  | 
| capabilities.canMoveChildrenWithinTeamDrive | 
 已淘汰:僅供輸出。請改用  | 
| capabilities.canTrashChildren | 
 僅供輸出。目前使用者是否可將這個資料夾的子項丟進垃圾桶。如果項目不是資料夾,則為  | 
| capabilities.canMoveItemOutOfDrive | 
 僅供輸出。目前使用者是否可以變更上層項目,將這個項目移出這個雲端硬碟。請注意,視要新增的父項而定,變更項目父項的要求仍可能失敗。 | 
| capabilities.canAddMyDriveParent | 
 僅供輸出。目前使用者是否可以在同一要求中新增項目的父項,而不移除現有父項。共用雲端硬碟檔案不會顯示這項資訊。 | 
| capabilities.canRemoveMyDriveParent | 
 僅供輸出。目前使用者是否可以從項目中移除家長,而不必在同一個要求中新增其他家長。共用雲端硬碟檔案不會顯示這項資訊。 | 
| capabilities.canMoveItemWithinDrive | 
 僅供輸出。目前使用者是否可以在這個雲端硬碟中移動這個項目。請注意,視要新增的父項和要移除的父項而定,變更項目父項的要求可能仍會失敗。 | 
| capabilities.canShare | 
 僅供輸出。目前使用者是否可以修改這個檔案的共用設定。 | 
| capabilities.canMoveChildrenWithinDrive | 
 僅供輸出。目前使用者是否可以在這個雲端硬碟中移動這個資料夾的子項。如果項目不是資料夾,則為  | 
| capabilities.canModifyContentRestriction | 
 已淘汰:僅供輸出。請使用  | 
| capabilities.canAddFolderFromAnotherDrive | 
 僅供輸出。目前使用者是否可將其他雲端硬碟 (不同共用雲端硬碟或「我的雲端硬碟」) 中的資料夾新增至這個資料夾。如果項目不是資料夾,則為  | 
| capabilities.canChangeSecurityUpdateEnabled | 
 僅供輸出。目前使用者是否可以變更連結分享中繼資料的  | 
| capabilities.canAcceptOwnership | 
 僅供輸出。目前使用者是否為檔案的待處理擁有者。共用雲端硬碟檔案不會顯示這項資訊。 | 
| capabilities.canReadLabels | 
 僅供輸出。目前使用者是否可以讀取檔案上的標籤。 | 
| capabilities.canModifyLabels | 
 僅供輸出。目前使用者是否可以修改檔案上的標籤。 | 
| capabilities.canModifyEditorContentRestriction | 
 僅供輸出。目前使用者是否可以新增或修改檔案的內容限制 (僅限編輯者)。 | 
| capabilities.canModifyOwnerContentRestriction | 
 僅供輸出。目前使用者是否可以新增或修改受擁有者限制的內容限制。 | 
| capabilities.canRemoveContentRestriction | 
 僅供輸出。檔案是否有內容限制,且可由目前使用者移除。 | 
| capabilities.canDisableInheritedPermissions | 
 使用者是否可以停用沿用權限。 | 
| capabilities.canEnableInheritedPermissions | 
 使用者是否可以重新啟用沿用權限。 | 
| capabilities.canChangeItemDownloadRestriction | 
 僅供輸出。目前使用者是否可以變更檔案的擁有者,或變更擁有者/主辦人套用的下載限制。 | 
| hasAugmentedPermissions | 
 僅供輸出。這個檔案是否具有直接權限。這個欄位只會填入共用雲端硬碟中的項目。 | 
| trashingUser | 
 僅供輸出。如果檔案已明確移至垃圾桶,則為將檔案移至垃圾桶的使用者。只有共用雲端硬碟中的項目會填入這項資料。 | 
| thumbnailVersion | 
 僅供輸出。用於縮圖快取失效的縮圖版本。 | 
| trashedTime | 
 僅供輸出。項目遭到刪除的時間 (RFC 3339 日期時間)。只有共用雲端硬碟中的項目會填入這項資料。 | 
| modifiedByMe | 
 僅供輸出。檔案是否曾由該使用者修改。 | 
| 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 DateTime)。 | 
| 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 | 
 僅供輸出。透過共用連結存取項目時所需的金鑰。 | 
| linkShareMetadata | 
 僅供輸出。LinkShare 相關詳細資料。包含用戶端用來參照這個項目的連結網址詳細資料。 | 
| linkShareMetadata.securityUpdateEligible | 
 僅供輸出。檔案是否符合安全性更新資格。 | 
| linkShareMetadata.securityUpdateEnabled | 
 僅供輸出。這個檔案是否已啟用安全性更新。 | 
| labelInfo | 
 僅供輸出。檔案標籤總覽。 | 
| labelInfo.labels[] | 
 僅供輸出。檔案上的一組標籤,由  | 
| sha1Checksum | 
 僅供輸出。與這個檔案相關聯的 SHA1 總和檢查碼 (如有)。這個欄位只會填入儲存在 Google 雲端硬碟中的檔案內容,不會填入文件編輯器或捷徑檔案。 | 
| sha256Checksum | 
 僅供輸出。與這個檔案相關聯的 SHA256 檢查碼 (如有)。這個欄位只會填入儲存在 Google 雲端硬碟中的檔案內容,不會填入文件編輯器或捷徑檔案。 | 
| inheritedPermissionsDisabled | 
 這個檔案是否已停用繼承權限。系統預設會啟用沿用權限。 | 
| downloadRestrictions | 
 檔案已套用下載限制。 | 
ContentRestriction
存取檔案內容的限制。
| JSON 表示法 | 
|---|
| {
  "readOnly": boolean,
  "reason": string,
  "type": string,
  "restrictingUser": {
    object ( | 
| 欄位 | |
|---|---|
| readOnly | 
 檔案內容是否為唯讀。如果檔案為唯讀,可能無法新增檔案修訂版本、新增或修改註解,以及修改檔案標題。 | 
| reason | 
 檔案內容受限的原因。只有在要求也設定  | 
| type | 
 僅供輸出。內容限制類型。目前唯一可用的值為  | 
| restrictingUser | 
 僅供輸出。設定內容限制的使用者。只有在  | 
| restrictionTime | 
 僅供輸出。設定內容限制的時間 (格式為 RFC 3339 日期時間)。只有在  | 
| ownerRestricted | 
 內容限制是否只能由檔案擁有者修改或移除。如果是共用雲端硬碟中的檔案,具備 | 
| systemRestricted | 
 僅供輸出。內容限制是否由系統套用,例如因為電子簽名。使用者無法修改或移除系統限制內容限制。 | 
DownloadRestrictionsMetadata
檔案已套用下載限制。
| JSON 表示法 | 
|---|
| { "itemDownloadRestriction": { object ( | 
| 欄位 | |
|---|---|
| itemDownloadRestriction | 
 檔案擁有者或主辦人直接套用檔案下載限制。這項功能不會考量共用雲端硬碟設定或資料遺失防護規則。 | 
| effectiveDownloadRestrictionWithContext | 
 僅供輸出。這個檔案已套用有效下載限制。系統會考量所有限制設定和資料遺失防護規則。 | 
DownloadRestriction
限制檔案的複製和下載權限。
| JSON 表示法 | 
|---|
| { "restrictedForReaders": boolean, "restrictedForWriters": boolean } | 
| 欄位 | |
|---|---|
| restrictedForReaders | 
 是否限制讀者下載及複製。 | 
| restrictedForWriters | 
 是否限制作者下載及複製。如果 | 
| 方法 | |
|---|---|
| 
 | 建立檔案副本,並以修補程式語意套用所有要求的更新。 | 
| 
 | 建立檔案。 | 
| 
 | 永久刪除使用者擁有的檔案,且不會將檔案移至垃圾桶。 | 
| 
 | 下載檔案內容。 | 
| 
 | 永久刪除使用者垃圾桶中的所有檔案。 | 
| 
 | 將 Google Workspace 文件匯出為要求的 MIME 類型,並傳回匯出的位元組內容。 | 
| 
 | 產生一組檔案 ID,可在建立或複製要求中提供。 | 
| 
 | 依 ID 取得檔案的中繼資料或內容。 | 
| 
 | 列出使用者的檔案。 | 
| 
 | 列出檔案的標籤。 | 
| 
 | 修改套用至檔案的標籤集。 | 
| 
 | 更新檔案的中繼資料、內容或兩者。 | 
| 
 | 訂閱檔案變更。 |