REST Resource: channels

Zasób: Channel

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

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

map (key: string, value: string)

Dodatkowe parametry kontrolujące działanie kanału dostarczania. Opcjonalnie.

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

payload

boolean

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

id

string

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

resourceId

string

Nieczytelny identyfikator, który wskazuje zasób oglądany na tym kanale. Stabilny w różnych wersjach interfejsu API.

resourceUri

string

Identyfikator oglądanego zasobu właściwy dla konkretnej wersji.

token

string

Dowolny ciąg znaków dostarczany na adres docelowy z każdym powiadomieniem wysyłanym tym kanałem. Opcjonalnie.

expiration

string (int64 format)

Data i godzina wygaśnięcia kanału powiadomień w formacie sygnatury czasowej systemu UNIX (w milisekundach). Opcjonalnie.

type

string

Typ mechanizmu dostarczania używanego w przypadku tego kanału. Prawidłowe wartości to „web_hook” lub „webhook”.

address

string

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

kind

string

Określa, że jest to kanał powiadomień używany do śledzenia zmian w zasobie, czyli api#channel.

Metody

stop

Przestaje oglądać zasoby za pomocą tego kanału.