ম্যানিফেস্ট রেফারেন্স

ম্যানিফেস্ট ( appsscript.json ) হলো আপনার অ্যাপস স্ক্রিপ্ট কানেক্টর প্রজেক্টের একটি JSON ফাইল। এতে আপনার কমিউনিটি কানেক্টর সম্পর্কিত কিছু নির্দিষ্ট তথ্য থাকে, যা ডেটা স্টুডিওতে আপনার কানেক্টরটি ডেপ্লয় ও ব্যবহার করার জন্য প্রয়োজন। অ্যাপস স্ক্রিপ্টে ম্যানিফেস্ট সম্পর্কে আরও পড়ুন।

সতর্কতা: ম্যানিফেস্ট ফাইলে আপনি যে কোনো তথ্য রাখবেন তা সর্বজনীন বলে গণ্য করা উচিত।

আপনার ম্যানিফেস্টে নিম্নলিখিত তথ্যগুলো থাকা উচিত:

সম্পত্তির নাম	প্রকার	বর্ণনা
প্রয়োজনীয় ( dataStudio প্রপার্টির অধীনে)
name	string	আপনার কানেক্টরের নাম। ২৮টি অক্ষরের মধ্যে সীমাবদ্ধ
company	string	প্রতিষ্ঠান বা উন্নয়নকারীর নাম।
companyUrl	string (link)	সংস্থা বা ডেভেলপারের ওয়েবসাইটের লিঙ্ক।
logoUrl	string (image link)	আপনার কানেক্টরের আইকনের ইউআরএল। প্রয়োজনীয় মাপ হলো ৪০ পিক্সেল × ৪০ পিক্সেল।
addOnUrl	string (link)	একটি নির্দিষ্ট 'আরও জানুন' পৃষ্ঠার লিঙ্ক দিন, যেখানে আপনার কানেক্টরটি কী কাজ করে এবং কোন ডেটা অ্যাক্সেস করে তা ব্যাখ্যা করা থাকবে। এই পৃষ্ঠাটি আপনাকে হোস্ট ও রক্ষণাবেক্ষণ করতে হবে। এই পৃষ্ঠায় অবশ্যই আপনার পরিষেবার শর্তাবলী এবং গোপনীয়তা নীতি অন্তর্ভুক্ত থাকতে হবে অথবা সেগুলোর লিঙ্ক থাকতে হবে।
supportUrl	string (link)	এই কানেক্টরটি সমর্থন করার জন্য সাপোর্ট পেজের লিঙ্ক। ব্যবহারকারীরা এই লিঙ্কে আপনার কানেক্টরের সমস্যাগুলো জানাতে পারবেন। এই পেজটি আপনাকে হোস্ট ও রক্ষণাবেক্ষণ করতে হবে।
description	string	আপনার কানেক্টরের বিবরণ। ব্যবহারকারীরা আপনার কানেক্টর কনফিগারেশন পেজে সম্পূর্ণ বিবরণ দেখতে পাবেন। লিঙ্কগুলো ক্লিকযোগ্য হবে।
ঐচ্ছিক ( dataStudio প্রপার্টির অধীনে)
shortDescription	string	সীমা: ১১৪ অক্ষর। আপনার কানেক্টরটি প্রকাশিত হলে, এই সংক্ষিপ্ত বিবরণটি আপনার কানেক্টরের গ্যালারি কার্ডে দেখা যাবে। আপনার কানেক্টরটি কী কাজ করে, তা সংক্ষেপে বর্ণনা করতে এটি ব্যবহার করুন। ব্যবহারকারীরা গ্যালারিতে কানেক্টরগুলো ব্রাউজ করার সময় এটি দেখতে পাবেন।
privacyPolicyUrl	string (link)	কানেক্টর / ডেভেলপার সংস্থার গোপনীয়তা নীতির লিঙ্ক।
termsOfServiceUrl	string (link)	কানেক্টর / ডেভেলপার সংস্থার পরিষেবার শর্তাবলীর লিঙ্ক।
authType	list( AuthType )	আপনার কানেক্টরের জন্য প্রমাণীকরণ পদ্ধতির ধরণ। নিচে AuthType দেখুন।
feeType	list( FeeType )	আপনার কানেক্টরের জন্য ফি-এর ধরণ নির্দেশ করে। নিচে ফি-এর ধরণ দেখুন।
sources	list( Sources )	এই কানেক্টরটি যেসব ডেটা সোর্সের সাথে সংযোগ স্থাপন করতে পারে তার তালিকা। নিচে সোর্সসমূহ দেখুন।
templates	Object	এই কানেক্টরের সাথে ব্যবহারযোগ্য টেমপ্লেটগুলোর তালিকা। শুধুমাত্র একটি ডিফল্ট টেমপ্লেট সমর্থিত, যা একটি default কী (key) সেট করার মাধ্যমে চিহ্নিত করা হয়। এর ভ্যালুটি হবে সেই ডেটা স্টুডিও রিপোর্টের রিপোর্ট আইডি, যা টেমপ্লেট হিসেবে ব্যবহৃত হবে। রিপোর্ট টেমপ্লেট সরবরাহ করার নির্দেশিকাটি দেখুন।
forceViewersCredentials	boolean	এই কানেক্টর থেকে তৈরি ডেটা সোর্সগুলির জন্য দর্শকের পরিচয়পত্র বাধ্যতামূলক করা হবে কি না। এই প্রপার্টিটি ঐচ্ছিক এবং এর ডিফল্ট মান হলো false । দর্শকের পরিচয়পত্র সম্পর্কে আরও বিস্তারিত জানতে 'ডেটা সোর্স ক্রেডেনশিয়ালস' দেখুন।
useQueryConfig	boolean	অপ্রচলিত : এই কানেক্টরটি `getData()`-এর জন্য কোনো কোয়েরি কনফিগ ফেরত দেবে কি না। এর পরিবর্তে `advancedServices` ব্যবহার করুন।
advancedServices.data	boolean	এই কানেক্টরটি `getData()`-এর জন্য কোনো কোয়েরি কনফিগ ফেরত দেবে কি না। উন্নত পরিষেবাগুলো দেখুন।
advancedServices.schema	boolean	এই কানেক্টরটি `getSchema()`-এর জন্য একটি কোয়েরি কনফিগ ফেরত দেবে কি না। উন্নত পরিষেবাগুলো দেখুন।
ঐচ্ছিক (রুট লেভেল প্রপার্টি)
urlFetchWhitelist	list(string)	আপনার কানেক্টর যে HTTPS URL প্রিফিক্সগুলো ব্যবহার করে, তার একটি তালিকা। ফেচ করা যেকোনো URL এন্ডপয়েন্টকে অবশ্যই এই তালিকার প্রিফিক্সগুলোর একটির সাথে মিলতে হবে। এটি ব্যবহারকারীর ডেটা সুরক্ষিত রাখতে সাহায্য করতে পারে। আরও বিস্তারিত জানতে ‘সেফলিস্টিং ইউআরএল’ দেখুন।

প্রমাণীকরণ প্রকার

প্রমাণীকরণ পদ্ধতির প্রকারের জন্য মানগুলি নিম্নলিখিতগুলির মধ্যে একটি হতে পারে:

এনাম মান	বর্ণনা
NONE	এর অর্থ হলো কানেক্টরটির জন্য কোনো প্রমাণীকরণের প্রয়োজন নেই।
OAUTH2	এটি নির্দেশ করে যে কানেক্টরটি OAuth 2.0 ব্যবহার করে।
KEY	এটি নির্দেশ করে যে কানেক্টরটি এপিআই কী ব্যবহার করে।
USER_PASS	এটি নির্দেশ করে যে কানেক্টরটি ইউজারনেম/পাসওয়ার্ড ব্যবহার করে।
USER_TOKEN	এটি নির্দেশ করে যে কানেক্টরটি ইউজারনেম/টোকেন ব্যবহার করে।
PATH_USER_PASS	এটি নির্দেশ করে যে কানেক্টরটি পাথ/ইউজারনেম/পাসওয়ার্ড ব্যবহার করে।
PATH_KEY	এটি নির্দেশ করে যে কানেক্টরটি পাথ/কী ব্যবহার করে।

ফি টাইপ

ফি-এর প্রকারের জন্য মানগুলি নিম্নলিখিতগুলির যেকোনো একটি হতে পারে:

এনাম মান	বর্ণনা
FREE	এর মানে হলো কানেক্টরটি ব্যবহারের জন্য সম্পূর্ণ বিনামূল্যে।
FREE_TRIAL	এটি নির্দেশ করে যে কানেক্টরটিতে একটি ফ্রি ট্রায়াল অপশন রয়েছে।
PAID	এর দ্বারা বোঝানো হচ্ছে যে কানেক্টরটি ব্যবহার করার জন্য ব্যবহারকারীকে অর্থ প্রদান করতে হবে।

উৎস

সোর্সেস হলো সোর্সগুলোর জন্য এনামের একটি তালিকা। আপনি আমাদের ডেটা রেজিস্ট্রি রিপোজিটরিতে সোর্সগুলোর বিদ্যমান তালিকা দেখতে পারেন। আপনি যে সোর্সের সাথে সংযোগ স্থাপন করতে চাইছেন, সেটি যদি রিপোজিটরিতে না থাকে, তবে সোর্সটি যোগ করার জন্য ডেটা রেজিস্ট্রি রিপোজিটরিতে একটি পুল রিকোয়েস্ট পাঠান। সোর্সের নামে শুধুমাত্র বড় হাতের অক্ষর এবং আন্ডারস্কোর থাকতে পারে (যেমন Google Analytics-এর নাম হবে GOOGLE_ANALYTICS )। আপনার কমিউনিটি কানেক্টর ম্যানিফেস্টে, ডেটা সোর্স আইডি প্রপার্টির ভ্যালুটি ব্যবহার করুন, যেমন GOOGLE_ANALYTICS ।

কমিউনিটি কানেক্টরের জন্য ম্যানিফেস্টের উদাহরণ

নিম্নলিখিতটি একটি সম্পূর্ণ ম্যানিফেস্টের উদাহরণ:

ডেটা-স্টুডিও/অ্যাপসস্ক্রিপ্ট.json

গিটহাবে দেখুন

{
  "dataStudio": {
    "name": "Nucleus by Hooli",
    "company": "Hooli Inc.",
    "companyUrl": "https://hooli.xyz",
    "logoUrl": "https://hooli.xyz/middle-out-optimized/nucleus/logo.png",
    "addonUrl": "https://hooli.xyz/data-studio-connector",
    "supportUrl": "https://hooli.xyz/data-studio-connector/support",
    "description": "Nucleus by Hooli connector lets you connect to your data in Data Studio using Nucleus middle out optimization. You will need an account on hooli.xyz to use this connector. Create your account at https://hooli.xyz/signup",
    "shortDescription": "Connect to your data using Nucleus middle out optimization",
    "privacyPolicyUrl": "https://hooli.xyz/privacy",
    "termsOfServiceUrl": "https://hooli.xyz/tos",
    "authType": ["NONE"],
    "feeType": ["PAID"],
    "sources": [
      "HOOLI_CHAT_LOG",
      "ENDFRAME_SERVER_STREAM",
      "RETINABYTE_USER_ANALYTICS"
    ],
    "templates": {
      "default": "872223s89f5fdkjnd983kjf"
    }
  },
  "urlFetchWhitelist": ["https://api.hooli.xyz/", "https://hooli.xyz/"]
}