REST Resource: files

المرجع: ملف

ملف تم تحميله إلى واجهة برمجة التطبيقات

تمثيل 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" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"
updateTime

string (Timestamp format)

النتائج فقط. الطابع الزمني لآخر تعديل لـ File.

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z"
expirationTime

string (Timestamp format)

النتائج فقط. الطابع الزمني لوقت حذف File. يتم ضبطها فقط إذا تمت جدولة انتهاء صلاحية "File".

طابع زمني بتنسيق RFC3339 UTC "Zulu" ، مع دقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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".

الحالة

حالات دورة حياة الملف.

عمليات التعداد
STATE_UNSPECIFIED القيمة التلقائية. يتم استخدام هذه القيمة إذا تم حذف الحالة.
PROCESSING تتم معالجة الملف ولا يمكن بعد استخدامه للاستنتاج.
ACTIVE تمت معالجة الملف وأصبح متاحًا للاستنتاج.
FAILED تعذّرت معالجة الملف.

الطُرق

delete

 يؤدي هذا الإجراء إلى حذف File.

get

 يمكن الحصول على البيانات الوصفية للسمة File المحدّدة.

list

 يسرد البيانات الوصفية لـ File التي يملكها المشروع الذي يقدّم الطلب.