REST Resource: sites.channels

Kaynak: Kanal

Channel, bir sitenin yayın akışını temsil eder. Tüm sitelerin, Firebase tarafından sağlanan alt alan adlarına ve bağlı özel alanlara içerik yayınlayan varsayılan bir live kanalı vardır.

JSON gösterimi
{
  "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.
}
Alanlar
name

string

Kanal için şu biçimdeki tam kaynak adı:

sites/SITE_ID/channels/CHANNEL_ID

url

string

Yalnızca çıkış. Bu kanalın mevcut yayınına ait içeriklerin görüntülenebileceği URL. Bu URL, web.app alanının Firebase tarafından sağlanan bir alt alan adıdır.

Bu kanalın mevcut sürümünün içeriği, Firebase tarafından sağlanan firebaseapp.com alt alan adında da görüntülenebilir.

Bu kanal, Hosting sitesinin live kanalıysa bu kanalın mevcut sürümünün içeriği, bağlı tüm özel alanlarda da görüntülenebilir.

release

object (Release)

Yalnızca çıkış. Kanalın mevcut yayını (varsa).

createTime

string (Timestamp format)

Yalnızca çıkış. Kanalın oluşturulduğu zaman.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Yalnızca çıkış. Kanalın son güncellendiği zaman.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

retainedReleaseCount

integer

Geri alma veya diğer amaçlar için kanalda tutulacak önceki sürümlerin sayısı.

1 ile 100 arasında bir sayı olmalıdır. Yeni kanallar için varsayılan olarak 10 değerine ayarlanır.

labels

map (key: string, value: string)

Ek meta veri ve/veya filtreleme için kullanılan metin etiketleri.

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Birleştirme alanı expiration.

expiration şunlardan yalnızca biri olabilir:

expireTime

string (Timestamp format)

Kanalın otomatik olarak silineceği saat.

Null ise kanal otomatik olarak silinmez. Bu alan, doğrudan veya ttl alanı aracılığıyla ayarlanmış olması fark etmeksizin çıkışta bulunur.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".

ttl

string (Duration format)

Yalnızca giriş. Bu kanal için geçerlilik süresi. expireTime değerini, istek zamanından sonra sağlanan süre olarak ayarlar.

En fazla dokuz kesir basamağı olan ve "s" ile biten, saniye cinsinden süre. Örnek: "3.5s".

Yöntemler

create

Belirtilen sitede yeni bir kanal oluşturur.

delete

Belirtilen sitenin belirtilen kanalını siler.

get

Belirtilen sitenin belirtilen kanalıyla ilgili bilgileri alır.

list

Belirtilen siteye ilişkin kanalları listeler.

patch

Belirtilen sitede belirtilen kanala ilişkin bilgileri günceller.