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

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

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

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

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

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

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

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) को कॉल करें. अगर आपको कंडिशनल या डाइनैमिक कॉन्फ़िगरेशन से जुड़े सवाल पूछने हैं, तो सिलसिलेवार कॉन्फ़िगरेशन देखें.

नीचे एक ऐसे कनेक्टर का उदाहरण दिया गया है जिसके लिए उपयोगकर्ता को एनपीएम पैकेज का नाम कोड डालना ज़रूरी होता है. जानकारी और इनपुट फ़ील्ड को 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 मेनिफ़ेस्ट की जानकारी के लिए, मेनिफ़ेस्ट रेफ़रंस रेफ़रंस देखें.

अगले चरण

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