REST Resource: sites.channels

Zasób: kanał

Channel reprezentuje strumień wersji witryny. Wszystkie witryny mają domyślny kanał live, który udostępnia treści w subdomenach Firebase i wszelkich połączonych domenach niestandardowych.

Zapis 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.
}
Pola
name

string

Pełna nazwa zasobu kanału, w formacie:

sites/SITE_ID/channels/CHANNEL_ID

url

string

Tylko dane wyjściowe. Adres URL, pod którym można wyświetlać treść aktualnej premiery kanału. Ten URL to udostępniona przez Firebase subdomena web.app.

Zawartość bieżącej wersji kanału można też wyświetlać w udostępnianej przez Firebase subdomenie firebaseapp.com.

Jeśli ten kanał jest kanałem live w witrynie Hostingu, treści z bieżącej wersji tego kanału można też wyświetlać we wszystkich połączonych domenach niestandardowych.

release

object (Release)

Tylko dane wyjściowe. Obecna wersja kanału, jeśli taka istnieje.

createTime

string (Timestamp format)

Tylko dane wyjściowe. Godzina utworzenia kanału.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji kanału.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

retainedReleaseCount

integer

Liczba poprzednich wersji, które mają zostać zachowane na kanale w celu przywrócenia lub innych celów.

Wartość musi być liczbą z zakresu od 1 do 100. Domyślna wartość to 10 dla nowych kanałów.

labels

map (key: string, value: string)

Etykiety tekstowe zawierające dodatkowe metadane lub filtrowanie.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Pole sumy expiration.

expiration może mieć tylko jedną z tych wartości:

expireTime

string (Timestamp format)

Godzina, o której kanał zostanie automatycznie usunięty.

Jeśli wartość to null, kanał nie zostanie automatycznie usunięty. To pole występuje w danych wyjściowych niezależnie od tego, czy zostało ustawione bezpośrednio, czy w polu ttl.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

ttl

string (Duration format)

Tylko dane wejściowe. Czas życia tego kanału. Ustawia w polu expireTime podany czas trwania po wysłaniu żądania.

Czas trwania w sekundach składający się z maksymalnie 9 cyfr po przecinku i kończący się „s”. Przykład: "3.5s".

Metody

create

Tworzy nowy kanał w podanej witrynie.

delete

Usuwa określony kanał w określonej witrynie.

get

Pobiera informacje o określonym kanale w określonej witrynie.

list

Zawiera listę kanałów dla określonej witryny.

patch

Aktualizuje informacje dla określonego kanału w określonej witrynie.