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, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של מועד העדכון האחרון של File.

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
expirationTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של מועד המחיקה של File. מוגדר רק אם התוקף של File מתוכנן לפוג.

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
sha256Hash

string (bytes format)

פלט בלבד. גיבוב SHA-256 של הבייטים שהועלו.

מחרוזת בקידוד base64.
uri

string

פלט בלבד. ה-URI של File.
state

enum (State)

פלט בלבד. מצב הקובץ נמצא בעיבוד.
error

object (Status)

פלט בלבד. סטטוס השגיאה אם עיבוד הקבצים נכשל.
שדה איחוד metadata. מטא-נתונים של הקובץ. metadata יכול להיות רק אחד מהבאים:
videoMetadata

object (VideoMetadata)

פלט בלבד. מטא-נתונים של סרטון.

VideoMetadata

מטא-נתונים של הסרטון File.

ייצוג JSON 
{
  "videoDuration": string
}
שדות
videoDuration

string (Duration format)

משך הסרטון.

משך זמן בשניות עם עד תשע ספרות עשרוניות, המסתיים ב-'s'. דוגמה: "3.5s".

ארץ

מצבים במחזור החיים של קובץ.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED ערך ברירת המחדל. ייעשה שימוש בערך הזה אם לא תציינו את המצב.
PROCESSING הקובץ מעובד ועדיין לא ניתן להשתמש בו לצורך הסקת מסקנות.
ACTIVE הקובץ מעובד וזמין לצורך הסקת מסקנות.
FAILED עיבוד הקובץ נכשל.

שיטות

delete

 מחיקת File.

get

 הפונקציה מקבלת את המטא-נתונים של ה-File הנתון.

list

 פירוט המטא-נתונים של פריטי File שבבעלות הפרויקט המבקש.