REST Resource: forms.watches

Risorsa: Guarda

Un monitoraggio degli eventi per un modulo. Quando si verifica l'evento designato, viene pubblicata una notifica nel target specificato. Gli attributi della notifica includeranno una chiave formId con l'ID del modulo visualizzato e una chiave eventType con la stringa del tipo.

I messaggi vengono inviati con la modalità di recapito "almeno una volta" e vengono eliminati solo in circostanze straordinarie. In genere, tutte le notifiche dovrebbero essere inviate in modo affidabile entro pochi secondi. Tuttavia, in alcune situazioni le notifiche potrebbero subire dei ritardi.

Un'opzione scadrà sette giorni dopo la creazione, a meno che non venga rinnovata 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. Consulta le note su CreateWatchRequest.watch_id.
target

object (WatchTarget)

Obbligatorio. Dove inviare la notifica.
eventType

enum (EventType)

Obbligatorio. Il tipo di evento da monitorare.
createTime

string (Timestamp format)

Solo output. Timestamp della creazione.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
expireTime

string (Timestamp format)

Solo output. Timestamp della data di scadenza. Ogni chiamata watches.renew reimposta questo valore su sette giorni nel futuro.

Utilizza RFC 3339, in cui l'output generato sarà sempre normalizzato in base a Z e utilizza 0, 3, 6 o 9 cifre decimali. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
errorType

enum (ErrorType)

Solo output. Il tipo di errore più recente per un tentativo di importazione. Per ricominciare a guardare il modulo, puoi chiamare il numero watches.renew, che cancella anche queste informazioni di errore.
state

enum (State)

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

WatchTarget

La destinazione per l'invio 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 unione target. Obbligatorio. La destinazione per l'invio delle notifiche. 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 di Moduli serviceAccount:forms-notifications@system.gserviceaccount.com. Solo il progetto proprietario di un argomento può creare un orologio con questo argomento.

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

CloudPubsubTopic

Un argomento Pub/Sub.

Rappresentazione JSON 
{
  "topicName": string
}
Campi
topicName

string

Obbligatorio. Un nome di argomento Pub/Sub completo a 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 relativa alle modifiche ai contenuti e alle impostazioni del modulo.
RESPONSES Il tipo di evento di risposta. Un orologio con questo tipo di evento riceverà una notifica quando le risposte al modulo vengono inviate.

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. Ciò si verifica se l'utente ha revocato l'autorizzazione per il tuo progetto di accedere ai suoi moduli. Per gli smartwatch con questo errore non verrà eseguito un nuovo tentativo. Per tentare di ricominciare a guardare il modulo, puoi chiamare il numero watches.renew
NO_USER_ACCESS L'utente che ha concesso l'accesso non ha più accesso al modulo visualizzato. Per gli smartwatch con questo errore non verrà eseguito un nuovo tentativo. Per tentare di ricominciare a guardare il modulo, puoi chiamare il numero watches.renew
OTHER_ERRORS Si è verificato un altro tipo di errore. La continuazione delle notifiche dipende dallo smartwatch state.

Stato

Possibili stati di Watch.

Enum
STATE_UNSPECIFIED Stato non specificato.
ACTIVE Lo smartwatch è attivo.
SUSPENDED Lo smartwatch è sospeso a causa di un errore che potrebbe essere risolto. Lo smartwatch continuerà a esistere fino alla scadenza. Per tentare di riattivare lo smartwatch, puoi chiamare il numero watches.renew

Metodi

create

 Crea un nuovo orologio.

delete

 Eliminare uno smartwatch.

list

 Restituisce un elenco degli smartwatch di proprietà del progetto che esegue l'invocazione.

renew

 Rinnova uno smartwatch esistente per sette giorni.