REST Resource: files

資源:檔案

檔案的中繼資料,

部分資源方法 (例如 files.update) 需要 fileId。使用 files.list 方法擷取檔案 ID。

JSON 表示法
{
  "kind": string,
  "userPermission": {
    object (Permission)
  },
  "fileExtension": string,
  "md5Checksum": string,
  "selfLink": string,
  "ownerNames": [
    string
  ],
  "lastModifyingUserName": string,
  "editable": boolean,
  "writersCanShare": boolean,
  "downloadUrl": string,
  "mimeType": string,
  "exportLinks": {
    string: string,
    ...
  },
  "driveId": string,
  "parents": [
    {
      object (ParentReference)
    }
  ],
  "thumbnailLink": string,
  "appDataContents": boolean,
  "webViewLink": string,
  "iconLink": string,
  "shared": boolean,
  "lastModifyingUser": {
    object (User)
  },
  "owners": [
    {
      object (User)
    }
  ],
  "openWithLinks": {
    string: string,
    ...
  },
  "defaultOpenWithLink": string,
  "headRevisionId": string,
  "properties": [
    {
      object (Property)
    }
  ],
  "copyable": boolean,
  "etag": string,
  "sharingUser": {
    object (User)
  },
  "alternateLink": string,
  "embedLink": string,
  "webContentLink": string,
  "fileSize": string,
  "copyRequiresWriterPermission": boolean,
  "permissions": [
    {
      object (Permission)
    }
  ],
  "hasThumbnail": boolean,
  "spaces": [
    string
  ],
  "folderColorRgb": string,
  "id": string,
  "title": string,
  "description": string,
  "labels": {
    "viewed": boolean,
    "restricted": boolean,
    "starred": boolean,
    "hidden": boolean,
    "trashed": boolean,
    "modified": boolean
  },
  "explicitlyTrashed": boolean,
  "createdDate": string,
  "modifiedDate": string,
  "modifiedByMeDate": string,
  "lastViewedByMeDate": string,
  "markedViewedByMeDate": string,
  "sharedWithMeDate": string,
  "quotaBytesUsed": string,
  "version": string,
  "indexableText": {
    "text": string
  },
  "originalFilename": string,
  "ownedByMe": boolean,
  "canComment": boolean,
  "shareable": boolean,
  "fullFileExtension": string,
  "isAppAuthorized": boolean,
  "teamDriveId": string,
  "capabilities": {
    "canChangeRestrictedDownload": boolean,
    "canMoveChildrenOutOfDrive": boolean,
    "canReadDrive": boolean,
    "canEdit": boolean,
    "canCopy": boolean,
    "canComment": boolean,
    "canAddChildren": boolean,
    "canDelete": boolean,
    "canDownload": boolean,
    "canListChildren": boolean,
    "canRemoveChildren": boolean,
    "canRename": boolean,
    "canTrash": boolean,
    "canReadRevisions": boolean,
    "canReadTeamDrive": boolean,
    "canMoveTeamDriveItem": boolean,
    "canChangeCopyRequiresWriterPermission": boolean,
    "canMoveItemIntoTeamDrive": boolean,
    "canUntrash": boolean,
    "canModifyContent": boolean,
    "canMoveItemWithinTeamDrive": boolean,
    "canMoveItemOutOfTeamDrive": boolean,
    "canDeleteChildren": boolean,
    "canMoveChildrenOutOfTeamDrive": boolean,
    "canMoveChildrenWithinTeamDrive": boolean,
    "canTrashChildren": boolean,
    "canMoveItemOutOfDrive": boolean,
    "canAddMyDriveParent": boolean,
    "canRemoveMyDriveParent": boolean,
    "canMoveItemWithinDrive": boolean,
    "canShare": boolean,
    "canMoveChildrenWithinDrive": boolean,
    "canModifyContentRestriction": boolean,
    "canAddFolderFromAnotherDrive": boolean,
    "canChangeSecurityUpdateEnabled": boolean,
    "canAcceptOwnership": boolean,
    "canReadLabels": boolean,
    "canModifyLabels": boolean,
    "canModifyEditorContentRestriction": boolean,
    "canModifyOwnerContentRestriction": boolean,
    "canRemoveContentRestriction": boolean
  },
  "hasAugmentedPermissions": boolean,
  "trashingUser": {
    object (User)
  },
  "canReadRevisions": boolean,
  "thumbnailVersion": string,
  "trashedDate": string,
  "permissionIds": [
    string
  ],
  "thumbnail": {
    "image": string,
    "mimeType": string
  },
  "imageMediaMetadata": {
    "flashUsed": boolean,
    "meteringMode": string,
    "sensor": string,
    "exposureMode": string,
    "colorSpace": string,
    "whiteBalance": string,
    "width": integer,
    "height": integer,
    "location": {
      "latitude": number,
      "longitude": number,
      "altitude": number
    },
    "rotation": integer,
    "date": string,
    "cameraMake": string,
    "cameraModel": string,
    "exposureTime": number,
    "aperture": number,
    "focalLength": number,
    "isoSpeed": integer,
    "exposureBias": number,
    "maxApertureValue": number,
    "subjectDistance": integer,
    "lens": string
  },
  "videoMediaMetadata": {
    "width": integer,
    "height": integer,
    "durationMillis": string
  },
  "shortcutDetails": {
    "targetId": string,
    "targetMimeType": string,
    "targetResourceKey": string
  },
  "contentRestrictions": [
    {
      object (ContentRestriction)
    }
  ],
  "resourceKey": string,
  "linkShareMetadata": {
    "securityUpdateEligible": boolean,
    "securityUpdateEnabled": boolean
  },
  "labelInfo": {
    "labels": [
      {
        object (Label)
      }
    ]
  },
  "sha1Checksum": string,
  "sha256Checksum": string
}
欄位
kind

string

僅供輸出。檔案類型。一律為 drive#file

userPermission

object (Permission)

僅供輸出。這個檔案的已驗證使用者權限。

fileExtension

string

僅供輸出。fullFileExtension 的最終元件,其中包含似乎不包含在擴充功能中的結尾文字。這個欄位只會在含有 Google 雲端硬碟內容的檔案填入這個欄位;文件編輯器或捷徑檔案中不會填入資料。

md5Checksum

string

僅供輸出。這個檔案內容的 MD5 總和檢查碼。這個欄位只會在含有 Google 雲端硬碟內容的檔案填入這個欄位;文件編輯器或捷徑檔案中不會填入資料。

ownerNames[]

string

僅供輸出。這個檔案的擁有者名稱。未針對共用雲端硬碟中的項目填入資料。

lastModifyingUserName

string

僅供輸出。修改這個檔案的最後一個使用者名稱。

editable
(deprecated)

boolean

僅供輸出。已淘汰:請改用 capabilities/canEdit

writersCanShare

boolean

撰寫者是否可以與其他使用者共用文件。未針對共用雲端硬碟中的項目填入資料。

downloadUrl

string

僅供輸出。檔案的簡短下載網址。這個欄位只會在含有 Google 雲端硬碟內容的檔案填入這個欄位;則不會填入 Google 文件或捷徑檔案。

mimeType

string

檔案的 MIME 類型。只有在上傳新內容時,才能變更此屬性。這個欄位可以留空,而 MIME 類型將取決於上傳內容的 MIME 類型。

driveId

string

僅供輸出。檔案所在共用雲端硬碟的 ID。僅針對共用雲端硬碟中的項目填入資料。

parents[]

object (ParentReference)

檔案所屬上層資料夾的 ID。

一個檔案只能有一個上層資料夾;不支援指定多個上層。

如果您並未要求加入插入,檔案就會直接放在使用者的「我的雲端硬碟」資料夾。如未在複製要求中指定,檔案會沿用來源檔案的任何可偵測父項。files.update 要求必須使用 addParentsremoveParents 參數修改父項清單。

appDataContents

boolean

僅供輸出。這個檔案是否位於 Application Data 資料夾。

shared

boolean

僅供輸出。檔案是否已共用。未針對共用雲端硬碟中的項目填入資料。

lastModifyingUser

object (User)

僅供輸出。最後一位修改這個檔案的使用者。這個欄位只有在上次修改的情況下,是由已登入的使用者執行。

owners[]

object (User)

僅供輸出。這個檔案的擁有者。只有特定舊版檔案可能有多位擁有者。系統不會針對共用雲端硬碟中的項目填入這個欄位。

headRevisionId

string

僅供輸出。檔案頭部修訂版本的 ID。這個欄位只會在含有 Google 雲端硬碟內容的檔案填入這個欄位;文件編輯器或捷徑檔案中不會填入資料。

properties[]

object (Property)

屬性清單。

copyable
(deprecated)

boolean

僅供輸出。已淘汰:請改用 capabilities/canCopy

etag

string

僅供輸出。檔案的 ETag。

sharingUser

object (User)

僅供輸出。與目前使用者共用項目的使用者 (如有)。

fileSize

string (int64 format)

僅供輸出。blob 和第一方編輯器檔案的大小 (以位元組為單位)。如果檔案沒有大小限制 (例如捷徑和資料夾),系統不會填入資料。

copyRequiresWriterPermission

boolean

請為讀者和加註者停用複製、列印或下載這個檔案的選項。

permissions[]

object (Permission)

僅供輸出。擁有這個檔案存取權的使用者權限清單。未針對共用雲端硬碟中的項目填入資料。

hasThumbnail

boolean

僅供輸出。這個檔案是否包含縮圖。但這不會指出發出要求的應用程式是否有權存取縮圖。如要檢查存取權,請找出縮圖連結欄位是否存在。

spaces[]

string

僅供輸出。包含檔案的聊天室清單。支援的值為 driveappDataFolderphotos

folderColorRgb

string

如果檔案是資料夾或資料夾捷徑,則會以 RGB 十六進位字串的形式顯示資料夾顏色。您可以在「About」資源的「folderColorPalette」欄位中查看支援的顏色清單。如果指定不支援的顏色,系統會在調色盤中將該顏色變更為最接近的顏色。

id

string

檔案的 ID。

title

string

這個檔案的標題。請注意,不可變更的項目 (例如共用雲端硬碟的頂層資料夾、「我的雲端硬碟」根資料夾和「應用程式資料」資料夾) 的名稱會固定不變。

description

string

檔案的簡短說明。

labels

object

檔案的一組標籤。

labels.viewed

boolean

使用者是否看過這個檔案。

labels.restricted
(deprecated)

boolean

僅供輸出。已淘汰:請改用 copyRequiresWriterPermission

labels.starred

boolean

使用者是否已為這個檔案加上星號。

labels.hidden
(deprecated)

boolean

僅供輸出。已淘汰。

labels.trashed

boolean

這個檔案是否已移至垃圾桶。這個標籤會套用至所有存取這個檔案的使用者;不過,只有擁有者才能查看及移出垃圾桶的檔案。

labels.modified

boolean

僅供輸出。檔案是否已由這位使用者修改。

explicitlyTrashed

boolean

僅供輸出。這個檔案是否已明確移至垃圾桶,而非遞迴地移至垃圾桶。

createdDate

string

僅供輸出。這個檔案的建立時間 (格式為 RFC 3339 時間戳記)。

modifiedDate

string

上次有人修改這個檔案的時間 (格式為 RFC 3339 時間戳記)。只有在 setModifyDate 參數設定的情況下,這個屬性才能在更新時修改。

modifiedByMeDate

string

僅供輸出。使用者上次修改這個檔案的時間 (格式為 RFC 3339 時間戳記)。請注意,設定 modifyDate 後,也會為設定日期的使用者更新 modifyByMe 日期。

lastViewedByMeDate

string

使用者上次檢視這個檔案的時間 (採用格式的 RFC 3339 時間戳記)。

markedViewedByMeDate
(deprecated)

string

僅供輸出。已淘汰。

sharedWithMeDate

string

僅供輸出。與使用者共用這個檔案的時間 (格式為 RFC 3339 時間戳記)。

quotaBytesUsed

string (int64 format)

僅供輸出。這個檔案使用的配額位元組數。

version

string (int64 format)

僅供輸出。單調遞增檔案的版本號碼。這會反映所有對伺服器上檔案所做的變更,包括提出要求的使用者看不到的變更。

indexableText

object

檔案的可建立索引文字屬性 (只能寫入)

indexableText.text

string

要為這個檔案建立索引的文字。

originalFilename

string

上傳內容的原始檔案名稱 (如有),或其他 title 欄位的原始值。這項功能僅適用於 Google 雲端硬碟中有二進位內容的檔案。

ownedByMe

boolean

僅供輸出。檔案是否為目前使用者所有。未針對共用雲端硬碟中的項目填入資料。

canComment
(deprecated)

boolean

僅供輸出。已淘汰:請改用 capabilities/canComment

shareable
(deprecated)

boolean

僅供輸出。已淘汰:請改用 capabilities/canShare

fullFileExtension

string

僅供輸出。完整的副檔名;擷取自標題可能包含多個串連的副檔名,例如「tar.gz」。移除標題中的額外資訊不會清除這個欄位。不過,更改廣告標題的副檔名後,這個欄位也會更新。這個欄位只會在含有 Google 雲端硬碟內容的檔案填入這個欄位;文件編輯器或捷徑檔案中不會填入資料。

isAppAuthorized

boolean

僅供輸出。檔案是否由提出要求的應用程式建立或開啟。

teamDriveId
(deprecated)

string

僅供輸出。已淘汰:請改用 driveId

capabilities

object

僅供輸出。目前使用者對這個檔案的功能。每項功能都會對應到使用者可能會採取的細項動作。

capabilities.canChangeRestrictedDownload
(deprecated)

boolean

僅供輸出。已淘汰。

capabilities.canMoveChildrenOutOfDrive

boolean

僅供輸出。目前的使用者是否可以將這個資料夾的子項移出共用雲端硬碟。如果該項目不是資料夾,則此為 false。僅針對共用雲端硬碟中的項目填入資料。

capabilities.canReadDrive

boolean

僅供輸出。目前的使用者能否讀取這個檔案所屬的共用雲端硬碟。僅針對共用雲端硬碟中的項目填入資料。

capabilities.canEdit

boolean

僅供輸出。目前使用者是否可以編輯這個檔案。其他因素可能會限制使用者可對檔案做出的變更類型。例如,請參閱 canChangeCopyRequiresWriterPermissioncanModifyContent

capabilities.canCopy

boolean

僅供輸出。目前的使用者是否可以複製這個檔案。對於共用雲端硬碟中的項目,指出目前的使用者能否複製這個項目的非資料夾子系,或這個項目不是資料夾本身。

capabilities.canComment

boolean

僅供輸出。目前的使用者能否為這個檔案加註。

capabilities.canAddChildren

boolean

僅供輸出。目前的使用者能否在這個資料夾中新增子項。如果該項目不是資料夾,一律為 false。

capabilities.canDelete

boolean

僅供輸出。目前使用者是否可以刪除這個檔案。

capabilities.canDownload

boolean

僅供輸出。目前的使用者能否下載這個檔案。

capabilities.canListChildren

boolean

僅供輸出。目前使用者是否可列出這個資料夾的子項。如果該項目不是資料夾,一律為 false。

capabilities.canRemoveChildren

boolean

僅供輸出。目前的使用者能否從這個資料夾移除子項。如果該項目不是資料夾,一律為 false。如果是共用雲端硬碟中的資料夾,請改用 canDeleteChildrencanTrashChildren

capabilities.canRename

boolean

僅供輸出。目前的使用者能否重新命名這個檔案。

capabilities.canTrash

boolean

僅供輸出。目前的使用者能否將這個檔案移至垃圾桶。

capabilities.canReadRevisions

boolean

僅供輸出。目前使用者是否可讀取這個檔案的修訂版本資源。針對共用雲端硬碟項目,則可讀取這個項目的非資料夾子系修訂版本,還是這個項目本身 (不是資料夾) 的修訂版本。

capabilities.canReadTeamDrive
(deprecated)

boolean

僅供輸出。已淘汰:請改用 canReadDrive

capabilities.canMoveTeamDriveItem
(deprecated)

boolean

僅供輸出。已淘汰:請改用 canMoveItemWithinDrivecanMoveItemOutOfDrive

capabilities.canChangeCopyRequiresWriterPermission

boolean

僅供輸出。目前的使用者是否可以變更這個檔案的 copyRequiresWriterPermission 限制。

capabilities.canMoveItemIntoTeamDrive
(deprecated)

boolean

僅供輸出。已淘汰:請改用 canMoveItemOutOfDrive

capabilities.canUntrash

boolean

僅供輸出。目前的使用者能否從垃圾桶還原這個檔案。

capabilities.canModifyContent

boolean

僅供輸出。目前的使用者能否修改這個檔案的內容。

capabilities.canMoveItemWithinTeamDrive
(deprecated)

boolean

僅供輸出。已淘汰:請改用 canMoveItemWithinDrive

capabilities.canMoveItemOutOfTeamDrive
(deprecated)

boolean

僅供輸出。已淘汰:請改用 canMoveItemOutOfDrive

capabilities.canDeleteChildren

boolean

僅供輸出。目前的使用者能否刪除這個資料夾的子項。如果該項目不是資料夾,則此為 false。僅針對共用雲端硬碟中的項目填入資料。

capabilities.canMoveChildrenOutOfTeamDrive
(deprecated)

boolean

僅供輸出。已淘汰:請改用 canMoveChildrenOutOfDrive

capabilities.canMoveChildrenWithinTeamDrive
(deprecated)

boolean

僅供輸出。已淘汰:請改用 canMoveChildrenWithinDrive

capabilities.canTrashChildren

boolean

僅供輸出。目前的使用者是否可以將這個資料夾的子項移至垃圾桶。如果該項目不是資料夾,則此為 false。僅針對共用雲端硬碟中的項目填入資料。

capabilities.canMoveItemOutOfDrive

boolean

僅供輸出。目前的使用者能否變更父項,藉此將這個項目移出這個雲端硬碟。請注意,視要新增的新父項而定,變更項目父項的要求仍可能失敗。

capabilities.canAddMyDriveParent

boolean

僅供輸出。目前的使用者是否可以在同一個要求中為項目新增父項,而不必移除現有父項。不會為共用雲端硬碟檔案填入資料。

capabilities.canRemoveMyDriveParent

boolean

僅供輸出。目前的使用者是否可以在同一個要求中移除上層項目,而不必新增另一個父項。不會為共用雲端硬碟檔案填入資料。

capabilities.canMoveItemWithinDrive

boolean

僅供輸出。目前的使用者能否在這個雲端硬碟中移動這個項目。請注意,視要新增的新父項和要移除的父項而定,變更項目父項的要求仍可能失敗。

capabilities.canShare

boolean

僅供輸出。目前使用者是否可以修改這個檔案的共用設定。

capabilities.canMoveChildrenWithinDrive

boolean

僅供輸出。目前的使用者是否可以在這個雲端硬碟中移動這個資料夾的子項。如果該項目不是資料夾,則此為 false。請注意,根據目前使用者對子資料夾和目標資料夾的存取權,移動子項的要求仍可能失敗。

capabilities.canModifyContentRestriction
(deprecated)

boolean

已淘汰:僅限輸出。請使用 canModifyEditorContentRestrictioncanModifyOwnerContentRestrictioncanRemoveContentRestriction 其中之一。

capabilities.canAddFolderFromAnotherDrive

boolean

僅供輸出。目前的使用者能否將其他雲端硬碟 (不同共用雲端硬碟或「我的雲端硬碟」) 的資料夾新增至這個資料夾。如果該項目不是資料夾,則此為 false。僅針對共用雲端硬碟中的項目填入資料。

capabilities.canChangeSecurityUpdateEnabled

boolean

僅供輸出。指定目前的使用者能否變更連結共用中繼資料的 securityUpdateEnabled 欄位。

capabilities.canAcceptOwnership

boolean

僅供輸出。目前的使用者是否為檔案待審核的擁有者。不會為共用雲端硬碟檔案填入資料。

capabilities.canReadLabels

boolean

僅供輸出。目前使用者是否可讀取檔案中的標籤。

capabilities.canModifyLabels

boolean

僅供輸出。目前的使用者能否修改檔案中的標籤。

capabilities.canModifyEditorContentRestriction

boolean

僅供輸出。目前的使用者是否可以針對受到編輯器限制的檔案新增或修改內容限制。

capabilities.canModifyOwnerContentRestriction

boolean

僅供輸出。目前的使用者是否可以新增或修改擁有者限制的內容限制。

capabilities.canRemoveContentRestriction

boolean

僅供輸出。目前的使用者可移除檔案的內容限制。

hasAugmentedPermissions

boolean

僅供輸出。是否直接對這個檔案具備權限。系統只會針對共用雲端硬碟中的項目填入這個欄位。

trashingUser

object (User)

僅供輸出。如果檔案已明確移至垃圾桶,使用者即移至垃圾桶。僅針對共用雲端硬碟中的項目填入資料。

canReadRevisions
(deprecated)

boolean

僅供輸出。已淘汰:請改用 capabilities/canReadRevisions

thumbnailVersion

string (int64 format)

僅供輸出。用於縮圖快取撤銷作業的縮圖版本。

trashedDate

string

僅供輸出。項目移至垃圾桶的時間 (格式為 RFC 3339 時間戳記)。僅針對共用雲端硬碟中的項目填入資料。

permissionIds[]

string

僅供輸出。擁有這個檔案存取權的使用者權限 ID 清單。

thumbnail

object

檔案的縮圖。只有在無法產生標準縮圖時,才能使用這個方式。

thumbnail.image

string (bytes format)

縮圖圖片的網址安全 Base64 編碼位元組。應符合 RFC 4648 第 5 節的規定。

Base64 編碼字串。

thumbnail.mimeType

string

縮圖的 MIME 類型。

imageMediaMetadata

object

僅供輸出。圖片媒體的中繼資料。這種情況只會針對圖片類型顯示,其內容則取決於可從圖片內容剖析的內容。

imageMediaMetadata.flashUsed

boolean

僅供輸出。是否使用閃光燈來製作相片。

imageMediaMetadata.meteringMode

string

僅供輸出。用來建立相片的計量模式。

imageMediaMetadata.sensor

string

僅供輸出。用來建立相片的感應器類型。

imageMediaMetadata.exposureMode

string

僅供輸出。用於建立相片的曝光模式。

imageMediaMetadata.colorSpace

string

僅供輸出。相片的色彩空間。

imageMediaMetadata.whiteBalance

string

僅供輸出。用於建立相片的白平衡模式。

imageMediaMetadata.width

integer

僅供輸出。圖片寬度 (以像素為單位)。

imageMediaMetadata.height

integer

僅供輸出。圖片的高度 (以像素為單位)。

imageMediaMetadata.location

object

僅供輸出。圖片中儲存的地理位置資訊。

imageMediaMetadata.location.latitude

number

僅供輸出。儲存在圖片中的緯度。

imageMediaMetadata.location.longitude

number

僅供輸出。儲存在圖片中的經度。

imageMediaMetadata.location.altitude

number

僅供輸出。圖片中儲存的海拔高度。

imageMediaMetadata.rotation

integer

僅供輸出。圖片原始方向套用的順時針 90 度旋轉次數。

imageMediaMetadata.date

string

僅供輸出。相片的拍攝日期和時間 (EXIF 格式時間戳記)。

imageMediaMetadata.cameraMake

string

僅供輸出。用於建立相片的相機鏡頭。

imageMediaMetadata.cameraModel

string

僅供輸出。用於建立相片的相機模型。

imageMediaMetadata.exposureTime

number

僅供輸出。曝光的時間長度 (以秒為單位)。

imageMediaMetadata.aperture

number

僅供輸出。用來建立相片的光圈 (f-number)。

imageMediaMetadata.focalLength

number

僅供輸出。製作相片時使用的焦距 (以公釐為單位)。

imageMediaMetadata.isoSpeed

integer

僅供輸出。建立相片時使用的 ISO 速度。

imageMediaMetadata.exposureBias

number

僅供輸出。相片的曝光偏誤 (APEX 值)。

imageMediaMetadata.maxApertureValue

number

僅供輸出。產生相片時使用的鏡頭焦距最小 F 數 (APEX 值)。

imageMediaMetadata.subjectDistance

integer

僅供輸出。相片主體的距離 (公尺)。

imageMediaMetadata.lens

string

僅供輸出。用來製作相片的鏡頭。

videoMediaMetadata

object

僅供輸出。影片媒體的中繼資料。系統只會針對影片類型顯示這個圖示。

videoMediaMetadata.width

integer

僅供輸出。影片寬度 (以像素為單位)。

videoMediaMetadata.height

integer

僅供輸出。影片的高度 (以像素為單位)。

videoMediaMetadata.durationMillis

string (int64 format)

僅供輸出。影片的時間長度 (以毫秒為單位)。

shortcutDetails

object

捷徑檔案詳細資料。只會為捷徑檔案填入 mimeType 欄位設為 application/vnd.google-apps.shortcut 的捷徑。只能針對 files.insert 要求進行設定。

shortcutDetails.targetId

string

這個捷徑指向的檔案 ID。只能針對 files.insert 要求進行設定。

shortcutDetails.targetMimeType

string

僅供輸出。這個捷徑所指向的檔案 MIME 類型。這個欄位的值是建立捷徑時擷取的目標 MIME 類型快照。

shortcutDetails.targetResourceKey

string

僅供輸出。目標檔案的 ResourceKey。

contentRestrictions[]

object (ContentRestriction)

檔案內容的存取限制。只有在有這類限制時才填入資料。

resourceKey

string

僅供輸出。必須透過共用連結才能存取項目。

linkShareMetadata.securityUpdateEligible

boolean

僅供輸出。檔案是否符合安全性更新資格。

linkShareMetadata.securityUpdateEnabled

boolean

僅供輸出。是否已啟用這個檔案的安全性更新。

labelInfo

object

僅供輸出。檔案標籤總覽。

labelInfo.labels[]

object (Label)

僅供輸出。檔案中的標籤組合 (由 includeLabels 參數中的標籤 ID 要求)。根據預設,系統不會傳回任何標籤。

sha1Checksum

string

僅供輸出。與這個檔案相關聯的 SHA1 總和檢查碼 (如有)。這個欄位只會在含有 Google 雲端硬碟內容的檔案填入這個欄位;文件編輯器或捷徑檔案中不會填入資料。

sha256Checksum

string

僅供輸出。與這個檔案相關聯的 SHA256 總和檢查碼 (如果有的話)。這個欄位只會在含有 Google 雲端硬碟內容的檔案填入這個欄位;文件編輯器或捷徑檔案中不會填入資料。

ContentRestriction

檔案內容的存取限制。

JSON 表示法
{
  "readOnly": boolean,
  "reason": string,
  "type": string,
  "restrictingUser": {
    object (User)
  },
  "restrictionDate": string,
  "ownerRestricted": boolean,
  "systemRestricted": boolean
}
欄位
readOnly

boolean

檔案內容是否為唯讀。如果檔案處於唯讀狀態,就無法加入新修訂版本、不可新增或修改註解,且檔案名稱不可修改。

reason

string

檔案內容受限的原因。這僅適用於同樣設定 readOnly=true 的要求。

type

string

僅供輸出。內容限制的類型。目前唯一可使用的值為 globalContentRestriction

restrictingUser

object (User)

僅供輸出。設定內容限制的使用者。只有在 readOnly 為 true 時才會填入值。

restrictionDate

string

僅供輸出。設定內容限制的時間 (格式為 RFC 3339 時間戳記)。只有在 readOnly 為 true 時才會填入值。

ownerRestricted

boolean

內容限制是否只能由擁有該檔案的使用者修改或移除。如果是共用雲端硬碟中的檔案,凡是具備 organizer 功能的使用者,都能修改或移除這項內容限制。

systemRestricted

boolean

僅供輸出。內容限制是否由系統套用,例如因電子簽名。使用者無法修改或移除系統受限內容限制。

方法

copy

建立指定檔案的副本。

delete

永久刪除使用者擁有的檔案,而不移至垃圾桶。

emptyTrash

永久刪除使用者移至垃圾桶的所有檔案。

export

將 Google Workspace 文件匯出為要求的 MIME 類型,並傳回匯出的位元組內容。

generateIds

產生一組可以在插入或複製要求中提供的檔案 ID。

get

根據 ID 取得檔案的中繼資料或內容。

insert

插入新檔案。

list

列出使用者的檔案。

listLabels

列出檔案中的標籤。

modifyLabels

修改檔案套用的標籤組合。

patch

更新檔案的中繼資料和/或內容。

touch

將檔案更新時間設為目前的伺服器時間。

trash

將檔案移至垃圾桶。

untrash

還原垃圾桶中的檔案。

update

更新檔案的中繼資料和/或內容。

watch

訂閱檔案變更。