REST Resource: sessions

संसाधन: PickingSession

यह उपयोगकर्ता के उस सेशन को दिखाता है जिसमें वह Google Photos का इस्तेमाल करके फ़ोटो और वीडियो चुन सकता है.

JSON के काेड में दिखाना
{
  "id": string,
  "pickerUri": string,
  "pollingConfig": {
    object (PollingConfig)
  },
  "expireTime": string,
  "pickingConfig": {
    object (PickingConfig)
  },
  "mediaItemsSet": boolean
}
फ़ील्ड
id

string

सिर्फ़ आउटपुट के लिए. इस सेशन के लिए, Google का जनरेट किया गया आइडेंटिफ़ायर.

pickerUri

string

सिर्फ़ आउटपुट के लिए. इस यूआरआई का इस्तेमाल, उपयोगकर्ता को Google Photos (वेब पर) पर रीडायरेक्ट करने के लिए किया जाता है, ताकि वह मौजूदा सेशन के लिए फ़ोटो और वीडियो चुन सके.

इस पेज को देखने के लिए, उपयोगकर्ता को उस Google खाते में लॉग इन करना होगा जो वेब ब्राउज़र में इस सेशन का मालिक है.

सुरक्षा से जुड़ी वजहों से, pickerUri को iframe में नहीं खोला जा सकता.

वेब पर काम करने वाले ऐप्लिकेशन के लिए, इस यूआरआई में /autoclose जोड़ा जा सकता है. इसके बाद, Google Photos की विंडो या टैब अपने-आप बंद हो जाएगा. हालांकि, ऐसा तब होगा, जब उपयोगकर्ता फ़ोटो चुन लेगा. इसके बाद, "हो गया" स्क्रीन नहीं दिखेगी.

pollingConfig

object (PollingConfig)

सिर्फ़ आउटपुट के लिए. यह सुझाया गया कॉन्फ़िगरेशन है. ऐप्लिकेशन को sessions.get की पोलिंग करते समय इसका इस्तेमाल करना चाहिए.

इस फ़ील्ड में सिर्फ़ तब डेटा भरा जाता है, जब इस सेशन के लिए मीडिया आइटम नहीं चुने गए हों. mediaItemsSet false है).

expireTime

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".

pickingConfig

object (PickingConfig)

ज़रूरी नहीं. इस सेशन के दौरान, उपयोगकर्ता को फ़ोटो चुनने का अनुभव देने के लिए, फ़ोटो चुनने का कॉन्फ़िगरेशन.

इसे क्लाइंट ऐप्लिकेशन, sessions.create को कॉल करते समय तय करता है. इसे बाद में बदला नहीं जा सकता. हालांकि, नया सेशन बनाकर इसे बदला जा सकता है.

mediaItemsSet

boolean

सिर्फ़ आउटपुट के लिए. अगर इसे true पर सेट किया गया है, तो इस सेशन के लिए मीडिया आइटम चुने गए हैं. साथ ही, आपका ऐप्लिकेशन mediaItems.list के ज़रिए, चुने गए मीडिया आइटम की सूची का अनुरोध कर सकता है.

PollingConfig

एपीआई को पोल करने के लिए कॉन्फ़िगरेशन.

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

string (Duration format)

सिर्फ़ आउटपुट के लिए. पोल के अनुरोधों के बीच सुझाया गया समय.

यह अवधि सेकंड में होती है. इसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".

timeoutIn

string (Duration format)

सिर्फ़ आउटपुट के लिए. वह समय जिसके बाद क्लाइंट को पोलिंग बंद कर देनी चाहिए.

वैल्यू 0 होने का मतलब है कि क्लाइंट को पोलिंग बंद कर देनी चाहिए.

यह अवधि सेकंड में होती है. इसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".

PickingConfig

इस सेशन के दौरान, उपयोगकर्ता के चुनने के अनुभव के लिए क्लाइंट की ओर से तय किया गया कॉन्फ़िगरेशन.

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

string (int64 format)

ज़रूरी नहीं. इस सेशन के दौरान, उपयोगकर्ता ज़्यादा से ज़्यादा कितने आइटम चुन सकता है. अगर यह तय नहीं किया गया है, तो डिफ़ॉल्ट रूप से इसकी वैल्यू 2000 होती है.

अगर इस एट्रिब्यूट की वैल्यू नहीं दी जाती है या इसे 0 पर सेट किया जाता है, तो ज़्यादा से ज़्यादा 2,000 आइटम चुने जा सकते हैं. अगर वैल्यू 2,000 से ज़्यादा है, तो उसे 2,000 माना जाएगा. नेगेटिव वैल्यू डालने पर, INVALID_ARGUMENT गड़बड़ी दिखेगी.

तरीके

create

यह कुकी एक नया सेशन जनरेट करती है. इस सेशन के दौरान, उपयोगकर्ता तीसरे पक्ष को ऐक्सेस देने के लिए फ़ोटो और वीडियो चुन सकता है.

delete

यह कुकी, तय किए गए सेशन को मिटाती है.

get

यह कुकी, चुने गए सेशन के बारे में जानकारी इकट्ठा करती है.