REST Resource: forms.watches

संसाधन: देखें

किसी फ़ॉर्म के इवेंट की जानकारी. तय किया गया इवेंट होने पर, चुने गए टारगेट के लिए एक सूचना पब्लिश की जाएगी. सूचना के एट्रिब्यूट में एक formId कुंजी शामिल होगी, जिसमें देखे गए फ़ॉर्म का आईडी होगा. साथ ही, एक eventType कुंजी होगी जिसमें एक तरह की स्ट्रिंग होगी.

मैसेज को कम से कम एक बार डिलीवरी के साथ भेजा जाता है. उन्हें खास परिस्थितियों में ही अपलोड किया जाता है. आम तौर पर, सभी सूचनाएं कुछ सेकंड में सही तरीके से डिलीवर हो जानी चाहिए; हालांकि, कुछ परिस्थितियों में नोटिफ़िकेशन में देरी हो सकती है.

किसी स्मार्टवॉच को बनाने के सात दिन बाद, उसकी समयसीमा खत्म हो जाती है. हालांकि, अगर watches.renew को रिन्यू नहीं किया जाता है, तो उसे इस्तेमाल नहीं किया जा सकेगा

JSON के काेड में दिखाना
{
  "id": string,
  "target": {
    object (WatchTarget)
  },
  "eventType": enum (EventType),
  "createTime": string,
  "expireTime": string,
  "errorType": enum (ErrorType),
  "state": enum (State)
}
फ़ील्ड
id

string

सिर्फ़ आउटपुट के लिए. इस स्मार्टवॉच का आईडी. CreateWatchRequest.watch_id पर नोट देखें.

target

object (WatchTarget)

ज़रूरी है. सूचना कहां भेजें.

eventType

enum (EventType)

ज़रूरी है. आपको किस तरह का इवेंट देखना है.

createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. उस समय का टाइमस्टैंप जब इसे बनाया गया था.

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

expireTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. इस सुविधा की समयसीमा खत्म होने का टाइमस्टैंप. हर watches.renew कॉल, अगले सात दिनों के लिए रीसेट हो जाता है.

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

errorType

enum (ErrorType)

सिर्फ़ आउटपुट के लिए. डिलीवरी की कोशिश की गई किसी गड़बड़ी के लिए सबसे हाल की गड़बड़ी. फ़ॉर्म को फिर से देखने के लिए, watches.renew पर कॉल किया जा सकता है. कॉल करने पर, गड़बड़ी की यह जानकारी भी हट जाएगी.

state

enum (State)

सिर्फ़ आउटपुट के लिए. स्मार्टवॉच की मौजूदा स्थिति. निलंबित की गई स्मार्टवॉच के बारे में ज़्यादा जानकारी पाने के लिए, errorType पर जाएं.

WatchTarget

सूचना डिलीवरी का टारगेट.

JSON के काेड में दिखाना
{
  "topic": {
    object (CloudPubsubTopic)
  }
}
फ़ील्ड
topic

object (CloudPubsubTopic)

Pub/Sub का एक विषय. सूचनाएं पाने के लिए, विषय से जुड़ी जानकारी को Forms सेवा खाते serviceAccount:forms-notifications@system.gserviceaccount.com में, पब्लिश करने के खास अधिकार देने होंगे. सिर्फ़ उस प्रोजेक्ट का इस्तेमाल करके स्मार्टवॉच बनाई जा सकती है जिसके पास किसी विषय का मालिकाना हक है.

Pub/Sub डिलीवरी गारंटी पर ध्यान देना चाहिए.

CloudPubsubTopic

Pub/Sub का एक विषय.

JSON के काेड में दिखाना
{
  "topicName": string
}
फ़ील्ड
topicName

string

ज़रूरी है. इवेंट पब्लिश करने के लिए, पूरी तरह क्वालिफ़ाइड Pub/Sub विषय का नाम. इस विषय का मालिकाना हक, कॉल करने के प्रोजेक्ट के पास होना चाहिए. साथ ही, यह Pub/Sub में पहले से मौजूद होना चाहिए.

EventType

देखे जा सकने वाले इवेंट के टाइप.

Enums
EVENT_TYPE_UNSPECIFIED इवेंट टाइप की जानकारी नहीं है. इस वैल्यू का इस्तेमाल नहीं किया जाना चाहिए.
SCHEMA स्कीमा इवेंट टाइप. इस तरह के इवेंट वाली स्मार्टवॉच को, फ़ॉर्म के कॉन्टेंट और सेटिंग में हुए बदलावों के बारे में सूचना दी जाएगी.
RESPONSES जवाब वाले इवेंट का टाइप. फ़ॉर्म के जवाब सबमिट होने पर, इस तरह की स्मार्टवॉच को सूचना दी जाएगी.

ErrorType

संभावित गड़बड़ी प्रकार.

Enums
ERROR_TYPE_UNSPECIFIED गड़बड़ी किस तरह की है, इसकी जानकारी नहीं है.
PROJECT_NOT_AUTHORIZED क्लाउड प्रोजेक्ट के पास, देखे जा रहे फ़ॉर्म का ऐक्सेस नहीं है. ऐसा तब होता है, जब उपयोगकर्ता ने आपके प्रोजेक्ट के लिए, अपने फ़ॉर्म को ऐक्सेस करने की अनुमति रद्द कर दी हो. इस गड़बड़ी वाली स्मार्टवॉच को फिर से इस्तेमाल नहीं किया जाएगा. फ़ॉर्म को फिर से देखने के लिए, watches.renew पर कॉल किया जा सकता है
NO_USER_ACCESS जिस उपयोगकर्ता ने ऐक्सेस दिया है उसके पास अब देखे जा रहे फ़ॉर्म का ऐक्सेस नहीं है. इस गड़बड़ी वाली स्मार्टवॉच को फिर से इस्तेमाल नहीं किया जाएगा. फ़ॉर्म को फिर से देखने के लिए, watches.renew पर कॉल किया जा सकता है
OTHER_ERRORS किसी अन्य तरह की गड़बड़ी हुई है. सूचनाएं मिलने की सुविधा जारी रहेगी या नहीं, यह state स्मार्टवॉच पर निर्भर करता है.

स्थिति

स्मार्टवॉच पर प्रॉडक्ट की संभावित स्थितियां.

Enums
STATE_UNSPECIFIED स्थिति सेट नहीं की गई है.
ACTIVE स्मार्टवॉच चालू है.
SUSPENDED स्मार्टवॉच को किसी गड़बड़ी की वजह से निलंबित कर दिया गया है, जिसे ठीक किया जा सकता है. समयसीमा खत्म होने तक, स्मार्टवॉच मौजूद रहेगी. स्मार्टवॉच को फिर से चालू करने के लिए, watches.renew पर कॉल किया जा सकता है

तरीके

create

नई स्मार्टवॉच बनाएं.

delete

स्मार्टवॉच को मिटाएं.

list

उन घड़ियों की सूची दिखाएं जिनका मालिकाना हक, शुरू करने वाले प्रोजेक्ट के पास है.

renew

मौजूदा स्मार्टवॉच को सात दिनों के लिए रिन्यू करें.