REST Resource: forms.watches

Ressource: Uhr

Ein Warten auf Ereignisse für ein Formular. Wenn das angegebene Ereignis eintritt, wird eine Benachrichtigung an 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 mit der Zustellung mindestens einmal gesendet und nur in außergewöhnlichen Fällen verworfen. Normalerweise sollten alle Benachrichtigungen innerhalb weniger Sekunden zuverlässig zugestellt werden. In einigen Fällen kann es jedoch zu Verzögerungen kommen.

Eine Wiedergabeliste läuft sieben Tage nach der 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 die Benachrichtigung gesendet werden soll.
eventType

enum (EventType)

Erforderlich. Der Ereignistyp, auf den geachtet werden soll.
createTime

string (Timestamp format)

Nur Ausgabe. Zeitstempel für die Erstellung.

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
expireTime

string (Timestamp format)

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

Es wird RFC 3339 verwendet, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Glieder mit Dezimalstellen enthält. Andere Achsenbezeichnungen als „Z“ sind ebenfalls zulässig. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
errorType

enum (ErrorType)

Nur Ausgabe. Der letzte Fehlertyp für einen Zustellungsversuch. Wenn du das Formular noch einmal ansehen möchtest, kannst du watches.renew aufrufen. Dadurch werden auch diese Fehlerinformationen gelöscht.
state

enum (State)

Nur Ausgabe. Der aktuelle Status der Smartwatch. Weitere Informationen zu gesperrten Smartwatches finden Sie in der errorType.

WatchTarget

Das Ziel für die Benachrichtigungsübermittlung.

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 Benachrichtigungsübermittlung. Für target ist nur einer der folgenden Werte zulässig:
topic

object (CloudPubsubTopic)

Ein Pub/Sub-Thema. Damit Benachrichtigungen empfangen werden können, muss das Thema dem Forms-Dienstkonto serviceAccount:forms-notifications@system.gserviceaccount.com Veröffentlichungsberechtigungen gewähren. Nur das Projekt, dem ein Thema zugewiesen ist, kann damit eine Beobachtung erstellen.

Die Zustellungsgarantien von Pub/Sub sollten berücksichtigt werden.

CloudPubsubTopic

Ein Pub/Sub-Thema.

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

string

Erforderlich. Ein vollständig qualifizierter Name des Pub/Sub-Themas, 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 des Schemas. Bei einer Smartwatch mit diesem Ereignistyp werden Änderungen an Formularinhalten und -einstellungen benachrichtigt.
RESPONSES Der Ereignistyp „Antworten“. Eine Smartwatch 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. Das ist der Fall, wenn der Nutzer die Autorisierung für Ihr Projekt widerrufen hat, auf seine Formulare zuzugreifen. Bei Smartwatches mit diesem Fehler wird kein neuer Versuch unternommen. Wenn Sie versuchen möchten, das Formular noch einmal anzusehen, 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. Bei Smartwatches mit diesem Fehler wird kein neuer Versuch unternommen. Wenn Sie versuchen möchten, das Formular noch einmal anzusehen, können Sie watches.renew anrufen.
OTHER_ERRORS Ein anderer Fehlertyp ist aufgetreten. Ob Benachrichtigungen weiterhin angezeigt werden, hängt von der Smartwatch state ab.

Status

Mögliche Status der Smartwatch

Enums
STATE_UNSPECIFIED Nicht angegebener Zustand.
ACTIVE Die Smartwatch ist aktiv.
SUSPENDED Die Smartwatch ist aufgrund eines Fehlers gesperrt, der möglicherweise behoben werden kann. Die Uhr bleibt bis zum Ablaufdatum aktiv. Wenn Sie versuchen möchten, die Smartwatch zu reaktivieren, können Sie watches.renew anrufen.

Methoden

create

 Erstellen Sie eine neue Smartwatch.

delete

 Smartwatch löschen

list

 Gibt eine Liste der Smartwatches zurück, deren Eigentümer das aufrufende Projekt ist.

renew

 Verlängere die Laufzeit einer bestehenden Smartwatch um sieben Tage.