REST Resource: files

資源:File

上傳至 API 的檔案。

JSON 表示法
{
  "name": string,
  "displayName": string,
  "mimeType": string,
  "sizeBytes": string,
  "createTime": string,
  "updateTime": string,
  "expirationTime": string,
  "sha256Hash": string,
  "uri": string,
  "state": enum (State),
  "error": {
    object (Status)
  },

  // Union field metadata can be only one of the following:
  "videoMetadata": {
    object (VideoMetadata)
  }
  // End of list of possible types for union field metadata.
}
欄位
name

string

不可變動。ID。File 資源名稱。ID (不含「files/」前置字元的名稱) 最多可以包含 40 個半形字元,使用小寫英數字元或破折號 (-),且開頭或結尾不得為連字號。如果建立時沒有名稱,系統會產生不重複的名稱。範例:files/123-456

displayName

string

選用設定。File 的使用者可理解的顯示名稱。顯示名稱的長度不得超過 512 個半形字元 (包含空格)。例如:「歡迎圖片」

mimeType

string

僅供輸出。檔案的 MIME 類型。

sizeBytes

string (int64 format)

僅供輸出。檔案大小 (以位元組為單位)。

createTime

string (Timestamp format)

僅供輸出。File 的建立時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

僅供輸出。File 上次更新時的時間戳記。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

expirationTime

string (Timestamp format)

僅供輸出。刪除 File 的時間戳記。只有在 File 已排定到期時才會設定。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

sha256Hash

string (bytes format)

僅供輸出。已上傳位元組的 SHA-256 雜湊。

Base64 編碼的字串。

uri

string

僅供輸出。File 的 URI。

state

enum (State)

僅供輸出。檔案的處理狀態。

error

object (Status)

僅供輸出。檔案處理失敗時出現的錯誤狀態。

聯集欄位 metadata。檔案的中繼資料。metadata 只能是下列其中一項:
videoMetadata

object (VideoMetadata)

僅供輸出。影片的中繼資料。

VideoMetadata

影片 File 的中繼資料。

JSON 表示法
{
  "videoDuration": string
}
欄位
videoDuration

string (Duration format)

影片的時間長度。

時間長度以秒為單位,最多可有 9 個小數位數,並結尾為「s」。例如:"3.5s"

狀態

檔案生命週期的狀態。

列舉
STATE_UNSPECIFIED 預設值。如果省略狀態,則會使用這個值。
PROCESSING 檔案正在處理中,目前還無法用於推論。
ACTIVE 已處理檔案,可供推論。
FAILED 處理檔案失敗。

方法

delete

刪除 File

get

取得指定 File 的中繼資料。

list

列出要求專案擁有的 File 中繼資料。