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

פלט בלבד. כתובת האתר שבה ניתן לראות את התוכן של הגרסה הנוכחית של הערוץ הזה. כתובת האתר הזו היא תת-דומיין שסופק על ידי Firebase של web.app .

ניתן לצפות בתוכן של המהדורה הנוכחית של ערוץ זה גם בתת-הדומיין שסופק על ידי Firebase של firebaseapp.com .

אם ערוץ זה הוא הערוץ live של אתר האירוח, אזי ניתן לצפות בתוכן של המהדורה הנוכחית של ערוץ זה גם בכל תחום מותאם אישית מחובר.

release

object ( Release )

פלט בלבד. המהדורה הנוכחית של הערוץ, אם בכלל.

createTime

string ( Timestamp format)

פלט בלבד. הזמן שבו נוצר הערוץ.

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

updateTime

string ( Timestamp format)

פלט בלבד. השעה שבה עודכן הערוץ לאחרונה.

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

ttl

string ( Duration format)

קלט בלבד. זמן לחיות לערוץ הזה. מגדיר את expireTime לזמן שסופק לאחר זמן הבקשה.

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

שיטות

create

 יוצר ערוץ חדש באתר שצוין.

delete

 מוחק את הערוץ שצוין של האתר שצוין.

get

 מאחזר מידע עבור הערוץ שצוין של האתר שצוין.

list

 מפרט את הערוצים עבור האתר שצוין.

patch

 מעדכן מידע עבור הערוץ שצוין של האתר שצוין.