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 文字で、小文字の英数字またはダッシュ(-)です。ID の先頭または末尾をダッシュにすることはできません。作成時に名前が空の場合、一意の名前が生成されます。例: files/123-456

displayName

string

省略可。File の人が読める形式の表示名。表示名は、スペースを含めて 512 文字以下にする必要があります。例: 「ウェルカム画像」

mimeType

string

出力専用。ファイルの MIME タイプ。

sizeBytes

string (int64 format)

出力専用。ファイルのサイズ(バイト単位)。

createTime

string (Timestamp format)

出力専用。File が作成されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

出力専用。File が最後に更新されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

expirationTime

string (Timestamp format)

出力専用。File が削除されるときのタイムスタンプ。File の有効期限が予定されている場合にのみ設定されます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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)

動画の再生時間。

s」で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

状態

ファイルのライフサイクルの状態。

列挙型
STATE_UNSPECIFIED デフォルト値。この値は、状態を省略する場合に使用されます。
PROCESSING ファイルは処理中のため、まだ推論に使用できません。
ACTIVE ファイルが処理され、推論に使用できるようになりました。
FAILED ファイルを処理できませんでした。

メソッド

delete

File を削除します。

get

指定された File のメタデータを取得します。

list

リクエスト元のプロジェクトが所有する File のメタデータを一覧表示します。