Google पिकर एपीआई का रेफ़रंस

इस पेज पर क्लास, तरीकों, और Google पिकर एपीआई में मौजूद गिनती के टाइप की सूची मौजूद है. ये सभी एलिमेंट नेमस्पेस से जुड़े हैं google.picker.* दो तरह की क्लास और गिनती के टाइप होते हैं: एक का इस्तेमाल Google पिकर को बनाने और कॉन्फ़िगर करने के लिए किया जाता है. दूसरे एलिमेंट को Google पिकर के ज़रिए तब दिखाया जाता है, जब उपयोगकर्ता कोई आइटम चुन लेता है.

कॉन्फ़िगरेशन की क्लास और टाइप

नीचे दी गई क्लास और गिने गए टाइप का इस्तेमाल, Google पिकर को बनाने और कॉन्फ़िगर करने के लिए किया जाता है.

DocsUploadView

Google Drive पर दस्तावेज़ अपलोड करने के लिए, DocsUploadView का इस्तेमाल करें.

DocsUploadView()कंस्ट्रक्टर.
DocsUploadView.setIncludeFolders(boolean)इससे उपयोगकर्ता, Google Drive में मौजूद कोई फ़ोल्डर चुन सकता है और उसे अपलोड कर सकता है.
DocsUploadView.setParent(string)अपलोड किए जाने वाले डेस्टिनेशन को बताए गए फ़ोल्डर पर सेट करता है. यह setIncludeFolders को 'गलत' पर बदल देता है.

DocsView

DocsView, View की सब-क्लास है. इसका इस्तेमाल, Google Drive के व्यू के लिए किया जा सकता है.

DocsView(ViewId | undefined)कंस्ट्रक्टर. ViewId, Google Drive के व्यू में से एक होना चाहिए. डिफ़ॉल्ट वैल्यू ViewId.DOCS है.
DocsView.setEnableDrives(boolean)शेयर की गई ड्राइव और उनमें मौजूद फ़ाइलें दिखाता है. इसे चालू करने से पहले, शेयर की गई ड्राइव को चालू करने के लिए, Google Drive API से जुड़े दस्तावेज़ देखें.
DocsView.setIncludeFolders(boolean)व्यू आइटम में फ़ोल्डर दिखाएं. इसे setOwnedByMe के साथ न जोड़ें. setIncludeFolders(true) को सेट करने पर, setOwnedByMe को अनदेखा कर दिया जाता है.
DocsView.setSelectFolderEnabled(boolean)उपयोगकर्ता को Google Drive में फ़ोल्डर चुनने की अनुमति देता है.
DocsView.setMode(DocsViewMode)चुनें कि दस्तावेज़ दिखाने के लिए, व्यू किस मोड का इस्तेमाल करता है.
DocsView.setOwnedByMe(boolean | undefined)दस्तावेज़ों को इस आधार पर फ़िल्टर करता है कि वे उपयोगकर्ता के मालिकाना हक वाले हैं या उपयोगकर्ता के साथ शेयर किए गए हैं. इस सेटिंग को setIncludeFolders के साथ न जोड़ें. setIncludeFolders(true) को सेट करने पर, setOwnedByMe को अनदेखा कर दिया जाता है.
DocsView.setParent(string)यह शुरुआती पैरंट फ़ोल्डर को दिखाने के लिए सेट करता है.
DocsView.setStarred(boolean)दस्तावेज़ों को इस आधार पर फ़िल्टर करता है कि क्या उन्हें उपयोगकर्ता ने स्टार का निशान लगाया है.

DocsViewMode

DocsViewMode, DocsView में डेटा दिखाने के लिए गिनती किया गया एक टाइप है. DocsView.setMode को किए जाने वाले कॉल में इन वैल्यू का इस्तेमाल करें.

DocsViewMode.GRIDथंबनेल ग्रिड में दस्तावेज़ दिखाए जाते हैं.
DocsViewMode.LISTदस्तावेज़ों को पूरी जानकारी वाली सूची में दिखाएं.

सुविधा

अलग-अलग व्यू के लिए सुविधाओं को चालू/बंद करने के लिए, Feature गिनती की गई है. PickerBuilder.enableFeature और PickerBuilder.disableFeature के कॉल में इन वैल्यू का इस्तेमाल करें.

Feature.MINE_ONLYGoogle Drive से आइटम दिखाते समय, सिर्फ़ उपयोगकर्ता के मालिकाना हक वाले दस्तावेज़ दिखाएं.
Feature.MULTISELECT_ENABLEDउपयोगकर्ता को एक से ज़्यादा आइटम चुनने की अनुमति दें.
Feature.NAV_HIDDENनेविगेशन पैनल छिपाएं. अगर नेविगेशन पैनल छिपा हुआ है, तो उपयोगकर्ता चुने गए पहले व्यू में से ही किसी विकल्प को चुन सकते हैं.
Feature.SIMPLE_UPLOAD_ENABLEDफ़ोटो अपलोड के लिए, यह कंट्रोल करता है कि हर फ़ोटो के लिए चुना गया विकल्प (हर एल्बम के बजाय) चुनने की सुविधा चालू है या नहीं.
Feature.SUPPORT_DRIVES

अब काम नहीं करता: शेयर की गई ड्राइव के आइटम अब डिफ़ॉल्ट रूप से शामिल हैं.

नतीजों में, शेयर की गई ड्राइव के आइटम शामिल हैं या नहीं.

पिकर

Picker टॉप लेवल ऑब्जेक्ट है, जो उपयोगकर्ता के साथ यूज़र इंटरफ़ेस (यूआई) कार्रवाई को दिखाता है. ये ऑब्जेक्ट सीधे तौर पर नहीं बनाए जाते हैं, बल्कि इसके बजाय PickerBuilder ऑब्जेक्ट का इस्तेमाल करते हैं.

Picker.isVisible()मौजूदा पिकर दिखने की जानकारी देने वाला बूलियन पाएं.
Picker.setCallback(function(object))जब भी उपयोगकर्ता कोई आइटम चुनता है या रद्द करता है, तब उस कॉलबैक का तरीका तय करें जिसे कॉल किया गया है.
Picker.setRelayUrl(string)क्रॉस-डोमेन समस्याओं से बचने के लिए कोई रिले यूआरएल तय करें.
Picker.setVisible(boolean)यह तय करें कि पिकर ऑब्जेक्ट किसको दिखे.
Picker.dispose()यह पिकर ऑब्जेक्ट को नष्ट कर देता है.

PickerBuilder

PickerBuilder का इस्तेमाल, Picker ऑब्जेक्ट बनाने के लिए किया जाता है. अगर अलग से कुछ और न बताया गया हो, तो नीचे दिए गए रिटर्न टाइप PickerBuilder के हैं. इनकी मदद से, एक के बाद एक कॉल को चेन किया जा सकता है. सामान्य इस्तेमाल के लिए Google पिकर कोड सैंपल देखें.

PickerBuilder()कंस्ट्रक्टर.
PickerBuilder.addView(View | ViewId)नेविगेशन पैनल में View जोड़ें.
PickerBuilder.addViewGroup(ViewGroup)टॉप-लेवल नेविगेशन पैनल में ViewGroup जोड़ें.
PickerBuilder.build()पिकर ऑब्जेक्ट बनाएं. पिकर ऑब्जेक्ट दिखाया जाता है.
PickerBuilder.disableFeature(Feature)पिकर की सुविधा बंद करें.
PickerBuilder.enableFeature(Feature)पिकर सुविधा चालू करें.
PickerBuilder.getRelayUrl()sellers.rpc के लिए इस्तेमाल किया जाने वाला रिले यूआरएल पाएं.
PickerBuilder.getTitle()डायलॉग का टाइटल पाएं.
PickerBuilder.hideTitleBar()टाइटल बार को दिखने से रोकें. फिर से चालू करने के लिए, setTitle पर कॉल करें. शीर्षक में कोई वैल्यू नहीं होनी चाहिए या कोई वैल्यू नहीं बताई गई है.
PickerBuilder.isFeatureEnabled(Feature)देखें कि पिकर Feature चालू है या नहीं.
PickerBuilder.setAppId(string)ऐप्लिकेशन को Google Drive API के ज़रिए उपयोगकर्ता की फ़ाइलें ऐक्सेस करने की अनुमति देने के लिए, ज़रूरी Google Drive ऐप्लिकेशन आईडी सेट करता है.
PickerBuilder.setCallback(method)कॉलबैक का तरीका सेट करें. इस तरीके को तब कॉल किया जाता है, जब उपयोगकर्ता आइटम चुनता है या रद्द करता है. कॉलबैक तरीके को एक ही कॉलबैक ऑब्जेक्ट मिलता है. कॉलबैक ऑब्जेक्ट के स्ट्रक्चर के बारे में JSON गाइड में बताया गया है.
PickerBuilder.setDeveloperKey(string)यह Google API कंसोल से मिली ब्राउज़र API कुंजी को सेट करता है. ब्राउज़र एपीआई कुंजी पाने का तरीका जानने के लिए, डेवलपर की गाइड देखें.
PickerBuilder.setDocument(document)दस्तावेज़ सेट करें.
PickerBuilder.setLocale(string)ISO 639 भाषा कोड. अगर इस भाषा का इस्तेमाल नहीं किया जा सकता, तो en-US का इस्तेमाल किया जाता है. यह तरीका, google.load() समय पर स्थान-भाषा को सेट करने का विकल्प देता है. इस्तेमाल की जा सकने वाली स्थान-भाषाओं की सूची देखने के लिए, डेवलपर की गाइड देखें.
PickerBuilder.setMaxItems(number)इससे ज़्यादा से ज़्यादा ऐसे आइटम सेट किए जा सकते हैं जिन्हें उपयोगकर्ता चुन सकता है.
PickerBuilder.setOAuthToken(string)मौजूदा उपयोगकर्ता की पुष्टि करने के लिए, OAuth टोकन सेट करता है. टोकन के स्कोप के हिसाब से, सिर्फ़ कुछ व्यू में डेटा दिखता है. Google Docs और Drive, इसके मान्य दायरे हैं.
PickerBuilder.setOrigin(string)Google पिकर डायलॉग का ऑरिजिन सेट करता है. अगर आपका ऐप्लिकेशन किसी iframe में चल रहा है, तो ऑरिजिन को सबसे ऊपर वाले पेज के window.location.protocol + '//' + window.location.host पर सेट किया जाना चाहिए.
PickerBuilder.setRelayUrl(string)sellers.rpc के लिए इस्तेमाल किया जाने वाला रिले यूआरएल सेट करें.
PickerBuilder.setSelectableMimeTypes(string)चुने जा सकने वाले MIME टाइप की सूची सेट करें. अगर एक से ज़्यादा ज़रूरी हों, तो MIME टाइप को अलग करने के लिए कॉमा का इस्तेमाल करें.
PickerBuilder.setSize()डायलॉग बॉक्स का पसंदीदा साइज़ सेट करें. डायलॉग अपने-आप फ़ोकस में है. इसका कम से कम साइज़ (5,66,350) और ज़्यादा से ज़्यादा साइज़ (10,51,650) होता है.
PickerBuilder.setTitle(string)डायलॉग का टाइटल सेट करें.
PickerBuilder.toUri()इस बिल्डर से जनरेट किया गया यूआरआई दिखाता है.

ResourceId

ResourceId एक स्टैटिक क्लास है, जिसका इस्तेमाल ऐसे संसाधन आईडी जनरेट करने के लिए किया जाता है जो Google दस्तावेज़ सूची एपीआई के लिए सही हैं.

ResourceId.generate(Document)दस्तावेज़ ऑब्जेक्ट को रिसॉर्स आईडी पर मैप करें.

देखें

View, अलग-अलग View क्लास के लिए ऐब्सट्रैक्ट बेस क्लास है, जैसे कि DocsView.

View(ViewId)कंस्ट्रक्टर.
View.getId()इस व्यू के लिए ViewId दिखाता है.
View.setMimeTypes(string)व्यू में शामिल MIME टाइप सेट करता है. अगर एक से ज़्यादा ज़रूरी हों, तो MIME टाइप को अलग करने के लिए कॉमा का इस्तेमाल करें. MIME टाइप सेट न करने पर सभी MIME टाइप वाली फ़ाइलें व्यू में दिखेंगी.
View.setQuery(string)खोज को शामिल करने वाले व्यू के लिए, खोज क्वेरी में इन शब्दों को अपने-आप भरें.

ViewGroup

ViewGroup, व्यू का विज़ुअल ग्रुप है. ViewGroup का रूट आइटम ही View होना चाहिए.

ViewGroup(View | ViewId)ViewGroup, नेविगेशन पैनल में व्यू के विज़ुअल ग्रुप होता है. ViewGroup का रूट आइटम View होना चाहिए.
ViewGroup.addLabel(string)इस ViewGroup में कोई लेबल जोड़ें.
ViewGroup.addView(ViewId | View)ViewGroup में कोई व्यू जोड़ें. View को view से बने ऑब्जेक्ट के ज़रिए या सिर्फ़ ViewId से दिखाया जा सकता है.
ViewGroup.addViewGroup(ViewGroup)मौजूदा ViewGroup में ViewGroup को नेस्ट करें.

ViewId

ViewId, गिनती किया गया एक टाइप है. इसका इस्तेमाल, View और ViewGroup ऑब्जेक्ट बनाने के लिए किया जाता है.

ViewId.DOCSGoogle Drive में मौजूद सभी तरह के दस्तावेज़.
ViewId.DOCS_IMAGESGoogle Drive में मौजूद फ़ोटो.
ViewId.DOCS_IMAGES_AND_VIDEOSGoogle Drive में मौजूद फ़ोटो और वीडियो.
ViewId.DOCS_VIDEOSGoogle Drive के वीडियो.
ViewId.DOCUMENTSGoogle Drive के दस्तावेज़.
ViewId.DRAWINGSGoogle Drive ड्रॉइंग.
ViewId.FOLDERSGoogle Drive में मौजूद फ़ोल्डर.
ViewId.FORMSGoogle Drive फ़ॉर्म.
ViewId.PDFSGoogle Drive में सेव की गई PDF फ़ाइलें.
ViewId.PRESENTATIONSGoogle Drive प्रज़ेंटेशन.
ViewId.SPREADSHEETSGoogle Drive स्प्रेडशीट.

कॉलबैक के टाइप

Google पिकर एपीआई से मिले कॉलबैक डेटा में, यहां बताए गए टाइप किए गए हैं.

कार्रवाई

Action, गिनती किया गया एक टाइप है. इससे पता चलता है कि उपयोगकर्ता ने डायलॉग को खारिज करने के लिए क्या कार्रवाई की. यह वैल्यू, कॉलबैक डेटा के Response.ACTION फ़ील्ड में होती है.

Action.CANCELउपयोगकर्ता ने Google पिकर डायलॉग रद्द कर दिया है.
Action.PICKEDउपयोगकर्ता ने कम से कम एक आइटम चुना है.

दस्तावेज़

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

Document.DESCRIPTIONचुने गए आइटम का उपयोगकर्ता का दिया गया ब्यौरा.
Document.DURATIONकिसी चुने गए वीडियो की अवधि.
Document.EMBEDDABLE_URLइस आइटम के लिए ऐसा यूआरएल जो वेब पेज में एम्बेड करने के लिए सही है.
Document.ICON_URLइस आइटम के आइकॉन का यूआरएल.
Document.IDचुने गए आइटम का आईडी.
Document.IS_NEWअगर चुना गया आइटम अभी-अभी अपलोड किया गया है, तो 'सही' दिखाता है.
Document.LAST_EDITED_UTCवह टाइमस्टैंप जिससे यह पता चलता है कि इस आइटम में आखिरी बार कब बदलाव किया गया था.
Document.MIME_TYPEइस आइटम का MIME प्रकार.
Document.NAMEइस आइटम का नाम.
Document.NUM_CHILDRENइस आइटम में शामिल बच्चों की संख्या. उदाहरण के लिए, चुने गए फ़ोल्डर में मौजूद फ़ाइलों की संख्या.
Document.PARENT_IDइस आइटम का पैरंट आईडी. उदाहरण के लिए, वह फ़ोल्डर जिसमें यह फ़ाइल है.
Document.SERVICE_IDउस सेवा की जानकारी देने वाला ServiceId जिससे इस आइटम को चुना गया था.
Document.THUMBNAILSThumbnail का कलेक्शन, जो किसी फ़ोटो या वीडियो की विशेषताओं के बारे में बताता है. अगर चुने गए आइटम Google Drive से जुड़े हैं, तो थंबनेल नहीं लौटाए जाते.
Document.TYPEचुने गए आइटम का Type.
Document.URLइस आइटम का यूआरएल.

जवाब

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

Response.ACTIONAction टाइप, जिसमें डायलॉग को खारिज करने के लिए उपयोगकर्ता की कार्रवाई को दिखाया गया हो.
Response.DOCUMENTSDocument का कलेक्शन, जिसे उपयोगकर्ता ने चुना है.
Response.PARENTSचुने गए आइटम के लिए पैरंट फ़ोल्डर के आईडी. उदाहरण के लिए, उन पैरंट फ़ोल्डर के आईडी जिनकी फ़ाइलें चुनी गई थीं.
Response.VIEWवह View जहां से उपयोगकर्ता ने ये आइटम चुने थे.

सेवा-आईडी

ServiceId, गिनती किया गया एक टाइप है. इसका इस्तेमाल, उस सेवा के बारे में जानकारी देने के लिए किया जाता है जिससे आइटम को चुना गया था. यह वैल्यू, चुने गए Document के Document.SERVICE_ID फ़ील्ड में है.

ServiceId.DOCSGoogle डिस्क में.

थंबनेल

Thumbnail, गिनती किया गया एक टाइप है. इसका इस्तेमाल किसी चुनी गई फ़ोटो या वीडियो के बारे में जानकारी देने के लिए किया जाता है. यह वैल्यू, चुने गए Document के Document.THUMBNAILS फ़ील्ड में देखी जा सकती है.

Thumbnail.HEIGHTपिक्सल में फ़ोटो या वीडियो की ऊंचाई.
Thumbnail.WIDTHपिक्सल में फ़ोटो या वीडियो की चौड़ाई.
Thumbnail.URLचुनी गई फ़ोटो या वीडियो का यूआरएल.

टाइप

Type, गिनती किया गया एक तरह का आइटम है. इसका इस्तेमाल, चुने गए आइटम को कैटगरी में बांटने के लिए किया जाता है. यह वैल्यू, चुने गए Document के Document.TYPE फ़ील्ड में देखी जा सकती है.

Type.DOCUMENTआइटम एक दस्तावेज़ है.
Type.PHOTOआइटम एक फ़ोटो है.
Type.VIDEOआइटम एक वीडियो है.