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

একটি কমিউনিটি সংযোগকারী তৈরির পদক্ষেপগুলি হল:

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

একটি নতুন Apps স্ক্রিপ্ট প্রকল্প তৈরি করুন৷

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

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

প্রতিটি সংযোগকারীর ফাংশন সংজ্ঞায়িত একটি নির্দিষ্ট সেট আছে প্রয়োজন. হোস্টিং অ্যাপ্লিকেশন (যেমন লুকার স্টুডিও) এই ফাংশনগুলি চালাবে। আপনার সংযোগকারী আগত অনুরোধগুলি পরিচালনা করবে এবং সম্প্রদায় সংযোগকারী 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) দিয়ে মান পার্স করতে সক্ষম হবেন। আপনি যদি অ্যাপস স্ক্রিপ্ট ক্যাশে পরিষেবা বা অন্য কোনও ক্যাশিং পদ্ধতি ব্যবহার করেন, 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;
}

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

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

অ্যাপস স্ক্রিপ্ট ডেভেলপমেন্ট এনভায়রনমেন্টে ম্যানিফেস্ট ফাইল সম্পাদনা করতে, ভিউ মেনুতে ক্লিক করুন এবং ম্যানিফেস্ট ফাইল দেখান ক্লিক করুন। এটি একটি নতুন 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"
  ]
}

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

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

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