REST Resource: forms.watches

Resource: Menonton

Mengamati 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 ditonton dan kunci eventType yang memiliki string jenis.

Pesan dikirim dengan pengiriman minimal satu kali dan hanya dihapus dalam keadaan luar biasa. Biasanya semua notifikasi akan dikirim dengan andal dalam beberapa detik; namun, dalam beberapa situasi, notifikasi mungkin tertunda.

Masa berlaku smartwatch 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 akan dipantau.
createTime

string (Timestamp format)

Hanya output. Stempel waktu saat ini dibuat.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
expireTime

string (Timestamp format)

Hanya output. Stempel waktu untuk masa berlakunya. Setiap panggilan watches.renew akan meresetnya menjadi tujuh hari pada masa mendatang.

Menggunakan RFC 3339, dengan output yang dihasilkan akan selalu dinormalisasi Z dan menggunakan digit pecahan 0, 3, 6, atau 9. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
errorType

enum (ErrorType)

Hanya output. Jenis error terbaru untuk pengiriman yang dicoba. Untuk mulai mengamati formulir lagi, panggilan dapat dilakukan ke watches.renew yang juga 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 pengiriman 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 panggilan dan sudah ada di Pub/Sub.

EventType

Kemungkinan jenis peristiwa yang dapat ditonton.

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

ErrorType

Kemungkinan jenis error.

Enum
ERROR_TYPE_UNSPECIFIED Jenis error yang belum ditetapkan.
PROJECT_NOT_AUTHORIZED Project cloud tidak memiliki akses ke formulir yang sedang ditonton. Hal ini terjadi jika pengguna telah mencabut otorisasi agar project Anda dapat mengakses formulir mereka. Smartwatch dengan error ini tidak akan dicoba lagi. Untuk mencoba mulai menonton 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 dengan error ini tidak akan dicoba lagi. Untuk mencoba mulai menonton formulir lagi, panggilan dapat dilakukan ke watches.renew
OTHER_ERRORS Terjadi jenis error lain. Apakah notifikasi akan dilanjutkan bergantung pada state smartwatch.

Negara Bagian

Kemungkinan status Tonton.

Enum
STATE_UNSPECIFIED Status tidak ditentukan.
ACTIVE Smartwatch aktif.
SUSPENDED Smartwatch ditangguhkan karena terjadi error yang dapat diatasi. Smartwatch akan terus ada hingga masa berlakunya berakhir. 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

 Memperpanjang tontonan yang ada selama tujuh hari.