मेनिफ़ेस्ट रेफ़रंस

मेनिफ़ेस्ट (appsscript.json) आपके Apps Script कनेक्टर प्रोजेक्ट में मौजूद एक JSON फ़ाइल होती है. इसमें आपके कम्यूनिटी कनेक्टर के बारे में कुछ ऐसी जानकारी होती है जो Looker Studio में कनेक्टर को डिप्लॉय करने और उसका इस्तेमाल करने के लिए ज़रूरी होती है. Apps Script में मेनिफ़ेस्ट के बारे में ज़्यादा जानें.

आपके मेनिफ़ेस्ट में यह जानकारी होनी चाहिए:

प्रॉपर्टी का नाम टाइप ब्यौरा
ज़रूरी है (dataStudio प्रॉपर्टी के तहत)
name string आपके कनेक्टर का नाम.
इसमें 28 से ज़्यादा वर्ण इस्तेमाल नहीं किए जा सकते
company string संगठन या डेवलपर का नाम.
companyUrl string (link) संगठन या डेवलपर की वेबसाइट का लिंक.
logoUrl string (image link) आपके कनेक्टर के आइकॉन का यूआरएल.
इमेज के डाइमेंशन 40 पिक्सल x 40 पिक्सल होने चाहिए.
addOnUrl string (link) 'ज़्यादा जानें' पेज का लिंक. इस पेज पर यह जानकारी होनी चाहिए कि आपका कनेक्टर क्या काम करता है और यह किस डेटा को ऐक्सेस करता है. आपको इस पेज को होस्ट और मैनेज करना होगा.
इस पेज पर, सेवा की शर्तों और निजता नीति की जानकारी होनी चाहिए या इनका लिंक दिया जाना चाहिए.
supportUrl string (link) इस कनेक्टर के लिए सहायता पेज का लिंक. उपयोगकर्ताओं को इस लिंक पर, आपके कनेक्टर से जुड़ी समस्याओं की शिकायत करने की सुविधा मिलनी चाहिए. आपको इस पेज को होस्ट और मैनेज करना चाहिए.
description string आपके कनेक्टर का ब्यौरा.
उपयोगकर्ताओं को कनेक्टर के कॉन्फ़िगरेशन पेज पर पूरी जानकारी दिखेगी. लिंक पर क्लिक किया जा सकेगा.
ज़रूरी नहीं है (dataStudio प्रॉपर्टी के तहत)
shortDescription string सीमा: 114 वर्ण. अगर आपका कनेक्टर पब्लिश किया गया है, तो यह छोटा ब्यौरा आपके कनेक्टर के गैलरी कार्ड में दिखेगा. इसका इस्तेमाल करके, कम शब्दों में बताएं कि आपका कनेक्टर क्या करता है. उपयोगकर्ता, गैलरी में कनेक्टर ब्राउज़ करते समय इसे देख पाएंगे.
privacyPolicyUrl string (link) कनेक्टर / डेवलपर संगठन की निजता नीति का लिंक.
termsOfServiceUrl string (link) कनेक्टर / डेवलपर संगठन के लिए सेवा की शर्तों का लिंक.
authType list(AuthType) आपके कनेक्टर के लिए पुष्टि करने के तरीके का टाइप. नीचे AuthType देखें.
feeType list(FeeType) यह आपके कनेक्टर के लिए फ़ीस का टाइप दिखाता है. नीचे FeeType देखें.
sources list(Sources) उन डेटा सोर्स की सूची जिनसे यह कनेक्टर कनेक्ट हो सकता है. नीचे सोर्स देखें.
templates Object इस कनेक्टर के साथ इस्तेमाल किए जा सकने वाले टेंप्लेट की सूची. सिर्फ़ एक डिफ़ॉल्ट टेंप्लेट का इस्तेमाल किया जा सकता है. इसे default कुंजी सेट करके पहचाना जाता है. वैल्यू, Looker Studio रिपोर्ट का आईडी होना चाहिए. इस रिपोर्ट को टेंप्लेट के तौर पर इस्तेमाल किया जाएगा. रिपोर्ट टेंप्लेट उपलब्ध कराने के बारे में जानकारी देने वाली गाइड देखें.
forceViewersCredentials boolean इस कनेक्टर से बनाए गए डेटा सोर्स के लिए, दर्शक के क्रेडेंशियल ज़रूरी होने चाहिए या नहीं. यह प्रॉपर्टी वैकल्पिक है और डिफ़ॉल्ट रूप से false पर सेट होती है. व्यूअर के क्रेडेंशियल के बारे में ज़्यादा जानने के लिए, डेटा सोर्स के क्रेडेंशियल देखें.
useQueryConfig boolean DEPRECATED: इस कनेक्टर से `getData()` के लिए क्वेरी कॉन्फ़िगरेशन मिलेगा या नहीं. इसके बजाय, `advancedServices` का इस्तेमाल करें.
advancedServices.data boolean यह कनेक्टर, `getData()` के लिए क्वेरी कॉन्फ़िगरेशन दिखाएगा या नहीं. ऐडवांस सेवाएं देखें.
advancedServices.schema boolean यह कनेक्टर, `getSchema()` के लिए क्वेरी कॉन्फ़िगरेशन दिखाएगा या नहीं. ऐडवांस सेवाएं देखें.
ज़रूरी नहीं है (रूट लेवल की प्रॉपर्टी)
urlFetchWhitelist list(string) एचटीटीपीएस यूआरएल प्रीफ़िक्स की सूची, जिसका इस्तेमाल आपका कनेक्टर करता है. फ़ेच किया गया कोई भी यूआरएल एंडपॉइंट, इस सूची में मौजूद किसी एक प्रीफ़िक्स से मेल खाना चाहिए. इससे उपयोगकर्ता के डेटा को सुरक्षित रखने में मदद मिल सकती है. ज़्यादा जानकारी के लिए, यूआरएल को सुरक्षित सूची में शामिल करना लेख पढ़ें.

AuthType

पुष्टि करने के तरीके के टाइप की वैल्यू इनमें से कोई एक हो सकती है:

Enum वैल्यू ब्यौरा
NONE इससे पता चलता है कि कनेक्टर के लिए पुष्टि करने की ज़रूरत नहीं है.
OAUTH2 इससे पता चलता है कि कनेक्टर, OAuth 2.0 का इस्तेमाल करता है.
KEY इससे पता चलता है कि कनेक्टर, एपीआई पासकोड का इस्तेमाल करता है.
USER_PASS इससे पता चलता है कि कनेक्टर, उपयोगकर्ता नाम/पासवर्ड का इस्तेमाल करता है.
USER_TOKEN इससे पता चलता है कि कनेक्टर, उपयोगकर्ता नाम/टोकन का इस्तेमाल करता है.
PATH_USER_PASS इससे पता चलता है कि कनेक्टर, पाथ/उपयोगकर्ता नाम/पासवर्ड का इस्तेमाल करता है.
PATH_KEY इससे पता चलता है कि कनेक्टर, पाथ/कुंजी का इस्तेमाल करता है.

FeeType

किराये के टाइप की वैल्यू इनमें से कोई भी हो सकती है:

Enum वैल्यू ब्यौरा
FREE इससे पता चलता है कि कनेक्टर का इस्तेमाल बिलकुल मुफ़्त है.
FREE_TRIAL इससे पता चलता है कि कनेक्टर को बिना किसी शुल्क के आज़माया जा सकता है.
PAID इससे पता चलता है कि कनेक्टर का इस्तेमाल करने के लिए, उपयोगकर्ता को शुल्क चुकाना होगा.

स्रोत

सोर्स, सोर्स के लिए एनम की सूची है. डेटा रजिस्ट्री रिपॉज़िटरी में जाकर, सोर्स की मौजूदा सूची देखी जा सकती है. अगर कनेक्ट किया जा रहा सोर्स, डेटा रजिस्ट्री रिपॉज़िटरी में मौजूद नहीं है, तो सोर्स को जोड़ने के लिए डेटा रजिस्ट्री रिपॉज़िटरी को पुल अनुरोध भेजें. सोर्स के नाम में सिर्फ़ कैपिटल लेटर और अंडरस्कोर हो सकते हैं. उदाहरण के लिए, Google Analytics GOOGLE_ANALYTICS होगा. अपने कम्यूनिटी कनेक्टर के मेनिफ़ेस्ट में, डेटा सोर्स आईडी प्रॉपर्टी की value का इस्तेमाल करें. उदाहरण के लिए, GOOGLE_ANALYTICS.

कम्यूनिटी कनेक्टर के लिए मेनिफ़ेस्ट का उदाहरण

यहां पूरे मेनिफ़ेस्ट का एक उदाहरण दिया गया है:

data-studio/appsscript.json
{
  "dataStudio": {
    "name": "Nucleus by Hooli",
    "company": "Hooli Inc.",
    "companyUrl": "https://hooli.xyz",
    "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
    "addonUrl": "https://hooli.xyz/data-studio-connector",
    "supportUrl": "https://hooli.xyz/data-studio-connector/support",
    "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
    "shortDescription": "Connect to your data using Nucleus middle out optimization",
    "privacyPolicyUrl": "https://hooli.xyz/privacy",
    "termsOfServiceUrl": "https://hooli.xyz/tos",
    "authType": ["NONE"],
    "feeType": ["PAID"],
    "sources": ["HOOLI_CHAT_LOG", "ENDFRAME_SERVER_STREAM", "RETINABYTE_USER_ANALYTICS"],
    "templates": {
      "default": "872223s89f5fdkjnd983kjf"
    }
  },
  "urlFetchWhitelist": [
    "https://api.hooli.xyz/",
    "https://hooli.xyz/"
  ]
}