একটি সম্প্রদায় সংযোগকারী তৈরি করুন

একটি কমিউনিটি কানেক্টর তৈরির ধাপগুলি হল:

  1. একটি নতুন অ্যাপস স্ক্রিপ্ট প্রকল্প তৈরি করুন।
  2. সংযোগকারী কোডটি লিখুন।
  3. প্রকল্পের ম্যানিফেস্টটি সম্পূর্ণ করুন।

একটি নতুন অ্যাপস স্ক্রিপ্ট প্রকল্প তৈরি করুন

একটি নতুন প্রকল্প তৈরি করতে Google Apps Script দেখুন। Apps Script আপনার জন্য একটি ডিফল্ট স্ক্রিপ্ট তৈরি করবে। myFunction ফাংশনটি সরিয়ে প্রকল্পটির নাম পরিবর্তন করতে দ্বিধা করবেন না। ( Apps Script সম্পর্কে আরও জানুন )

সংযোগকারী কোডটি লিখুন।

প্রতিটি সংযোগকারীর জন্য নির্দিষ্ট ফাংশনের সেট সংজ্ঞায়িত থাকা আবশ্যক। হোস্টিং অ্যাপ্লিকেশন (যেমন লুকার স্টুডিও) এই ফাংশনগুলি কার্যকর করবে। আপনার সংযোগকারী আগত অনুরোধগুলি পরিচালনা করবে এবং কমিউনিটি সংযোগকারী API রেফারেন্সে বর্ণিত হিসাবে প্রতিক্রিয়া জানাবে বলে আশা করা হচ্ছে। আপনার কোড তৈরি করার সময় যদি আপনি সমস্যার সম্মুখীন হন, তাহলে সাহায্যের জন্য ডিবাগিং নির্দেশিকাটি পড়ুন।

getAuthType() তে প্রমাণীকরণের ধরণ নির্ধারণ করুন

এই ফাংশনটি তৃতীয় পক্ষের পরিষেবার জন্য ব্যবহৃত প্রমাণীকরণ পদ্ধতি সনাক্ত করার জন্য ডাকা হয়। বিস্তারিত জানার জন্য getAuthType() রেফারেন্স দেখুন। বর্তমানে সমর্থিত প্রমাণীকরণ পদ্ধতিগুলি AuthType রেফারেন্সে তালিকাভুক্ত করা হয়েছে।

উদাহরণস্বরূপ, নিম্নলিখিত সংযোগকারীর প্রমাণীকরণের প্রয়োজন হয় না:

npm-ডাউনলোড/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 রেফারেন্সে তালিকাভুক্ত করা হয়েছে।

যদি আপনার ডেটা সোর্সকে প্যারামিটার হিসেবে date প্রয়োজন হয়, তাহলে config.setDateRangeRequired(true) কল করুন। যদি আপনার শর্তসাপেক্ষ বা গতিশীল কনফিগারেশন প্রশ্ন জিজ্ঞাসা করার প্রয়োজন হয়, তাহলে stepped config দেখুন।

নিচে এমন একটি সংযোগকারীর উদাহরণ দেওয়া হল যেখানে ব্যবহারকারীকে একটি npm প্যাকেজ নাম কোড প্রবেশ করাতে হয়। getConfig() ফাংশনে একটি info এবং একটি ইনপুট ক্ষেত্র সংজ্ঞায়িত করা হয়:

npm-ডাউনলোড/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-ডাউনলোড/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) দিয়ে মানটি পার্স করতে সক্ষম হবেন। আপনি যদি অ্যাপস স্ক্রিপ্ট ক্যাশে পরিষেবা বা অন্য কোনও ক্যাশিং পদ্ধতি ব্যবহার করেন, তাহলে lastRefresh টাইমস্ট্যাম্প আপনাকে ডেটা উৎসে একটি নতুন আনার অনুরোধ করতে হবে নাকি ক্যাশে থেকে ডেটা পরিবেশন করতে হবে তা নির্ধারণ করতে সহায়তা করতে পারে।

  • dateRange
    যদি getConfig() তে dateRangeRequired true হিসেবে সেট করা থাকে, তাহলে প্রতিটি getData() কলে অনুরোধে নির্বাচিত তারিখ পরিসর থাকবে। আরও বিস্তারিত জানার জন্য তারিখ পরিসরের সাথে কাজ করা দেখুন।

নিম্নলিখিত উদাহরণটি আগত অনুরোধের উপর ভিত্তি করে ডেটা সংগ্রহ করে এবং প্যাকেজ পরিসংখ্যান প্রদান করে:

npm-ডাউনলোড/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;
}

প্রকল্পের ম্যানিফেস্টটি সম্পূর্ণ করুন

ম্যানিফেস্ট ফাইলটিতে আপনার কমিউনিটি কানেক্টর সম্পর্কে তথ্য রয়েছে যা লুকার স্টুডিওতে আপনার কানেক্টর স্থাপন এবং ব্যবহার করার জন্য প্রয়োজনীয়।

অ্যাপস স্ক্রিপ্ট ডেভেলপমেন্ট এনভায়রনমেন্টে ম্যানিফেস্ট ফাইলটি সম্পাদনা করতে, ভিউ মেনুতে ক্লিক করুন এবং Show manifest file এ ক্লিক করুন। এটি একটি নতুন appsscript.json ম্যানিফেস্ট ফাইল তৈরি করবে।

নিম্নলিখিত ডেটা অন্তর্ভুক্ত করার জন্য ম্যানিফেস্ট আপডেট করুন:

npm-ডাউনলোড/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"
  ]
}

লুকার স্টুডিও ম্যানিফেস্ট সম্পর্কে বিস্তারিত জানার জন্য, রেফারেন্স ম্যানিফেস্ট রেফারেন্স দেখুন।

পরবর্তী পদক্ষেপ

পরবর্তী ধাপ হবে আপনার কমিউনিটি কানেক্টর স্থাপন করা ।