REST Resource: forms.watches

Zasób: obejrzyj

Monitorowanie zdarzeń dotyczących formularza. Gdy wystąpi określone zdarzenie, dla określonego środowiska docelowego zostanie opublikowane powiadomienie. Atrybuty powiadomienia będą zawierać klucz formId z identyfikatorem obserwowanych formularzy i klucz eventType z ciągiem znaków typu.

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

Zegarek traci ważność po 7 dniach od utworzenia, chyba że zostanie odnowiony w dniu 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)

Wymagane. Gdzie wysłać powiadomienie.
eventType

enum (EventType)

Wymagane. Typ zdarzenia, na które zwracać uwagę.
createTime

string (Timestamp format)

Tylko dane wyjściowe. sygnatura czasowa utworzenia;

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 wywołanie watches.renew resetuje tę wartość do 7 dni.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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. Ostatni typ błędu, który wystąpił podczas próby dostarczenia. Aby ponownie rozpocząć oglądanie formularza, można nawiązać połączenie z numerem 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 o zawieszonych zegarkach znajdziesz w errorType.

WatchTarget

Cel dostarczenia 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. Wymagane. Cel dostarczenia 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 na koncie usługi Formularze serviceAccount:forms-notifications@system.gserviceaccount.com. Tylko projekt, do którego należy temat, może utworzyć za jego pomocą zegarek.

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

CloudPubsubTopic

Temat Pub/Sub.

Zapis JSON 
{
  "topicName": string
}
Pola
topicName

string

Wymagane. Pełna nazwa tematu Pub/Sub, w którym będą publikowane zdarzenia. Ten temat musi należeć do projektu wywołującego i musi już istnieć w Pub/Sub.

EventType

Możliwe typy zdarzeń, które można oglądać.

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 z tym typem wydarzenia zostanie powiadomiony o zmianach w treści i ustawieniach formularza.
RESPONSES Typ zdarzenia odpowiedzi. Zegarek z tym typem wydarzenia otrzyma powiadomienie o przesłaniu odpowiedzi.

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 oglądanego formularza. Dzieje się tak, gdy użytkownik anulował autoryzację dostępu Twojego projektu do jego formularzy. Zegarki z tym błędem nie będą ponawiane. Aby ponownie rozpocząć oglądanie formularza, można nawiązać połączenie z watches.renew
NO_USER_ACCESS Użytkownik, który przyznał dostęp, nie ma już dostępu do oglądanego formularza. Zegarki z tym błędem nie będą ponawiane. Aby ponownie rozpocząć oglądanie formularza, można nawiązać połączenie z watches.renew
OTHER_ERRORS Wystąpił inny typ błędu. To, czy powiadomienia będą się nadal wyświetlać, zależy od zegarka state.

Stan

Możliwe stany zegarka.

Wartości w polu enum
STATE_UNSPECIFIED Stan nieokreślony.
ACTIVE Zegarek jest aktywny.
SUSPENDED Zegarek został zawieszony z powodu błędu, który można naprawić. Zegarek będzie działał, dopóki nie wygaśnie. Aby spróbować ponownie aktywować zegarek, można zadzwonić pod numer watches.renew

Metody

create

 Utwórz nowy zegarek.

delete

 Usuń zegarek.

list

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

renew

 Odnów obecny zegarek na 7 dni.