REST Resource: sites.channels

Ressource: Kanal

Ein Channel stellt einen Stream von Veröffentlichungen für eine Site dar. Alle Websites verfügen über einen Standard- live Kanal, der Inhalte an die von Firebase bereitgestellten Subdomains und alle verbundenen benutzerdefinierten Domains bereitstellt.

JSON-Darstellung
{
  "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.
}
Felder
name

string

Der vollständig qualifizierte Ressourcenname für den Kanal im Format:

sites/ SITE_ID /channels/ CHANNEL_ID

url

string

Nur Ausgabe. Die URL, unter der der Inhalt der aktuellen Veröffentlichung dieses Kanals angezeigt werden kann. Diese URL ist eine von Firebase bereitgestellte Subdomain von web.app .

Der Inhalt der aktuellen Veröffentlichung dieses Kanals kann auch auf der von Firebase bereitgestellten Subdomain von firebaseapp.com angezeigt werden.

Wenn dieser Kanal der live Kanal für die Hosting-Site ist, kann der Inhalt der aktuellen Version dieses Kanals auch auf allen verbundenen benutzerdefinierten Domänen angezeigt werden.

release

object ( Release )

Nur Ausgabe. Die aktuelle Version für den Kanal, falls vorhanden.

createTime

string ( Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Kanal erstellt wurde.

Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem der Kanal zuletzt aktualisiert wurde.

Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z" .

retainedReleaseCount

integer

Die Anzahl früherer Versionen, die für Rollbacks oder andere Zwecke auf dem Kanal beibehalten werden sollen.

Muss eine Zahl zwischen 1 und 100 sein. Der Standardwert ist 10 für neue Kanäle.

labels

map (key: string, value: string)

Textbeschriftungen, die für zusätzliche Metadaten und/oder Filterung verwendet werden.

Ein Objekt, das eine Liste von "key": value Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

expiration des Union-Feldes.

expiration kann nur einer der folgenden sein:

expireTime

string ( Timestamp format)

Der Zeitpunkt, zu dem der Kanal automatisch gelöscht wird.

Wenn null, wird der Kanal nicht automatisch gelöscht. Dieses Feld ist in der Ausgabe vorhanden, unabhängig davon, ob es direkt oder über das ttl Feld festgelegt wird.

Ein Zeitstempel im RFC3339 UTC „Zulu“-Format mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z" .

ttl

string ( Duration format)

Nur Eingabe. Eine Zeit zum Leben für diesen Kanal. Setzt expireTime auf die angegebene Dauer nach dem Zeitpunkt der Anforderung.

Eine Dauer in Sekunden mit bis zu neun Nachkommastellen, endend mit „ s “. Beispiel: "3.5s" .

Methoden

create

 Erstellt einen neuen Kanal auf der angegebenen Site.

delete

 Löscht den angegebenen Kanal der angegebenen Site.

get

 Ruft Informationen für den angegebenen Kanal der angegebenen Site ab.

list

 Listet die Kanäle für die angegebene Site auf.

patch

 Aktualisiert Informationen für den angegebenen Kanal der angegebenen Site.