कम्यूनिटी कनेक्टर बनाएं

कम्यूनिटी कनेक्टर बनाने का तरीका:

  1. नया Apps Script प्रोजेक्ट बनाएं.
  2. कनेक्टर कोड लिखें.
  3. प्रोजेक्ट मेनिफ़ेस्ट को पूरा करें.

नया Apps Script प्रोजेक्ट बनाना

नया प्रोजेक्ट बनाने के लिए Google Apps Script पर जाएं. Apps Script, नए डिफ़ॉल्ट स्क्रिप्ट बनाएं. myFunction फ़ंक्शन को हटाएं और उसका नाम बदलें को भी शामिल किया है. (Apps Script के बारे में ज़्यादा जानें)

कनेक्टर कोड लिखें

हर कनेक्टर के लिए, फ़ंक्शन का एक खास सेट तय करना ज़रूरी होता है. कॉन्टेंट बनाने होस्टिंग ऐप्लिकेशन (जैसे कि Looker Studio) इन फ़ंक्शन को एक्ज़ीक्यूट करेगा. आपका यह उम्मीद की जाती है कि आने वाले अनुरोधों को स्वीकार किया जाएगा और यह कनेक्टर यहां बताए गए तरीके से जवाब देगा समुदाय कनेक्टर API का संदर्भ. अगर डेवलप करते समय आपको समस्याएं आती हैं, तो मदद पाने के लिए डीबग करने की गाइड पढ़ें.

getAuthType() में प्रमाणीकरण प्रकार परिभाषित करें

इस फ़ंक्शन को तीसरे पक्ष की सेवा. ज़्यादा जानकारी के लिए getAuthType() संदर्भ देखें. इस समय पुष्टि करने के लिए इस्तेमाल होने वाले तरीके AuthType रेफ़रंस में दिए गए हैं.

उदाहरण के लिए, नीचे दिए गए कनेक्टर की पुष्टि करने की ज़रूरत नहीं है:

npm-downloads/src/auth.js
var cc = DataStudioApp.createCommunityConnector();

// https://developers.google.com/datastudio/connector/reference#getauthtype
function getAuthType() {
  var AuthTypes = cc.AuthType;
  return cc
    .newAuthTypeResponse()
    .setAuthType(AuthTypes.NONE)
    .build();
}

अगर आपके डेटा सोर्स को OAuth 2.0 की पुष्टि करने की ज़रूरत है, तो OAuth 2.0 की पुष्टि करने से जुड़ी गाइड और अतिरिक्त ज़रूरी फ़ंक्शन जोड़ें आपका कनेक्टर.

getConfig() की मदद से कॉन्फ़िगरेशन तय करें

getConfig() फ़ंक्शन को कनेक्टर में उपयोगकर्ता से मिली वे वैल्यू भी शामिल होती हैं जिनकी ज़रूरत आपके कनेक्टर को होती है. यहां जाएं: ज़्यादा जानकारी के लिए, getConfig() रेफ़रंस.

getConfig() से मिले जवाब के आधार पर, Looker Studio कनेक्टर कॉन्फ़िगरेशन स्क्रीन. साथ काम करने वाले कॉन्फ़िगरेशन एलिमेंट की सूची दी गई है ConfigType संदर्भ में.

अगर आपके डेटा सोर्स को पैरामीटर के तौर पर तारीख की ज़रूरत है, तो कॉल करें config.setDateRangeRequired(true). अगर आपको कंडिशनल या डाइनैमिक से पूछना है कॉन्फ़िगरेशन से जुड़े सवाल, सिलसिलेवार कॉन्फ़िगरेशन वाला लेख पढ़ें.

नीचे एक ऐसे कनेक्टर का उदाहरण दिया गया है, जिसके लिए उपयोगकर्ता को npm पैकेज नाम कोड. किसी जानकारी और इनपुट फ़ील्ड को getConfig() फ़ंक्शन:

npm-downloads/src/main.js
// https://developers.google.com/datastudio/connector/reference#getconfig
function getConfig() {
  var config = cc.getConfig();

  config
    .newInfo()
    .setId('instructions')
    .setText(
      'Enter npm package names to fetch their download count. An invalid or blank entry will revert to the default value.'
    );

  config
    .newTextInput()
    .setId('package')
    .setName(
      'Enter a single package name or multiple names separated by commas (no spaces!)'
    )
    .setHelpText('e.g. "googleapis" or "package,somepackage,anotherpackage"')
    .setPlaceholder(DEFAULT_PACKAGE)
    .setAllowOverride(true);

  config.setDateRangeRequired(true);

  return config.build();
}
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है

getSchema() वाले फ़ील्ड को तय करें

इस फ़ंक्शन को दिए गए अनुरोध के लिए स्कीमा पाने के लिए कॉल किया जाता है. कोई भी getConfig() फ़ंक्शन से तय किए गए कॉन्फ़िगरेशन पैरामीटर दिए जाएंगे request तर्क में. ज़्यादा जानकारी के लिए, getSchema() रेफ़रंस देखें.

आपके कनेक्टर के डेटा सोर्स और उपयोगकर्ता, स्कीमा को ठीक किया जा सकता है या हो सकता है कि आपको इसे डायनामिक रूप से अनुरोध समय.

उदाहरण के लिए, अगर कोई कनेक्टर किसी रिपोर्ट आईडी के आधार पर रिपोर्ट का डेटा फ़ेच कर रहा है, तो डेटा उस रिपोर्ट के लिए दिखाया गया था. इसलिए, हो सकता है कि स्कीमा के बारे में पहले से जानकारी न हो. इस मामले में, getSchema() को डेटा फ़ेच करना पड़ सकता है और स्कीमा को कैलकुलेट किया जा सकता है.

npm-downloads/src/main.js
function getFields() {
  var fields = cc.getFields();
  var types = cc.FieldType;
  var aggregations = cc.AggregationType;

  fields
    .newDimension()
    .setId('packageName')
    .setName('Package')
    .setType(types.TEXT);

  fields
    .newDimension()
    .setId('day')
    .setName('Date')
    .setType(types.YEAR_MONTH_DAY);

  fields
    .newMetric()
    .setId('downloads')
    .setName('Downloads')
    .setType(types.NUMBER)
    .setAggregation(aggregations.SUM);

  return fields;
}

// https://developers.google.com/datastudio/connector/reference#getschema
function getSchema(request) {
  return {schema: getFields().build()};
}

getData() की मदद से डेटा फ़ेच करना और वापस लाना

इस फ़ंक्शन को दिए गए अनुरोध का डेटा पाने के लिए कॉल किया जाता है. कोई भी कॉन्फ़िगरेशन getConfig() फ़ंक्शन से तय किए गए पैरामीटर इसमें दिए जाएंगे request आर्ग्युमेंट. ज़्यादा जानकारी के लिए, getData() रेफ़रंस देखें.

getData() अनुरोध के इन पैरामीटर के लिए अतिरिक्त ज़रूरी है ध्यान दें:

  • lastRefresh
    lastRefresh एक ऐसा टाइमस्टैंप दिखाता है जो सबसे हाल ही के समय के बारे में बताता है डेटा को रीफ़्रेश करने का अनुरोध करें. आपके पास वैल्यू को इस फ़ॉर्मैट में पार्स करने की सुविधा होनी चाहिए new Date(timestampString). अगर Apps Script कैश सेवा का इस्तेमाल किया जा रहा है या किसी अन्य तरीके से कैश मेमोरी में सेव करने का विकल्प है, तो lastRefresh टाइमस्टैंप इन कामों में आपकी मदद कर सकता है तय करें कि डेटा सोर्स के लिए, फ़ेच करने का नया अनुरोध करना है या नहीं कैश मेमोरी से डेटा हासिल करें.

  • dateRange
    अगर getConfig() में dateRangeRequired को true पर सेट किया गया है, तो हर getData() में कॉल में अनुरोध में चुनी गई तारीख की सीमा शामिल होगी. यहां जाएं: ज़्यादा जानकारी के लिए, तारीख की सीमाओं के साथ काम करना.

नीचे दिए गए उदाहरण में, आने वाले अनुरोध के आधार पर डेटा फ़ेच किया गया है और नतीजे के तौर पर पैकेज के आंकड़े:

npm-downloads/src/main.js
// https://developers.google.com/datastudio/connector/reference#getdata
function getData(request) {
  request.configParams = validateConfig(request.configParams);

  var requestedFields = getFields().forIds(
    request.fields.map(function(field) {
      return field.name;
    })
  );

  try {
    var apiResponse = fetchDataFromApi(request);
    var normalizedResponse = normalizeResponse(request, apiResponse);
    var data = getFormattedData(normalizedResponse, requestedFields);
  } catch (e) {
    cc.newUserError()
      .setDebugText('Error fetching data from API. Exception details: ' + e)
      .setText(
        'The connector has encountered an unrecoverable error. Please try again later, or file an issue if this error persists.'
      )
      .throwException();
  }

  return {
    schema: requestedFields.build(),
    rows: data
  };
}

/**
 * Gets response for UrlFetchApp.
 *
 * @param {Object} request Data request parameters.
 * @returns {string} Response text for UrlFetchApp.
 */
function fetchDataFromApi(request) {
  var url = [
    'https://api.npmjs.org/downloads/range/',
    request.dateRange.startDate,
    ':',
    request.dateRange.endDate,
    '/',
    request.configParams.package
  ].join('');
  var response = UrlFetchApp.fetch(url);
  return response;
}

/**
 * Parses response string into an object. Also standardizes the object structure
 * for single vs multiple packages.
 *
 * @param {Object} request Data request parameters.
 * @param {string} responseString Response from the API.
 * @return {Object} Contains package names as keys and associated download count
 *     information(object) as values.
 */
function normalizeResponse(request, responseString) {
  var response = JSON.parse(responseString);
  var package_list = request.configParams.package.split(',');
  var mapped_response = {};

  if (package_list.length == 1) {
    mapped_response[package_list[0]] = response;
  } else {
    mapped_response = response;
  }

  return mapped_response;
}

/**
 * Formats the parsed response from external data source into correct tabular
 * format and returns only the requestedFields
 *
 * @param {Object} parsedResponse The response string from external data source
 *     parsed into an object in a standard format.
 * @param {Array} requestedFields The fields requested in the getData request.
 * @returns {Array} Array containing rows of data in key-value pairs for each
 *     field.
 */
function getFormattedData(response, requestedFields) {
  var data = [];
  Object.keys(response).map(function(packageName) {
    var package = response[packageName];
    var downloadData = package.downloads;
    var formattedData = downloadData.map(function(dailyDownload) {
      return formatData(requestedFields, packageName, dailyDownload);
    });
    data = data.concat(formattedData);
  });
  return data;
}

प्रोजेक्ट मेनिफ़ेस्ट को पूरा करें

मेनिफ़ेस्ट फ़ाइल में आपके कम्यूनिटी कनेक्टर के बारे में जानकारी होती है Looker Studio में अपने कनेक्टर को डिप्लॉय और इस्तेमाल करने के लिए ज़रूरी है.

Apps Script डेवलपमेंट एनवायरमेंट में, मेनिफ़ेस्ट फ़ाइल में बदलाव करने के लिए व्यू मेन्यू में जाएं और मेनिफ़ेस्ट फ़ाइल दिखाएं पर क्लिक करें. इससे नया appsscript.json मेनिफ़ेस्ट फ़ाइल.

नीचे दिए गए डेटा को शामिल करने के लिए, मेनिफ़ेस्ट अपडेट करें:

npm-downloads/src/appsscript.json
{
  "dependencies": {
    "libraries": []
  },
  "dataStudio": {
    "name": "npm Downloads",
    "logoUrl": "https://raw.githubusercontent.com/npm/logos/master/npm%20square/n-64.png",
    "company": "Google Data Studio Developer Relations",
    "companyUrl": "https://developers.google.com/datastudio/",
    "addonUrl": "https://github.com/googledatastudio/community-connectors/tree/master/npm-downloads#readme",
    "supportUrl": "https://github.com/googledatastudio/community-connectors/issues",
    "description": "Get npm package download counts.",
    "sources": ["npm"],
    "templates": {
      "default": "1twu0sHjqR5dELAPyGJcw4GS3-D0_NTrQ"
    }
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/script.external_request"
  ]
}

Looker Studio मेनिफ़ेस्ट के बारे में जानकारी पाने के लिए, मेनिफ़ेस्ट रेफ़रंस रेफ़रंस देखें.

अगले चरण

अगला चरण अपने कम्यूनिटी कनेक्टर को डिप्लॉय करना होगा.