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 wymagany jest ładunek. Opcjonalnie:

id

string

identyfikator UUID lub podobny, unikalny ciąg znaków identyfikujący ten kanał;

resourceId

string

Nieprzejrzysty identyfikator określający zasób oglądany na tym kanale. Stabilny w różnych wersjach interfejsu API.

resourceUri

string

Identyfikator wersji monitorowanego zasobu.

token

string

Dowolny ciąg znaków dostarczany na adres docelowy wraz z każdym powiadomieniem przesł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 stosowanego w przypadku tego kanału. Prawidłowe wartości to „web_hook” czy „webhook”.

address

string

Adres, na który są dostarczane powiadomienia z 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

Identyfikuje go jako kanał powiadomień używany do obserwowania zmian w zasobie, czyli api#channel.

Metody

stop

Przestaje oglądać zasoby z tego kanału.