REST Resource: channels

Zasób: kanał

Kanał powiadomień używany do sprawdzania zmian w zasobach.

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 identyfikujący ten kanał.

resourceId

string

Nieczytelny identyfikator identyfikujący zasób odtwarzany na tym kanale. stabilny w różnych wersjach interfejsu API;

resourceUri

string

Identyfikator zasobu monitorowanego w konkretnej wersji.

token

string

dowolny ciąg znaków dostarczany na adres docelowy wraz z każdym powiadomieniem wysyłanym przez ten kanał. Opcjonalnie.

expiration

string (int64 format)

Data i godzina wygaśnięcia kanału powiadomień wyrażona jako sygnatura czasowa systemu UNIX w milisekundach. Opcjonalnie.

type

string

Typ mechanizmu wyświetlania używanego na tym kanale. Prawidłowe wartości to „web_hook” lub „webhook”.

address

string

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

params

map (key: string, value: string)

dodatkowe parametry kontrolujące działanie kanału dostawczego; Opcjonalnie.

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

kind

string

Określa ten kanał jako kanał powiadomień używany do sprawdzania zmian w zasobach (api#channel).

Metody

stop

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