如需本資源的方法清單,請見本頁結尾。
資源表示法
檔案的中繼資料。
{ "kind": "drive#file", "id": string, "name": string, "mimeType": string, "description": string, "starred": boolean, "trashed": boolean, "explicitlyTrashed": boolean, "trashingUser": { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string }, "trashedTime": datetime, "parents": [ string ], "properties": { (key): string }, "appProperties": { (key): string }, "spaces": [ string ], "version": long, "webContentLink": string, "webViewLink": string, "iconLink": string, "hasThumbnail": boolean, "thumbnailLink": string, "thumbnailVersion": long, "viewedByMe": boolean, "viewedByMeTime": datetime, "createdTime": datetime, "modifiedTime": datetime, "modifiedByMeTime": datetime, "modifiedByMe": boolean, "sharedWithMeTime": datetime, "sharingUser": { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string }, "owners": [ { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string } ], "teamDriveId": string, "driveId": string, "lastModifyingUser": { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string }, "shared": boolean, "ownedByMe": boolean, "capabilities": { "canAcceptOwnership": boolean, "canAddChildren": boolean, "canAddFolderFromAnotherDrive": boolean, "canAddMyDriveParent": boolean, "canChangeCopyRequiresWriterPermission": boolean, "canChangeSecurityUpdateEnabled": boolean, "canChangeViewersCanCopyContent": boolean, "canComment": boolean, "canCopy": boolean, "canDelete": boolean, "canDeleteChildren": boolean, "canDownload": boolean, "canEdit": boolean, "canListChildren": boolean, "canModifyContent": boolean, "canModifyContentRestriction": boolean, "canModifyLabels": boolean, "canMoveChildrenOutOfTeamDrive": boolean, "canMoveChildrenOutOfDrive": boolean, "canMoveChildrenWithinTeamDrive": boolean, "canMoveChildrenWithinDrive": boolean, "canMoveItemIntoTeamDrive": boolean, "canMoveItemOutOfTeamDrive": boolean, "canMoveItemOutOfDrive": boolean, "canMoveItemWithinTeamDrive": boolean, "canMoveItemWithinDrive": boolean, "canMoveTeamDriveItem": boolean, "canReadLabels": boolean, "canReadRevisions": boolean, "canReadTeamDrive": boolean, "canReadDrive": boolean, "canRemoveChildren": boolean, "canRemoveMyDriveParent": boolean, "canRename": boolean, "canShare": boolean, "canTrash": boolean, "canTrashChildren": boolean, "canUntrash": boolean }, "viewersCanCopyContent": boolean, "copyRequiresWriterPermission": boolean, "writersCanShare": boolean, "permissions": [ permissions Resource ], "permissionIds": [ string ], "hasAugmentedPermissions": boolean, "folderColorRgb": string, "originalFilename": string, "fullFileExtension": string, "fileExtension": string, "md5Checksum": string, "sha1Checksum": string, "sha256Checksum": string, "size": long, "quotaBytesUsed": long, "headRevisionId": string, "contentHints": { "thumbnail": { "image": bytes, "mimeType": string }, "indexableText": string }, "imageMediaMetadata": { "width": integer, "height": integer, "rotation": integer, "location": { "latitude": double, "longitude": double, "altitude": double }, "time": string, "cameraMake": string, "cameraModel": string, "exposureTime": float, "aperture": float, "flashUsed": boolean, "focalLength": float, "isoSpeed": integer, "meteringMode": string, "sensor": string, "exposureMode": string, "colorSpace": string, "whiteBalance": string, "exposureBias": float, "maxApertureValue": float, "subjectDistance": integer, "lens": string }, "videoMediaMetadata": { "width": integer, "height": integer, "durationMillis": long }, "isAppAuthorized": boolean, "exportLinks": { (key): string }, "shortcutDetails": { "targetId": string, "targetMimeType": string, "targetResourceKey": string }, "contentRestrictions": [ { "readOnly": boolean, "reason": string, "restrictingUser": { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string }, "restrictionTime": datetime, "type": string } ], "labelInfo": { "labels": [ { "kind": "drive#label", "id": string, "revisionId": string, "fields": { (key): { "kind": "drive#labelField", "id": string, "valueType": string, "dateString": [ date ], "integer": [ long ], "selection": [ string ], "text": [ string ], "user": [ { "kind": "drive#user", "displayName": string, "photoLink": string, "me": boolean, "permissionId": string, "emailAddress": string } ] } } } ] }, "resourceKey": string, "linkShareMetadata": { "securityUpdateEligible": boolean, "securityUpdateEnabled": boolean } }
資源名稱 | 值 | 說明 | Notes |
---|---|---|---|
kind |
string |
識別資源的類型。值:固定字串 "drive#file" 。 |
|
id |
string |
檔案的 ID。 | 可寫入 |
name |
string |
檔案名稱。但這不一定是資料夾名稱中的專屬值。請注意,如果是不可變更的項目 (例如共用雲端硬碟的頂層資料夾、「我的雲端硬碟」根資料夾和「應用程式資料」資料夾名稱),則名稱保持不變。 | 可寫入 |
mimeType |
string |
檔案的 MIME 類型。 如未提供任何值,Google 雲端硬碟會嘗試從上傳內容中偵測出適當的值。除非上載新的修訂版本,否則此值無法更改。 如果檔案是使用 Google Doc MIME 類型建立,系統會視情況匯入您上傳的內容。支援的匯入格式會發布在「關於」資源中。 |
可寫入 |
description |
string |
檔案的簡短說明。 | 可寫入 |
starred |
boolean |
使用者是否已為檔案加上星號。 | 可寫入 |
trashed |
boolean |
檔案是否已明確移至垃圾桶,或從垃圾桶的上層資料夾移至垃圾桶。只有擁有者可以將檔案移至垃圾桶。系統會針對所有非檔案擁有者傳回的「file.list」回應排除已移至垃圾桶的項目。不過,所有可存取檔案的使用者都能在 API 回應中看到移至垃圾桶的項目中繼資料。所有具備存取權的使用者都可以複製、下載、匯出及分享檔案。 | 可寫入 |
explicitlyTrashed |
boolean |
檔案是否已明確移至垃圾桶,而非從上層資料夾永久刪除。 | |
parents[] |
list |
包含檔案的上層資料夾 ID。 如果未在建立要求中指定,檔案就會直接放入使用者的「我的雲端硬碟」資料夾。如果未在複製要求中指定,檔案會沿用來源檔案可供搜尋的上層檔案。更新要求必須使用 |
可寫入 |
properties |
object |
可供所有應用程式存取的任意鍵/值組合。 更新值和複製要求中會清除含有空值的項目。 |
可寫入 |
properties.(key) |
string |
||
appProperties |
object |
對要求應用程式不對外公開的任意鍵/值組合。 更新值和複製要求中會清除含有空值的項目。這些屬性僅可使用經過驗證的要求擷取。經過驗證的要求會使用透過 OAuth 2 用戶端 ID 取得的存取權杖。您無法使用 API 金鑰擷取私人屬性。 |
可寫入 |
appProperties.(key) |
string |
||
spaces[] |
list |
包含檔案的聊天室清單。目前支援的值為「drive」、「appDataFolder」和「photos」。 | |
version |
long |
檔案的單數遞增版本編號。這項資料反映了在伺服器上對檔案所做的任何變更,即使是使用者看不到的變更。 | |
webContentLink |
string |
在瀏覽器中下載檔案的檔案連結。這項功能僅適用於含有二進位內容在 Google 雲端硬碟中的檔案。 | |
webViewLink |
string |
使用相關 Google 編輯器或瀏覽器開啟檔案的連結。 | |
iconLink |
string |
檔案圖示的靜態未驗證連結。 | |
thumbnailLink |
string |
檔案縮圖的短期連結 (如果有的話)。通常維持數小時的時間。只有在提出要求的應用程式可存取檔案內容時,才會填入資料。如果檔案並未公開共用,則必須使用憑證要求擷取 Files.thumbnailLink 傳回的網址。 |
|
viewedByMe |
boolean |
使用者是否已查看過該檔案。 | |
viewedByMeTime |
datetime |
使用者上次檢視檔案的時間 (RFC 3339 日期時間)。 | 可寫入 |
createdTime |
datetime |
建立檔案的時間 (RFC 3339 日期時間)。 | 可寫入 |
modifiedTime |
datetime |
任何人上次修改檔案的時間 (RFC 3339 日期時間)。 請注意,設定 ModifiedTime 也會更新使用者的 ModifiedByMeTime。 |
可寫入 |
modifiedByMeTime |
datetime |
使用者上次修改檔案的時間 (RFC 3339 日期時間)。 | |
sharedWithMeTime |
datetime |
與使用者共用檔案的時間 (如果適用,則為 RFC 3339 日期時間)。 | |
sharingUser |
nested object |
與提出要求的使用者共用的檔案 (如適用)。 | |
sharingUser.kind |
string |
識別資源的類型。值:固定字串 "drive#user" 。 |
|
sharingUser.displayName |
string |
顯示此使用者的純文字名稱。 | |
sharingUser.photoLink |
string |
使用者個人資料相片 (如果有的話) 的連結。 | |
sharingUser.me |
boolean |
這位使用者是否為提出要求的使用者。 | |
sharingUser.permissionId |
string |
權限 ID 中顯示的使用者 ID。 | |
sharingUser.emailAddress |
string |
使用者的電子郵件地址。如果使用者並未向要求者顯示自己的電子郵件地址,則在某些情況下可能不會顯示這項資訊。 | |
owners[] |
list |
這個檔案的擁有者。只有部分舊檔案可能擁有多位擁有者。系統不會為共用雲端硬碟中的項目填入這個欄位。 | |
owners[].kind |
string |
識別資源的類型。值:固定字串 "drive#user" 。 |
|
owners[].displayName |
string |
顯示此使用者的純文字名稱。 | |
owners[].photoLink |
string |
使用者個人資料相片 (如果有的話) 的連結。 | |
owners[].me |
boolean |
這位使用者是否為提出要求的使用者。 | |
owners[].permissionId |
string |
權限 ID 中顯示的使用者 ID。 | |
owners[].emailAddress |
string |
使用者的電子郵件地址。如果使用者並未向要求者顯示自己的電子郵件地址,則在某些情況下可能不會顯示這項資訊。 | |
lastModifyingUser |
nested object |
上次修改檔案的使用者。 | |
lastModifyingUser.kind |
string |
識別資源的類型。值:固定字串 "drive#user" 。 |
|
lastModifyingUser.displayName |
string |
顯示此使用者的純文字名稱。 | |
lastModifyingUser.photoLink |
string |
使用者個人資料相片 (如果有的話) 的連結。 | |
lastModifyingUser.me |
boolean |
這位使用者是否為提出要求的使用者。 | |
lastModifyingUser.permissionId |
string |
權限 ID 中顯示的使用者 ID。 | |
lastModifyingUser.emailAddress |
string |
使用者的電子郵件地址。如果使用者並未向要求者顯示自己的電子郵件地址,則在某些情況下可能不會顯示這項資訊。 | |
shared |
boolean |
檔案是否已共用。沒有針對共用雲端硬碟中的項目填入資料。 | |
ownedByMe |
boolean |
使用者是否為檔案的擁有者。沒有針對共用雲端硬碟中的項目填入資料。 | |
viewersCanCopyContent |
boolean |
已淘汰 - 請改用 copyRequiresWriterPermission 。 |
|
writersCanShare |
boolean |
使用者是否只具備 writer 權限,可以修改檔案的權限。沒有針對共用雲端硬碟中的項目填入資料。 |
可寫入 |
permissions[] |
list |
檔案的完整權限清單。只有在提出要求的使用者可以共用檔案時,您才能使用此功能。沒有針對共用雲端硬碟中的項目填入資料。 | |
folderColorRgb |
string |
資料夾或捷徑的顏色 (以 RGB 十六進位字串表示)。支援的顏色發布在 About 資源的 folderColorPalette 欄位中。如果指定不受支援的顏色,系統會改用調色盤中最接近的顏色。 |
可寫入 |
originalFilename |
string |
上傳內容的原始檔案名稱 (如果有的話),或是 name 欄位的原始值。這項功能僅適用於含有二進位內容在 Google 雲端硬碟中的檔案。 |
可寫入 |
fullFileExtension |
string |
從 name 欄位擷取的完整副檔名。可包含多個串連擴充功能,例如「tar.gz」。這項功能僅適用於含有二進位內容在 Google 雲端硬碟中的檔案。這個欄位會在 |
|
fileExtension |
string |
fullFileExtension 的最終元件。這項功能僅適用於含有二進位內容在 Google 雲端硬碟中的檔案。 |
|
md5Checksum |
string |
檔案內容的 MD5 總和檢查碼。這個做法僅適用於含有二進位內容在 Google 雲端硬碟中的檔案。 | |
size |
long |
檔案內容的大小,以位元組為單位。若檔案含有儲存在 Google 雲端硬碟和文件編輯器檔案中的二進位內容,則這個欄位會填入;如果是捷徑或資料夾,則不會填入這個欄位。 | |
quotaBytesUsed |
long |
檔案使用的儲存空間配額位元組數。這包括標頭修訂版本以及已啟用 keepForever 的先前修訂版本。 |
|
headRevisionId |
string |
檔案標頭修訂版本的 ID。這項功能目前僅適用於含有二進位內容在 Google 雲端硬碟中的檔案。 | |
contentHints |
object |
檔案內容的其他相關資訊。系統絕對不會在回應中填入這些欄位。 | |
contentHints.thumbnail |
object |
檔案的縮圖。只有在 Google 雲端硬碟無法產生標準縮圖時,才會使用這個選項。 | |
contentHints.thumbnail.image |
bytes |
使用安全網址 Base64 編碼的縮圖資料 (RFC 4648 第 5 節)。 | 可寫入 |
contentHints.thumbnail.mimeType |
string |
縮圖的 MIME 類型。 | 可寫入 |
contentHints.indexableText |
string |
為檔案建立索引的文字,以改善 FullText 的查詢內容。長度上限為 128 KB,且可能包含 HTML 元素。詳情請參閱管理檔案中繼資料。 | 可寫入 |
imageMediaMetadata |
object |
圖片媒體的其他中繼資料 (如果有的話)。 | |
imageMediaMetadata.width |
integer |
圖片寬度 (以像素為單位)。 | |
imageMediaMetadata.height |
integer |
圖片的高度 (以像素為單位)。 | |
imageMediaMetadata.rotation |
integer |
從圖片原始方向順時針旋轉 90 度的旋轉次數。 | |
imageMediaMetadata.location |
object |
儲存在圖片中的地理位置資訊。 | |
imageMediaMetadata.location.latitude |
double |
儲存在圖片中的緯度。 | |
imageMediaMetadata.location.longitude |
double |
圖片儲存的經度。 | |
imageMediaMetadata.location.altitude |
double |
圖片中的高度。 | |
imageMediaMetadata.time |
string |
相片拍攝的日期和時間 (EXIF DateTime)。 | |
imageMediaMetadata.cameraMake |
string |
用來製作相片的相機。 | |
imageMediaMetadata.cameraModel |
string |
用於製作相片的相機型號。 | |
imageMediaMetadata.exposureTime |
float |
曝光時間長度 (以秒為單位)。 | |
imageMediaMetadata.aperture |
float |
用於製作相片的光圈 (f-number)。 | |
imageMediaMetadata.flashUsed |
boolean |
是否使用閃光燈製作相片。 | |
imageMediaMetadata.focalLength |
float |
用於製作相片的焦距,單位為毫米。 | |
imageMediaMetadata.isoSpeed |
integer |
相片的 ISO 速度。 | |
imageMediaMetadata.meteringMode |
string |
用來製作相片的計量模式。 | |
imageMediaMetadata.sensor |
string |
用於製作相片的感應器類型。 | |
imageMediaMetadata.exposureMode |
string |
用於製作相片的曝光模式。 | |
imageMediaMetadata.colorSpace |
string |
相片的色域。 | |
imageMediaMetadata.whiteBalance |
string |
用來製作相片的白平衡模式。 | |
imageMediaMetadata.exposureBias |
float |
相片的曝光偏誤 (APEX 值)。 | |
imageMediaMetadata.maxApertureValue |
float |
鏡頭長度的最小 f 值,可用來製作相片 (焦距)。 | |
imageMediaMetadata.subjectDistance |
integer |
相片主題的距離,單位為公尺。 | |
imageMediaMetadata.lens |
string |
用於製作相片的鏡頭。 | |
videoMediaMetadata |
object |
影片媒體的其他中繼資料。上傳時可能無法立即使用。 | |
videoMediaMetadata.width |
integer |
影片的寬度 (以像素為單位)。 | |
videoMediaMetadata.height |
integer |
影片的高度 (以像素為單位)。 | |
videoMediaMetadata.durationMillis |
long |
影片長度 (以毫秒為單位)。 | |
capabilities |
object |
目前使用者在這個檔案中擁有的功能。每項功能都會對應使用者可採取的精細操作。 | |
capabilities.canEdit |
boolean |
目前使用者是否可編輯這個檔案。其他因素可能會限制使用者能對檔案進行的變更類型。例如,請參閱 canChangeCopyRequiresWriterPermission 或 canModifyContent 。 |
|
capabilities.canComment |
boolean |
目前使用者是否可在這個檔案中加註。 | |
capabilities.canShare |
boolean |
目前使用者是否可修改這個檔案的共用設定。 | |
capabilities.canCopy |
boolean |
目前使用者可以複製這個檔案。針對共用雲端硬碟中的項目,目前的使用者是否可複製這個項目的非資料夾子系,如不是資料夾,則請自行複製這個項目。 | |
capabilities.canReadRevisions |
boolean |
目前使用者是否可讀取這個檔案的修訂版本資源。可讀取共用雲端硬碟項目中是否有非資料夾子系的修訂版本,或這個項目本身不是資料夾的讀取項目。 | |
isAppAuthorized |
boolean |
檔案是由要求的應用程式所建立或開啟。 | |
hasThumbnail |
boolean |
這個檔案是否有縮圖。但並不表示提出要求的應用程式是否能存取縮圖。如要檢查存取權,請尋找縮圖連結欄位。 | |
thumbnailVersion |
long |
縮圖快取無效使用的縮圖版本。 | |
modifiedByMe |
boolean |
使用者是否已修改此檔案。 | |
trashingUser |
nested object |
如果檔案已明確移至垃圾桶,使用者將該檔案移至垃圾桶。僅針對共用雲端硬碟中的項目填入資料。 | |
trashingUser.kind |
string |
識別資源的類型。值:固定字串 "drive#user" 。 |
|
trashingUser.displayName |
string |
顯示此使用者的純文字名稱。 | |
trashingUser.photoLink |
string |
使用者個人資料相片 (如果有的話) 的連結。 | |
trashingUser.me |
boolean |
這位使用者是否為提出要求的使用者。 | |
trashingUser.permissionId |
string |
權限 ID 中顯示的使用者 ID。 | |
trashingUser.emailAddress |
string |
使用者的電子郵件地址。如果使用者並未向要求者顯示自己的電子郵件地址,則在某些情況下可能不會顯示這項資訊。 | |
trashedTime |
datetime |
項目移至垃圾桶的時間 (RFC 3339 日期時間)。僅針對共用雲端硬碟中的項目填入資料。 | |
teamDriveId |
string |
已淘汰 - 請改用 driveId 。 |
|
capabilities.canAddChildren |
boolean |
使用者是否可在這個資料夾中新增子項。這個項目並非資料夾時一律為 false。 | |
capabilities.canDelete |
boolean |
目前使用者可以刪除這個檔案。 | |
capabilities.canDownload |
boolean |
目前使用者可以下載這個檔案。 | |
capabilities.canListChildren |
boolean |
目前使用者可以列出這個資料夾的子系。這個項目並非資料夾時一律為 false。 | |
capabilities.canMoveTeamDriveItem |
boolean |
已淘汰 - 請改用 canMoveItemWithinDrive 或 canMoveItemOutOfDrive 。 |
|
capabilities.canMoveItemIntoTeamDrive |
boolean |
已淘汰 - 請改用 canMoveItemOutOfDrive 。 |
|
capabilities.canReadTeamDrive |
boolean |
已淘汰 - 請改用 canReadDrive 。 |
|
capabilities.canRemoveChildren |
boolean |
目前使用者可以移除這個資料夾中的子項。這個項目並非資料夾時一律為 false。如果是共用雲端硬碟中的資料夾,請改用 canDeleteChildren 或 canTrashChildren 。 |
|
capabilities.canRename |
boolean |
目前使用者可以重新命名這個檔案。 | |
capabilities.canTrash |
boolean |
目前的使用者是否可以將這個檔案移至垃圾桶。 | |
capabilities.canUntrash |
boolean |
目前使用者是否可以透過垃圾桶還原這個檔案。 | |
hasAugmentedPermissions |
boolean |
是否要直接在這個檔案上擁有權限。系統只會為共用雲端硬碟中的項目填入這個欄位。 | |
capabilities.canChangeViewersCanCopyContent |
boolean |
已淘汰 | |
permissionIds[] |
list |
具有這個檔案存取權的使用者權限 ID 清單。 | |
capabilities.canChangeCopyRequiresWriterPermission |
boolean |
目前使用者可以變更這個檔案的 copyRequiresWriterPermission 限制。 |
|
copyRequiresWriterPermission |
boolean |
您應停用檢視者、加註者的複製、列印或下載選項。 | 可寫入 |
capabilities.canDeleteChildren |
boolean |
目前使用者可以刪除這個資料夾的子項。如果是這個項目不是資料夾,則顯示 false。僅針對共用雲端硬碟中的項目填入資料。 | |
capabilities.canMoveChildrenOutOfTeamDrive |
boolean |
已淘汰 - 請改用 canMoveChildrenOutOfDrive 。 |
|
capabilities.canMoveChildrenWithinTeamDrive |
boolean |
已淘汰 - 請改用 canMoveChildrenWithinDrive 。 |
|
capabilities.canMoveItemOutOfTeamDrive |
boolean |
已淘汰 - 請改用 canMoveItemOutOfDrive 。 |
|
capabilities.canMoveItemWithinTeamDrive |
boolean |
已淘汰 - 請改用 canMoveItemWithinDrive 。 |
|
capabilities.canTrashChildren |
boolean |
目前使用者可以刪除這個資料夾中的子項。如果是這個項目不是資料夾,則顯示 false。僅針對共用雲端硬碟中的項目填入資料。 | |
exportLinks |
object |
將文件編輯器檔案匯出成特定格式的連結。 | |
exportLinks.(key) |
string |
從匯出格式對應到網址的對應 | |
driveId |
string |
檔案所在的共用雲端硬碟 ID。僅針對共用雲端硬碟中的項目填入資料。 | |
capabilities.canMoveChildrenOutOfDrive |
boolean |
目前使用者是否可在這個共用雲端硬碟外移動這個資料夾的子項。如果是這個項目不是資料夾,則顯示 false。僅針對共用雲端硬碟中的項目填入資料。 | |
capabilities.canMoveChildrenWithinDrive |
boolean |
使用者是否可在這個雲端硬碟中移動這個資料夾中的子項。如果是這個項目不是資料夾,則顯示 false。請注意,視目前的使用者對於子項和目的地資料夾的存取權而定,移動子項的要求可能仍會失敗。 | |
capabilities.canMoveItemOutOfDrive |
boolean |
目前使用者是否能變更這個項目的上層項目,將這個項目移出這個雲端硬碟。請注意,變更項目上層項目的要求仍會失敗,視新增的新父項而定。 | |
capabilities.canMoveItemWithinDrive |
boolean |
使用者是否可在這個雲端硬碟中移動這個項目。請注意,變更項目上層項目的要求仍會失敗,視新增的新父項和要移除的父項而定。 | |
capabilities.canReadDrive |
boolean |
目前的使用者是否可以讀取這個檔案所屬的共用雲端硬碟。僅針對共用雲端硬碟中的項目填入資料。 | |
capabilities.canModifyContent |
boolean |
目前使用者可以修改這個檔案的內容。 | |
capabilities.canAddMyDriveParent |
boolean |
目前使用者是否可移除相同項目中的上層,而不移除現有父項。沒有填入共用雲端硬碟中的檔案。 | |
capabilities.canRemoveMyDriveParent |
boolean |
目前使用者是否可在相同要求中,將其他家長從項目中移除。沒有填入共用雲端硬碟中的檔案。 | |
shortcutDetails |
object |
捷徑檔案詳細資料。只有捷徑檔案 (其 mimeType 欄位已設為 application/vnd.google-apps.shortcut ) 才會填入資料。 |
|
shortcutDetails.targetId |
string |
這個捷徑所指向檔案的 ID。 | 可寫入 |
shortcutDetails.targetMimeType |
string |
這個捷徑所指向檔案的 MIME 類型。這個欄位的值是目標 MIME 類型的數據匯報,系統會在建立捷徑時擷取。 | |
capabilities.canAddFolderFromAnotherDrive |
boolean |
目前使用者是否可以在其他資料夾中新增資料夾 (不同共用雲端硬碟或「我的雲端硬碟」),如果是這個項目不是資料夾,則顯示 false。僅針對共用雲端硬碟中的項目填入資料。 | |
capabilities.canModifyContentRestriction |
boolean |
目前使用者可以修改這個檔案的內容限制。 | |
contentRestrictions[] |
list |
存取檔案內容的限制。只有在這類限制存在的情況下,系統才會顯示這項資訊。 | |
contentRestrictions[].readOnly |
boolean |
檔案內容是否唯讀。如果檔案是唯讀狀態,系統就不會新增檔案的新修訂版本、新增或修改註解,也無法修改檔案標題。 | 可寫入 |
contentRestrictions[].reason |
string |
檔案內容受限的原因。只有針對也設定了 readOnly=true 的要求可變動。 |
可寫入 |
contentRestrictions[].restrictingUser |
nested object |
設定內容限制的使用者。只有在 readOnly 為 true 時才會填入資料。 |
|
contentRestrictions[].restrictingUser.kind |
string |
識別資源的類型。值:固定字串 "drive#user" 。 |
|
contentRestrictions[].restrictingUser.displayName |
string |
顯示此使用者的純文字名稱。 | |
contentRestrictions[].restrictingUser.photoLink |
string |
使用者個人資料相片 (如果有的話) 的連結。 | |
contentRestrictions[].restrictingUser.me |
boolean |
這位使用者是否為提出要求的使用者。 | |
contentRestrictions[].restrictingUser.permissionId |
string |
權限 ID 中顯示的使用者 ID。 | |
contentRestrictions[].restrictingUser.emailAddress |
string |
使用者的電子郵件地址。如果使用者並未向要求者顯示自己的電子郵件地址,則在某些情況下可能不會顯示這項資訊。 | |
contentRestrictions[].restrictionTime |
datetime |
設定內容限制的時間 (格式為 RFC 3339 時間戳記)。只有在 readOnly 為 true 時才會填入資料。 |
|
contentRestrictions[].type |
string |
內容限制的類型。目前唯一可使用的值為 globalContentRestriction 。 |
|
capabilities.canChangeSecurityUpdateEnabled |
boolean |
目前使用者可以變更連結共用設定中繼資料的 securityUpdateEnabled 欄位。 | |
shortcutDetails.targetResourceKey |
string |
目標檔案的 ResourceKey。 | |
resourceKey |
string |
必須透過共用連結存取該項目所需的金鑰。 | |
linkShareMetadata |
object |
包含用戶端參考連結網址的詳細資料。 | |
linkShareMetadata.securityUpdateEligible |
boolean |
檔案是否符合安全性更新資格。 | |
linkShareMetadata.securityUpdateEnabled |
boolean |
是否要為這個檔案啟用安全性更新。 | |
capabilities.canAcceptOwnership |
boolean |
目前使用者是否是檔案的待處理擁有者。沒有填入共用雲端硬碟中的檔案。 | |
capabilities.canModifyLabels |
boolean |
目前使用者是否可修改這個檔案中的標籤。 | |
capabilities.canReadLabels |
boolean |
目前使用者是否可讀取這個檔案中的標籤。 | |
labelInfo |
object |
檔案標籤總覽。 | |
labelInfo.labels[] |
list |
由 includeLabels 參數中的標籤 ID 要求的一組檔案標籤。根據預設,系統不會傳回任何標籤。 |
|
labelInfo.labels[].kind |
string |
這應該是 drive#label | |
labelInfo.labels[].id |
string |
標籤的 ID。 | |
labelInfo.labels[].revisionId |
string |
標籤的修訂版本 ID。 | |
labelInfo.labels[].fields |
object |
以欄位 ID 為索引鍵的欄位對應。 | |
labelInfo.labels[].fields.(key) |
nested object |
||
labelInfo.labels[].fields.(key).kind |
string |
這個值一律為 drive#labelField。 | |
labelInfo.labels[].fields.(key).id |
string |
這個欄位的識別碼。 | |
labelInfo.labels[].fields.(key).valueType |
string |
欄位類型。目前我們可能支援新值,但目前允許下列值:
|
|
labelInfo.labels[].fields.(key).dateString[] |
list |
只有在 valueType 為 dateString 時才會顯示。RFC 3339 格式化日期:YYYY-MM-DD。 |
|
labelInfo.labels[].fields.(key).integer[] |
list |
只有在 valueType 為 integer 時才會顯示。 |
|
labelInfo.labels[].fields.(key).selection[] |
list |
只有在 valueType 為 selection 時才會顯示。 |
|
labelInfo.labels[].fields.(key).text[] |
list |
只有在 valueType 為 text 時才會顯示。 |
|
labelInfo.labels[].fields.(key).user[] |
list |
只有在 valueType 為 user 時才會顯示。 |
|
labelInfo.labels[].fields.(key).user[].kind |
string |
識別資源的類型。值:固定字串 "drive#user" 。 |
|
labelInfo.labels[].fields.(key).user[].displayName |
string |
顯示此使用者的純文字名稱。 | |
labelInfo.labels[].fields.(key).user[].photoLink |
string |
使用者個人資料相片 (如果有的話) 的連結。 | |
labelInfo.labels[].fields.(key).user[].me |
boolean |
這位使用者是否為提出要求的使用者。 | |
labelInfo.labels[].fields.(key).user[].permissionId |
string |
權限 ID 中顯示的使用者 ID。 | |
labelInfo.labels[].fields.(key).user[].emailAddress |
string |
使用者的電子郵件地址。如果使用者並未向要求者顯示自己的電子郵件地址,則在某些情況下可能不會顯示這項資訊。 | |
sha1Checksum |
string |
與這個檔案相關聯的 SHA1 總和檢查碼 (如果有的話)。只有儲存在 Google 雲端硬碟中的檔案才會填入這個欄位;如果是文件編輯器或捷徑檔案,則不會填入這個欄位。 | |
sha256Checksum |
string |
與這個檔案相關聯的 SHA256 總和檢查碼 (如果有的話)。只有儲存在 Google 雲端硬碟中的檔案才會填入這個欄位;如果是文件編輯器或捷徑檔案,則不會填入這個欄位。 |
方法
- 複製
- 建立檔案副本,並使用修補語意套用任何要求更新。無法複製資料夾,
- 建立
- 建立檔案。
- 刪除
- 永久刪除使用者擁有的檔案,但不會將檔案移至垃圾桶。如果檔案是屬於共用雲端硬碟,則使用者必須是上層主辦人。如果目標資料夾是資料夾,則使用者擁有的所有子係也會遭到刪除。
- 空白垃圾桶
- 永久刪除使用者移至垃圾桶的所有檔案。
- 匯出
- 將 Google Workspace 文件匯出至要求的 MIME 類型,然後傳回匯出的位元組內容。請注意,匯出內容的大小上限為 10MB。
- generateIds
- 產生一組可在檔案建立或複製要求中提供的檔案 ID。
- 取得
- 依據 ID 取得檔案中繼資料或內容。
- list
- 列出或搜尋檔案。
- 更新
- 更新檔案的中繼資料和/或內容。呼叫這個方法時,只在您要修改的要求中填入欄位。更新欄位時,有些欄位可能會自動變更,例如修改過的日期。這個方法可支援 patch 語意。
- 觀看
- 訂閱檔案變更。即使您已為共用雲端硬碟中的檔案建立頻道,但是變更共用雲端硬碟檔案並不會建立通知。
- listLabels
- 列出檔案的標籤。
- 修改標籤
- 修改檔案中的標籤組合。