REST Resource: forms.watches

Zasób: Watch

Obserwowanie zdarzeń związanych z formularzem. Po wystąpieniu określonego zdarzenia zostanie opublikowane powiadomienie w określonym miejscu docelowym. Atrybuty powiadomienia będą zawierać klucz formId z identyfikatorem oglądanego formularza oraz klucz eventType, który zawiera ciąg znaków danego typu.

Wiadomości są wysyłane co najmniej raz i są wysyłane tylko w wyjątkowych okolicznościach. Zazwyczaj wszystkie powiadomienia są dostarczane prawidłowo w ciągu kilku sekund, ale w niektórych sytuacjach mogą być opóźnione.

Zegarek traci ważność po 7 dniach od utworzenia, chyba że zostanie odnowiona na stronie watches.renew

Zapis JSON 
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
Pola
id

string

Tylko dane wyjściowe. Identyfikator tego zegarka. Zobacz notatki na temat: CreateWatchRequest.watch_id.
target

object (WatchTarget)

To pole jest wymagane. Gdzie wysłać powiadomienie.
eventType

enum (EventType)

To pole jest wymagane. Typ zdarzenia, który należy obserwować.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia tego elementu.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa wygaśnięcia ważności. Każde połączenie w usłudze watches.renew resetuje ustawienie na 7 dni do przodu.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
errorType

enum (ErrorType)

Tylko dane wyjściowe. Najnowszy typ błędu dotyczącego próby dostarczenia. Aby ponownie rozpocząć oglądanie formularza, należy nawiązać połączenie pod numer watches.renew, co spowoduje też usunięcie tych informacji o błędzie.
state

enum (State)

Tylko dane wyjściowe. Bieżący stan zegarka. Dodatkowe informacje na temat zawieszonych zegarków znajdziesz tutaj: errorType.

WatchTarget

Cel dostarczania powiadomień.

Zapis JSON 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
Pola
Pole sumy target. To pole jest wymagane. Cel dostarczania powiadomień. target może mieć tylko jedną z tych wartości:
topic

object (CloudPubsubTopic)

Temat Pub/Sub. Aby otrzymywać powiadomienia, temat musi przyznać uprawnienia do publikowania kontu usługi Formularzy serviceAccount:forms-notifications@system.gserviceaccount.com. Tylko projekt będący właścicielem tematu może utworzyć w nim zegarek.

Należy wziąć pod uwagę gwarancje dostarczania Pub/Sub.

CloudPubsubTopic

Temat Pub/Sub.

Zapis JSON 
{
  "topicName": string
}
Pola
topicName

string

To pole jest wymagane. Pełna nazwa tematu Pub/Sub, w którym chcesz opublikować zdarzenia. Ten temat musi należeć do projektu wywołującego i już istnieje w Pub/Sub.

EventType

Możliwe typy zdarzeń, które można obserwować.

Wartości w polu enum
EVENT_TYPE_UNSPECIFIED Nieokreślony typ zdarzenia. Nie należy używać tej wartości.
SCHEMA Typ zdarzenia schematu. Zegarek, na którym wystąpił ten typ wydarzenia, otrzyma powiadomienia o zmianach w treści i ustawieniach formularza.
RESPONSES Typ zdarzenia odpowiedzi. Zegarek z tym typem zdarzenia zostanie powiadomiony po przesłaniu odpowiedzi na formularz.

ErrorType

Możliwe typy błędów.

Wartości w polu enum
ERROR_TYPE_UNSPECIFIED Nieokreślony typ błędu.
PROJECT_NOT_AUTHORIZED Projekt w chmurze nie ma dostępu do obserwowanego formularza. Dzieje się tak, gdy użytkownik cofnął uprawnienia Twojego projektu do dostępu do formularzy. Zegarki z tym błędem nie zostaną ponowione. Aby ponownie rozpocząć oglądanie formularza, nawiąż połączenie z numerem watches.renew
NO_USER_ACCESS Użytkownik, który przyznał dostęp, nie ma już dostępu do obserwowanego formularza. Zegarki z tym błędem nie zostaną ponowione. Aby ponownie rozpocząć oglądanie formularza, nawiąż połączenie z numerem watches.renew
OTHER_ERRORS Inny typ błędu To, czy powiadomienia będą nadal aktywne, zależy od zegarka state.

Stan

Możliwe stany zegarka.

Wartości w polu enum
STATE_UNSPECIFIED Nieokreślony stan.
ACTIVE Zegarek jest aktywny.
SUSPENDED Zegarek jest zawieszony z powodu błędu, który można usunąć. Zegarek będzie istniał do momentu wygaśnięcia ważności. Aby ponownie aktywować zegarek, nawiąż połączenie z numerem watches.renew

Metody

create

 Utwórz nowy zegarek.

delete

 usunąć zegarek;

list

 Zwraca listę zegarków należących do projektu wywołującego.

renew

 Możesz odnowić dotychczasowy zegarek na 7 dni.