REST Resource: forms.watches

Resource: Watch

Pemantauan peristiwa untuk formulir. Saat peristiwa yang ditetapkan terjadi, notifikasi akan dipublikasikan ke target yang ditentukan. Atribut notifikasi akan menyertakan kunci formId yang memiliki ID formulir yang dipantau dan kunci eventType yang memiliki string jenis tersebut.

Pesan dikirim dengan pengiriman minimal satu kali, dan hanya dikirim dalam keadaan yang luar biasa. Biasanya semua notifikasi dapat terkirim secara aman dalam beberapa detik; tetapi, dalam beberapa situasi, notifikasi mungkin tertunda.

Masa berlaku smartwatch akan berakhir tujuh hari setelah dibuat kecuali jika diperpanjang dengan watches.renew

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

string

Hanya output. ID smartwatch ini. Lihat catatan di CreateWatchRequest.watch_id.
target

object (WatchTarget)

Wajib. Tujuan pengiriman notifikasi.
eventType

enum (EventType)

Wajib. Jenis peristiwa yang harus dipantau.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat pembuatan.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
expireTime

string (Timestamp format)

Hanya output. Stempel waktu saat permintaan ini akan berakhir. Setiap panggilan watches.renew akan mereset setelan ini ke tujuh hari ke depan.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
errorType

enum (ErrorType)

Hanya output. Jenis error terbaru untuk percobaan pengiriman. Untuk mulai melihat formulir lagi, panggilan dapat dilakukan ke watches.renew yang juga akan menghapus informasi error ini.
state

enum (State)

Hanya output. Status smartwatch saat ini. Detail tambahan tentang smartwatch yang ditangguhkan dapat ditemukan dengan memeriksa errorType.

WatchTarget

Target untuk pengiriman notifikasi.

Representasi JSON 
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
Kolom
Kolom union target. Wajib. Target untuk pengiriman notifikasi. target hanya dapat berupa salah satu dari berikut:
topic

object (CloudPubsubTopic)

Topik Pub/Sub. Untuk menerima notifikasi, topik harus memberikan hak istimewa publikasi ke akun layanan Formulir serviceAccount:forms-notifications@system.gserviceaccount.com. Hanya project yang memiliki topik yang dapat membuat smartwatch dengan topik tersebut.

Jaminan penayangan Pub/Sub harus dipertimbangkan.

CloudPubsubTopic

Topik Pub/Sub.

Representasi JSON 
{
  "topicName": string
}
Kolom
topicName

string

Wajib. Nama topik Pub/Sub yang sepenuhnya memenuhi syarat untuk memublikasikan peristiwa. Topik ini harus dimiliki oleh project pemanggil dan sudah ada di Pub/Sub.

EventType

Kemungkinan jenis peristiwa yang dapat ditonton.

Enum
EVENT_TYPE_UNSPECIFIED Jenis peristiwa belum ditetapkan. Nilai ini tidak boleh digunakan.
SCHEMA Jenis peristiwa skema. Smartwatch dengan jenis acara ini akan diberi tahu tentang perubahan pada setelan dan konten formulir.
RESPONSES Jenis peristiwa respons. Smartwatch dengan jenis acara ini akan diberi tahu saat respons formulir dikirimkan.

ErrorType

Kemungkinan jenis error.

Enum
ERROR_TYPE_UNSPECIFIED Jenis error belum ditetapkan.
PROJECT_NOT_AUTHORIZED Project cloud tidak memiliki akses ke formulir yang sedang ditonton. Hal ini terjadi jika pengguna telah mencabut otorisasi bagi project Anda untuk mengakses formulir mereka. Smartwatch yang memiliki error ini tidak akan dicoba lagi. Untuk mencoba melihat formulir lagi, panggilan dapat dilakukan ke watches.renew
NO_USER_ACCESS Pengguna yang memberikan akses tidak lagi memiliki akses ke formulir yang sedang ditonton. Smartwatch yang memiliki error ini tidak akan dicoba lagi. Untuk mencoba melihat formulir lagi, panggilan dapat dilakukan ke watches.renew
OTHER_ERRORS Terjadi jenis kesalahan lainnya. Apakah notifikasi akan berlanjut bergantung pada state smartwatch.

Negara Bagian

Kemungkinan status Smartwatch.

Enum
STATE_UNSPECIFIED Status tidak ditentukan.
ACTIVE Smartwatch aktif.
SUSPENDED Smartwatch ditangguhkan karena error yang mungkin diatasi. Smartwatch akan tetap ada hingga habis masa berlakunya. Untuk mencoba mengaktifkan kembali smartwatch, panggilan dapat dilakukan ke watches.renew

Metode

create

 Buat smartwatch baru.

delete

 Menghapus smartwatch.

list

 Menampilkan daftar smartwatch yang dimiliki oleh project yang memanggil.

renew

 Perpanjang smartwatch yang ada selama tujuh hari.