REST Resource: files

ทรัพยากร: ไฟล์

อัปโหลดไฟล์ไปยัง 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

เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากร File รหัส (ชื่อที่ไม่รวมคำนำหน้า "files/") สามารถมีอักขระได้ไม่เกิน 40 ตัวที่เป็นอักษรตัวพิมพ์เล็กและตัวเลขคละกันหรือขีดกลาง (-) รหัสต้องไม่ขึ้นต้นหรือลงท้ายด้วยขีดกลาง หากชื่อว่างเปล่าเมื่อสร้าง ระบบจะสร้างชื่อที่ไม่ซ้ำกัน ตัวอย่าง: 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 ของไบต์ที่อัปโหลด

สตริงที่เข้ารหัสฐาน 64

uri

string

เอาต์พุตเท่านั้น URI ของ File

state

enum (State)

เอาต์พุตเท่านั้น สถานะการประมวลผลของไฟล์

error

object (Status)

เอาต์พุตเท่านั้น สถานะข้อผิดพลาดหากการประมวลผลไฟล์ล้มเหลว

ฟิลด์สหภาพ metadata ข้อมูลเมตาสำหรับไฟล์ metadata ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
videoMetadata

object (VideoMetadata)

เอาต์พุตเท่านั้น ข้อมูลเมตาสำหรับวิดีโอ

VideoMetadata

ข้อมูลเมตาสำหรับวิดีโอ File

การแสดง JSON
{
  "videoDuration": string
}
ช่อง
videoDuration

string (Duration format)

ระยะเวลาของวิดีโอ

ระยะเวลาเป็นวินาทีที่มีเลขเศษส่วนไม่เกิน 9 หลัก ลงท้ายด้วย "s" เช่น "3.5s"

รัฐ

สถานะสำหรับวงจรของไฟล์

Enum
STATE_UNSPECIFIED ค่าเริ่มต้น ระบบจะใช้ค่านี้หากไม่ระบุสถานะ
PROCESSING ระบบกำลังประมวลผลไฟล์และยังใช้การอนุมานไม่ได้
ACTIVE ไฟล์ได้รับการประมวลผลและพร้อมสำหรับการอนุมาน
FAILED ประมวลผลไฟล์ไม่สำเร็จ

วิธีการ

delete

ลบ File

get

รับข้อมูลเมตาสำหรับ File ที่ระบุ

list

แสดงรายการข้อมูลเมตาสำหรับ File ที่โปรเจ็กต์ที่ส่งคำขอเป็นเจ้าของ