REST Resource: forms.watches

Risorsa: orologio

Un orologio per gli eventi di un modulo. Quando si verifica l'evento designato, viene pubblicata una notifica per la destinazione specificata. 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 eliminati solo in circostanze straordinarie. In genere tutte le notifiche vengono inviate 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. Visualizza le note su CreateWatchRequest.watch_id.
target

object (WatchTarget)

Obbligatorio. Dove inviare la notifica.
eventType

enum (EventType)

Obbligatorio. Il tipo di evento da controllare.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione.

Un timestamp nel formato RFC3339 UTC "Zulu" 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 il valore su sette giorni nel futuro.

Un timestamp nel formato RFC3339 UTC "Zulu" 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 per un tentativo di consegna. Per iniziare a guardare di nuovo il modulo, è possibile effettuare una chiamata al numero watches.renew, che cancella anche queste informazioni sull'errore.
state

enum (State)

Solo output. Lo stato attuale dello smartwatch. Per ulteriori dettagli sugli orologi sospesi, consulta la errorType.

WatchTarget

Il target per il recapito della notifica.

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 unione target. Obbligatorio. Il target per il recapito della notifica. target può essere solo uno dei seguenti:
topic

object (CloudPubsubTopic)

Un argomento Pub/Sub. Per ricevere 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ò creare un orologio con l'argomento.

È necessario prendere in considerazione le garanzie di consegna Pub/Sub.

CloudPubsubTopic

Un argomento Pub/Sub.

Rappresentazione JSON 
{
  "topicName": string
}
Campi
topicName

string

Obbligatorio. Un nome completo per l'argomento Pub/Sub in cui pubblicare gli eventi. Questo argomento deve essere di proprietà del progetto chiamante ed esistere 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. Un orologio con questo tipo di evento riceverà una notifica sulle modifiche ai contenuti e alle impostazioni del modulo.
RESPONSES Il tipo di evento delle risposte. Un orologio con questo tipo di evento riceverà una notifica quando vengono inviate le risposte del modulo.

ErrorType

Tipi di errori possibili.

Enum
ERROR_TYPE_UNSPECIFIED Tipo di errore non specificato.
PROJECT_NOT_AUTHORIZED Il progetto cloud non ha accesso al modulo controllato. Questo accade se l'utente ha revocato l'autorizzazione ad accedere ai moduli del tuo progetto. Gli smartwatch con questo errore non verranno tentati di nuovo. Per riprovare a guardare il modulo, è possibile effettuare una chiamata al numero watches.renew
NO_USER_ACCESS L'utente che ha concesso l'accesso non può più accedere al modulo visualizzato. Gli smartwatch con questo errore non verranno tentati di nuovo. Per riprovare a guardare il modulo, è possibile effettuare una chiamata al numero watches.renew
OTHER_ERRORS Si è verificato un altro tipo di errore. La possibilità di continuare o meno la ricezione delle notifiche dipende dall'orologio state.

Stato

Possibili stati dell'orologio.

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 continuerà a essere attivo fino alla scadenza. Per tentare di riattivare lo smartwatch, è possibile effettuare una chiamata al numero watches.renew

Metodi

create

 Crea un nuovo smartwatch.

delete

 Elimina uno smartwatch.

list

 Restituisce un elenco degli smartwatch di proprietà del progetto di chiamata.

renew

 Rinnova uno smartwatch esistente per sette giorni.