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 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होगा और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

expireTime

string (Timestamp format)

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

आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़्ड होगा और इसमें 0, 3, 6 या 9 दशमलव अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".

errorType

enum (ErrorType)

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

state

enum (State)

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

WatchTarget

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

JSON के काेड में दिखाना
{

  // Union field target can be only one of the following:
  "topic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field target.
}
फ़ील्ड
यूनियन फ़ील्ड target. ज़रूरी है. सूचना डिलीवरी का टारगेट. target इनमें से कोई एक हो सकता है:
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 Cloud प्रोजेक्ट के पास, देखे जा रहे फ़ॉर्म का ऐक्सेस नहीं है. ऐसा तब होता है, जब उपयोगकर्ता ने आपके प्रोजेक्ट को अपने फ़ॉर्म ऐक्सेस करने की अनुमति रद्द कर दी हो. इस गड़बड़ी वाली स्मार्टवॉच को फिर से इंपोर्ट करने की कोशिश नहीं की जाएगी. फ़ॉर्म को फिर से देखने के लिए, watches.renew को कॉल किया जा सकता है
NO_USER_ACCESS जिस उपयोगकर्ता ने ऐक्सेस दिया था उसके पास अब उस फ़ॉर्म का ऐक्सेस नहीं है जिसे देखा जा रहा है. इस गड़बड़ी वाली स्मार्टवॉच को फिर से इंपोर्ट करने की कोशिश नहीं की जाएगी. फ़ॉर्म को फिर से देखने के लिए, watches.renew को कॉल किया जा सकता है
OTHER_ERRORS कोई दूसरी तरह की गड़बड़ी हुई है. सूचनाएं मिलती रहेंगी या नहीं, यह स्मार्टवॉच state पर निर्भर करता है.

स्थिति

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

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

तरीके

create

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

delete

किसी स्मार्टवॉच को मिटाना.

list

उन स्मार्टवॉच की सूची दिखाता है जिनका मालिकाना हक, कॉल करने वाले प्रोजेक्ट के पास है.

renew

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