REST Resource: forms.watches

Ressource: Ansehen

Eine Überwachung von Ereignissen für ein Formular. Wenn das festgelegte Ereignis eintritt, wird eine Benachrichtigung im angegebenen 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 zugestellt und nur unter außergewöhnlichen Umständen gelöscht. Normalerweise werden alle Benachrichtigungen zuverlässig innerhalb weniger Sekunden zugestellt. In einigen Fällen können sich Benachrichtigungen jedoch verzögern.

Eine Smartwatch läuft sieben Tage nach ihrer Erstellung ab, sofern 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. An wen soll die Benachrichtigung gesendet werden?
eventType

enum (EventType)

Erforderlich. Der Ereignistyp, der überwacht werden soll.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel der Erstellung.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich 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 das Ablaufdatum. Bei jedem watches.renew-Aufruf wird dieser Wert auf sieben Tage in der Zukunft zurückgesetzt.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich 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 Zustellungsversuch. Wenn Sie das Formular noch einmal ansehen möchten, können Sie watches.renew anrufen. Dadurch werden auch diese Fehlerinformationen gelöscht.
state

enum (State)

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

WatchTarget

Das Ziel für die Zustellung von Benachrichtigungen.

JSON-Darstellung 
{
  "topic": {
    object (CloudPubsubTopic)
  }
}
Felder
topic

object (CloudPubsubTopic)

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

Es sollten Pub/Sub-Auslieferungsgarantien 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 spezifizierter Ereignistyp. Dieser Wert sollte nicht verwendet werden.
SCHEMA Der Schemaereignistyp. Eine Uhr mit diesem Ereignistyp wird über Änderungen an Formularinhalten und -einstellungen benachrichtigt.
RESPONSES Der Ereignistyp „Antworten“. 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 für den Zugriff auf seine Formulare für Ihr Projekt widerrufen hat. Wiedergaben mit diesem Fehler werden nicht wiederholt. Sie können watches.renew anrufen, um das Formular noch einmal anzusehen
NO_USER_ACCESS Der Nutzer, der Zugriff gewährt hat, hat keinen Zugriff mehr auf das beobachtete Formular. Wiedergaben mit diesem Fehler werden nicht wiederholt. Sie können watches.renew anrufen, um das Formular noch einmal anzusehen
OTHER_ERRORS Ein anderer Fehlertyp ist aufgetreten. Ob du weiterhin Benachrichtigungen erhältst, 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 einen Anruf an watches.renew schickst

Methoden

create

 Neue Smartwatch erstellen.

delete

 Smartwatch löschen.

list

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

renew

 Vorhandene Smartwatch für sieben Tage verlängern