REST Resource: sites.channels

المرجع: قناة

تمثّل السمة Channel سلسلة من الإصدارات الخاصة بالموقع الإلكتروني. تحتوي جميع المواقع الإلكترونية على قناة live تلقائية تعرض المحتوى في النطاقات الفرعية المقدَّمة من Firebase وأي نطاقات مخصّصة مرتبطة.

تمثيل JSON
{
  "name": string,
  "url": string,
  "release": {
    object (Release)
  },
  "createTime": string,
  "updateTime": string,
  "retainedReleaseCount": integer,
  "labels": {
    string: string,
    ...
  },

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
الحقول
name

string

اسم المورد المؤهّل بالكامل للقناة بالتنسيق:

sites/SITE_ID/channels/CHANNEL_ID

url

string

النتائج فقط. عنوان URL الذي يمكن من خلاله عرض محتوى الإصدار الحالي لهذه القناة عنوان URL هذا هو نطاق فرعي تم توفيره من Firebase باسم web.app.

يمكن أيضًا الاطّلاع على محتوى الإصدار الحالي لهذه القناة على النطاق الفرعي firebaseapp.com الذي توفّره منصة Firebase.

إذا كانت هذه القناة هي قناة live الخاصة بالموقع الإلكتروني المضيف، يمكن أيضًا عرض محتوى الإصدار الحالي من هذه القناة على أي نطاقات خاصة مرتبطة.

release

object (Release)

النتائج فقط. تمثّل هذه السمة الإصدار الحالي للقناة، إن توفّر.

createTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه إنشاء القناة

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

updateTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه تعديل القناة آخر مرة

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

retainedReleaseCount

integer

عدد الإصدارات السابقة التي سيتمّ الاحتفاظ بها على القناة لأغراض العودة إلى الحالة السابقة أو لأغراض أخرى

يجب أن تكون القيمة رقمًا بين 1 و100. ويتم ضبط القيمة التلقائية على 10 للقنوات الجديدة.

labels

map (key: string, value: string)

تُستخدم التصنيفات النصية لتوفير بيانات وصفية و/أو فلترة إضافية.

عنصر يحتوي على قائمة بأزواج "key": value مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" }

حقل الاتحاد expiration.

يمكن أن يكون expiration واحدًا فقط مما يلي:

expireTime

string (Timestamp format)

الوقت الذي سيتم فيه حذف القناة تلقائيًا

وفي حال عدم ضبط هذه السياسة، لن يتم حذف القناة تلقائيًا. يتوفّر هذا الحقل في الناتج، سواء تم ضبطه مباشرةً أو من خلال الحقل ttl.

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

ttl

string (Duration format)

الإدخال فقط. مدة البث المباشر لهذه القناة. تضبط هذه السياسة expireTime على المدة المحدّدة بعد وقت الطلب.

مدة بالثواني مكونة من تسعة أرقام كسور كحد أقصى وتنتهي بالأرقام "s" مثال: "3.5s"

الطُرق

create

ينشئ قناة جديدة في الموقع المحدد.

delete

حذف القناة المحددة للموقع الإلكتروني المحدد.

get

لاسترداد معلومات القناة المحددة للموقع الإلكتروني المحدد.

list

يسرد القنوات الخاصة بالموقع الإلكتروني المحدّد.

patch

لتعديل معلومات القناة المحدّدة للموقع الإلكتروني المحدّد.