REST Resource: channels

Zasób: Kanał

Kanał powiadomień używany do monitorowania zmian zasobów.

Zapis JSON
{
  "payload": boolean,
  "id": string,
  "resourceId": string,
  "resourceUri": string,
  "token": string,
  "expiration": string,
  "type": string,
  "address": string,
  "params": {
    string: string,
    ...
  },
  "kind": string
}
Pola
payload

boolean

Wartość logiczna wskazująca, czy potrzebny jest ładunek. Opcjonalnie.

id

string

Identyfikator UUID lub podobny unikalny ciąg znaków, który identyfikuje ten kanał.

resourceId

string

Nieprzejrzysty identyfikator identyfikujący zasób, który chcesz oglądać na tym kanale. Stabilna w różnych wersjach interfejsu API.

resourceUri

string

Identyfikator wersji obserwowanego zasobu.

token

string

Dowolny ciąg znaków wysyłany na adres docelowy wraz z każdym powiadomieniem przesłanym na ten kanał. Opcjonalnie.

expiration

string (int64 format)

Data i godzina wygaśnięcia kanału powiadomień w milisekundach, w postaci sygnatury czasowej uniksowej. Opcjonalnie.

type

string

Typ mechanizmu przesyłania używany w tym kanale. Prawidłowe wartości to „web_hook” lub „webhook”.

address

string

Adres, na który są dostarczane powiadomienia dotyczące tego kanału.

params

map (key: string, value: string)

Dodatkowe parametry kontrolujące zachowanie kanału wyświetlania. Opcjonalnie.

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

kind

string

Określa go jako kanał powiadomień używany do monitorowania zmian w zasobie api#channel.

Metody

stop

Nie będzie już oglądać zasobów na tym kanale.