REST Resource: sites.channels

リソース: チャネル

Channelサイトのリリースのストリームを表します。すべてのサイトには、Firebase が提供するサブドメインと接続されているカスタム ドメインにコンテンツを提供するデフォルトのliveチャネルがあります。

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のサブドメインです。

このチャンネルの現在のリリースのコンテンツは、Firebase が提供するfirebaseapp.comのサブドメインでも表示できます。

このチャネルがホスティング サイトのliveチャネルである場合、このチャネルの現在のリリースのコンテンツは、接続されているカスタム ドメインでも表示できます。

release

object ( Release )

出力のみ。チャネルの現在のリリース (存在する場合)。

createTime

string ( Timestamp format)

出力のみ。チャネルが作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

updateTime

string ( Timestamp format)

出力のみ。チャンネルが最後に更新された時刻。

RFC3339 UTC「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次のいずれか 1 つだけです。

expireTime

string ( Timestamp format)

チャンネルが自動的に削除される時刻。

null の場合、チャネルは自動的に削除されません。このフィールドは、直接設定されたかttlフィールド経由で設定されたかに関係なく、出力に存在します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。ナノ秒の分解能と最大 9 桁の小数点以下を備えています。例: "2014-10-02T15:01:23Z"および"2014-10-02T15:01:23.045123456Z"

ttl

string ( Duration format)

入力のみ。このチャンネルの有効期限。 expireTimeリクエストの時刻を過ぎた指定された期間に設定します。

s 」で終わる最大 9 桁の小数点以下の秒単位の期間。例: "3.5s"

メソッド

create

指定されたサイトに新しいチャネルを作成します。

delete

指定したサイトの指定したチャンネルを削除します。

get

指定されたサイトの指定されたチャネルの情報を取得します。

list

指定したサイトのチャネルをリストします。

patch

指定されたサイトの指定されたチャンネルの情報を更新します。