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 世界標準時間「Zulu」的時間戳記格式,解析度不超過奈秒,最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

僅供輸出。頻道上次更新的時間。

RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度不超過奈秒,最多 9 個小數位數。範例:"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 世界標準時間「Zulu」的時間戳記格式,解析度不超過奈秒,最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

ttl

string (Duration format)

僅限輸入。這個頻道的存留時間。將 expireTime 設為超過要求時間的指定期間。

持續時間以秒為單位,最多 9 個小數位數,結尾為「s」。範例:"3.5s"

方法

create

在指定網站建立新頻道。

delete

刪除指定網站的指定頻道。

get

擷取指定網站指定頻道的資訊。

list

列出指定網站的管道。

patch

更新指定網站指定頻道的資訊。