REST Resource: forms.watches

Ressource: Smartwatch

Eine Uhr für Ereignisse für ein Formular. Wenn das festgelegte Ereignis eintritt, wird eine Benachrichtigung für das angegebene Ziel veröffentlicht. Die Attribute der Benachrichtigung enthalten einen formId-Schlüssel mit der ID des beobachteten Formulars und einen eventType-Schlüssel mit dem String des Typs.

Nachrichten werden mindestens einmal gesendet und nur unter außergewöhnlichen Umständen gelöscht. Normalerweise sollten alle Benachrichtigungen zuverlässig innerhalb weniger Sekunden zugestellt werden. In einigen Fällen können sich Benachrichtigungen jedoch verzögern.

Eine Smartwatch läuft sieben Tage nach ihrer Erstellung ab, wenn sie nicht mit watches.renew verlängert wird

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

string

Nur Ausgabe Die ID dieser Smartwatch. Siehe Hinweise zu CreateWatchRequest.watch_id.
target

object (WatchTarget)

Erforderlich. Wo soll die Benachrichtigung gesendet werden?
eventType

enum (EventType)

Erforderlich. Welcher Ereignistyp Sie beobachten möchten.
createTime

string (Timestamp format)

Nur Ausgabe Zeitstempel für die Erstellung.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Nur Ausgabe Zeitstempel für den Ablauf. Bei jedem watches.renew-Aufruf wird dieser Wert auf sieben Tage in der Zukunft zurückgesetzt.

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
errorType

enum (ErrorType)

Nur Ausgabe Der letzte Fehlertyp für einen Übermittlungsversuch. Um das Formular wieder anzusehen, kann ein Aufruf an watches.renew gesendet werden. Dadurch werden ebenfalls diese Fehlerinformationen gelöscht.
state

enum (State)

Nur Ausgabe Der aktuelle Status der Uhr. Weitere Informationen zu gesperrten Smartwatches finden Sie auf der errorType.

WatchTarget

Das Ziel für die Zustellung von Benachrichtigungen.

JSON-Darstellung 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
Felder
Union-Feld target Erforderlich. Das Ziel für die Zustellung von Benachrichtigungen. Für target ist nur einer der folgenden Werte zulässig:
topic

object (CloudPubsubTopic)

Ein Pub/Sub-Thema. Damit Sie Benachrichtigungen erhalten können, muss das Thema dem Google Formulare-Dienstkonto serviceAccount:forms-notifications@system.gserviceaccount.com Veröffentlichungsberechtigungen gewähren. Nur das Projekt, zu dem ein Thema gehört, kann eine Smartwatch damit erstellen.

Pub/Sub-Auslieferungsgarantien sollten berücksichtigt werden.

CloudPubsubTopic

Ein Pub/Sub-Thema.

JSON-Darstellung 
{
  "topicName": string
}
Felder
topicName

string

Erforderlich. Ein voll qualifizierter Pub/Sub-Themenname, in dem die Ereignisse veröffentlicht werden sollen. Dieses Thema muss dem aufrufenden Projekt gehören und bereits in Pub/Sub vorhanden sein.

EventType

Mögliche Ereignistypen, die beobachtet werden können.

Enums
EVENT_TYPE_UNSPECIFIED Nicht angegebener Ereignistyp. Dieser Wert sollte nicht verwendet werden.
SCHEMA Der Ereignistyp „Schema“. Eine Uhr mit diesem Ereignistyp wird über Änderungen an Formularinhalten und -einstellungen benachrichtigt.
RESPONSES Der Ereignistyp „Responses“. Eine Uhr mit diesem Ereignistyp wird benachrichtigt, wenn Formularantworten gesendet werden.

ErrorType

Mögliche Fehlertypen.

Enums
ERROR_TYPE_UNSPECIFIED Unbekannter Fehlertyp.
PROJECT_NOT_AUTHORIZED Das Cloud-Projekt hat keinen Zugriff auf das beobachtete Formular. Dies ist der Fall, wenn der Nutzer die Autorisierung des Projekts für den Zugriff auf seine Formulare widerrufen hat. Für Smartwatches mit diesem Fehler wird kein erneuter Versuch gestartet. Wenn Sie das Formular noch einmal ansehen möchten, können Sie watches.renew anrufen
NO_USER_ACCESS Der Nutzer, der den Zugriff gewährt hat, hat keinen Zugriff mehr auf das beobachtete Formular. Für Smartwatches mit diesem Fehler wird kein erneuter Versuch gestartet. Wenn Sie das Formular noch einmal ansehen möchten, können Sie watches.renew anrufen
OTHER_ERRORS Ein anderer Fehlertyp ist aufgetreten. Ob die Benachrichtigungen fortgesetzt werden, hängt von der state der Smartwatch ab.

Status

Mögliche Überwachungsstatus.

Enums
STATE_UNSPECIFIED Nicht angegebener Zustand.
ACTIVE Smartwatch ist aktiv.
SUSPENDED Die Uhr wurde aufgrund eines Fehlers gesperrt, der möglicherweise behoben wird. Die Smartwatch bleibt bestehen, bis sie abläuft. Du kannst versuchen, die Smartwatch wieder zu aktivieren, indem du die Nummer watches.renew anrufst

Methoden

create

 Erstelle eine neue Smartwatch.

delete

 Smartwatch löschen.

list

 Gibt eine Liste der Smartwatches zurück, die zum aufrufenden Projekt gehören.

renew

 Verlängere eine vorhandene Smartwatch um sieben Tage.