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

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

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

प्रॉपर्टी का नाम Type ब्यौरा
ज़रूरी है (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 शामिल नहीं किया गया: यह कनेक्टर `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 इससे यह पता चलता है कि कनेक्टर का इस्तेमाल करने के लिए, उपयोगकर्ता को पैसे चुकाने होंगे.

सोर्स

सोर्स, सोर्स के लिए Enum की सूची होती है. सोर्स की मौजूदा सूची देखने के लिए, हमारी डेटा रजिस्ट्री रिपॉज़िटरी पर जाएं. जिस सोर्स से आपको कनेक्ट किया जा रहा है, अगर वह रिपॉज़िटरी में मौजूद नहीं है, तो सोर्स जोड़ने के लिए डेटा रजिस्ट्री को रिपॉज़िटरी को भेजने का अनुरोध भेजें. सोर्स के नाम में सिर्फ़ अपरकेस वर्ण और अंडरस्कोर हो सकते हैं (उदाहरण के लिए, 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/"
  ]
}