REST Resource: forms.watches

Referensi: Tonton

Jam tangan untuk 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.

Pesan dikirim dengan pengiriman minimal satu kali, dan hanya dihapus dalam keadaan yang luar biasa. Biasanya semua notifikasi harus terkirim dengan lancar dalam beberapa detik; namun, 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 tentang CreateWatchRequest.watch_id.

target

object (WatchTarget)

Wajib. Tujuan pengiriman notifikasi.

eventType

enum (EventType)

Wajib. Jenis acara apa yang harus diperhatikan.

createTime

string (Timestamp format)

Hanya output. Stempel waktu saat jenis ini dibuat.

Stempel waktu dalam format 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 untuk tanggal habis masa berlaku. Setiap panggilan watches.renew akan meresetnya ke tujuh hari mendatang.

Stempel waktu dalam format 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 upaya pengiriman. Untuk mulai menonton 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 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 pengiriman notifikasi. target hanya ada berupa salah satu diantara 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 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 konten formulir dan setelan.
RESPONSES Jenis peristiwa respons. Smartwatch dengan jenis peristiwa ini akan diberi tahu saat respons formulir dikirimkan.

ErrorType

Jenis error yang mungkin terjadi.

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

Negara Bagian

Kemungkinan status Smartwatch.

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

Metode

create

Buat smartwatch baru.

delete

Menghapus smartwatch.

list

Tampilkan daftar smartwatch yang dimiliki oleh project pemanggil.

renew

Perpanjang smartwatch yang ada selama tujuh hari.