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

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

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

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

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

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

हर कनेक्टर के लिए, फ़ंक्शन का एक खास सेट तय करना ज़रूरी है. होस्टिंग ऐप्लिकेशन (जैसे, Data Studio) इन फ़ंक्शन को लागू करेगा. आपके कनेक्टर को, आने वाले अनुरोधों को मैनेज करना होगा और Community Connector 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() से मिले जवाब के आधार पर, Data 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;
}

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

मेनिफ़ेस्ट फ़ाइल में, आपके कम्यूनिटी कनेक्टर के बारे में जानकारी होती है. Data 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"
  ]
}

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

अगले चरण

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