REST Resource: forms.watches

Risorsa: smartwatch

Uno smartwatch per gli eventi di un modulo. Quando si verifica l'evento designato, viene pubblicata una notifica per il target specificato. Gli attributi della notifica includeranno una chiave formId con l'ID del modulo controllato e una chiave eventType con la stringa del tipo.

I messaggi vengono inviati con consegna "at least once" e vengono ignorati solo in circostanze straordinarie. In genere tutte le notifiche dovrebbero essere recapitate in modo affidabile entro pochi secondi; tuttavia, in alcune situazioni, le notifiche potrebbero subire dei ritardi.

Uno smartwatch scade sette giorni dopo la creazione a meno che non venga rinnovato con watches.renew

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

string

Solo output. L'ID di questo smartwatch. Vedi le note su CreateWatchRequest.watch_id.
target

object (WatchTarget)

Obbligatorio. Dove inviare la notifica.
eventType

enum (EventType)

Obbligatorio. Il tipo di evento da guardare.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Solo output. Timestamp della scadenza. Ogni chiamata watches.renew reimposta questo valore sui sette giorni futuri.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
errorType

enum (ErrorType)

Solo output. Il tipo di errore più recente relativo a un tentativo di consegna. Per ricominciare a guardare il modulo, è possibile effettuare una chiamata al numero watches.renew, che cancella anche le informazioni relative all'errore.
state

enum (State)

Solo output. Lo stato attuale dello smartwatch. Puoi trovare ulteriori informazioni sugli smartwatch sospesi consultando la errorType.

WatchTarget

La destinazione per la consegna delle notifiche.

Rappresentazione JSON 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
Campi
Campo di unione target. Obbligatorio. La destinazione per la consegna delle notifiche. target può essere solo uno dei seguenti:
topic

object (CloudPubsubTopic)

Un argomento Pub/Sub. Per ricevere le notifiche, l'argomento deve concedere i privilegi di pubblicazione all'account di servizio Moduli serviceAccount:forms-notifications@system.gserviceaccount.com. Solo il progetto proprietario di un argomento può utilizzarlo per creare uno smartwatch.

Occorre prendere in considerazione le garanzie di pubblicazione di Pub/Sub.

CloudPubsubTopic

Un argomento Pub/Sub.

Rappresentazione JSON 
{
  "topicName": string
}
Campi
topicName

string

Obbligatorio. Un nome di argomento Pub/Sub completo in cui pubblicare gli eventi. Questo argomento deve essere di proprietà del progetto chiamante ed esiste già in Pub/Sub.

EventType

Possibili tipi di eventi che possono essere guardati.

Enum
EVENT_TYPE_UNSPECIFIED Tipo di evento non specificato. Questo valore non deve essere utilizzato.
SCHEMA Il tipo di evento dello schema. Uno smartwatch con questo tipo di evento riceverà notifiche sulle modifiche ai contenuti e alle impostazioni del modulo.
RESPONSES Il tipo di evento delle risposte. Uno smartwatch con questo tipo di evento riceverà una notifica quando vengono inviate le risposte del modulo.

ErrorType

Possibili tipi di errore.

Enum
ERROR_TYPE_UNSPECIFIED Tipo di errore non specificato.
PROJECT_NOT_AUTHORIZED Il progetto cloud non ha accesso al modulo monitorato. Questo accade se l'utente ha revocato l'autorizzazione per il tuo progetto ad accedere ai propri moduli. Non verranno riprovati gli smartwatch con questo errore. Per riprovare a guardare il modulo, è possibile chiamare watches.renew
NO_USER_ACCESS L'utente che ha concesso l'accesso non ha più accesso al modulo che stai guardando. Non verranno riprovati gli smartwatch con questo errore. Per riprovare a guardare il modulo, è possibile chiamare watches.renew
OTHER_ERRORS Si è verificato un altro tipo di errore. La continuazione delle notifiche dipende dall'orologio state.

Stato

Possibili stati di visualizzazione.

Enum
STATE_UNSPECIFIED Stato non specificato.
ACTIVE Smartwatch attivo.
SUSPENDED Lo smartwatch è stato sospeso a causa di un errore che potrebbe essere risolto. Lo smartwatch rimarrà attivo fino alla scadenza. Per tentare di riattivare lo smartwatch è possibile effettuare una chiamata al numero watches.renew

Metodi

create

 Crea un nuovo orologio.

delete

 Elimina uno smartwatch.

list

 Restituisce un elenco degli smartwatch di proprietà del progetto che ha richiamato il servizio.

renew

 Rinnova uno smartwatch esistente per sette giorni.