REST Resource: forms.watches

Zasób: Watch

Obserwowanie zdarzeń w formularzu. Gdy nastąpi określone zdarzenie, powiadomienie zostanie opublikowane w wybranym miejscu docelowym. Atrybuty powiadomienia będą zawierać klucz formId z identyfikatorem obserwowanego formularza i klucz eventType z ciągiem tekstowym typu.

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

Wygasa ona po 7 dniach od utworzenia, chyba że zostanie odnowiona za pomocą 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 dotyczące CreateWatchRequest.watch_id.
target

object (WatchTarget)

Wymagany. Dokąd wysłać powiadomienie.
eventType

enum (EventType)

Wymagany. Jakiego typu zdarzenia mają być monitorowane.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
expireTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa określająca, kiedy ten element wygaśnie. Każde wywołanie funkcji watches.renew powoduje zresetowanie tego limitu do 7 dni w przyszłości.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
errorType

enum (ErrorType)

Tylko dane wyjściowe. Najnowszy typ błędu podczas próby dostarczenia. Aby ponownie zacząć sprawdzać formularz, możesz zadzwonić do watches.renew. Spowoduje to też wyczyszczenie informacji o błędach.
state

enum (State)

Tylko dane wyjściowe. bieżący stan zegarka. Więcej informacji o zawieszonych zegarkach znajdziesz w sekcji errorType.

WatchTarget

Docelowy odbiorca powiadomienia.

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 unii target. Wymagany. Docelowy odbiorca powiadomienia. target może być tylko jednym z tych elementów:
topic

object (CloudPubsubTopic)

Temat Pub/Sub. Aby otrzymywać powiadomienia, temat musi przyznać uprawnienia do publikowania kontu usługi Formularze serviceAccount:forms-notifications@system.gserviceaccount.com. Tylko projekt, który jest właścicielem tematu, może utworzyć z nim widok.

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

CloudPubsubTopic

Temat Pub/Sub.

Zapis JSON 
{
  "topicName": string
}
Pola
topicName

string

Wymagany. Pełna nazwa tematu Pub/Sub, do którego mają być publikowane zdarzenia. Temat musi należeć do wywołującego projektu i 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 w schemacie. Zegarek z tym typem zdarzenia zostanie powiadomiony o zmianach w formie treści i ustawieniach.
RESPONSES Typ zdarzenia odpowiedzi. Gdy użytkownik prześle odpowiedzi na formularz, zostanie powiadomiony o tym jego widok.

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 cofnie zezwolenie na dostęp do swoich formularzy dla Twojego projektu. Nie będziemy ponownie próbować sprawdzać zegarków, które mają ten błąd. Aby spróbować ponownie obejrzeć formularz, możesz zadzwonić do watches.renew.
NO_USER_ACCESS Użytkownik, który przyznał dostęp, nie ma już dostępu do obserwowanego formularza. Nie będziemy ponownie próbować sprawdzać zegarków, które mają ten błąd. Aby spróbować ponownie obejrzeć formularz, możesz zadzwonić do watches.renew.
OTHER_ERRORS Wystąpił inny typ błędu. To, czy powiadomienia będą nadal wysyłane, zależy od zegarka state.

Stan

Możliwe stany zegarka

Wartości w polu enum
STATE_UNSPECIFIED Nieokreślony stan.
ACTIVE Odtwarzanie jest aktywne.
SUSPENDED Zegarek jest zawieszony z powodu błędu, który można usunąć. Zegarek będzie widoczny do momentu wygaśnięcia. Aby spróbować ponownie aktywować zegarek, zadzwoń pod numer watches.renew.

Metody

create

 Utwórz nowy zegarek.

delete

 usunąć zegarek.

list

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

renew

 odnowić istniejący nadzór przez 7 dni,