অন্তর্নির্মিত উপাদান রেফারেন্স

এই নথিটি সমস্ত অন্তর্নির্মিত এম্বেড API উপাদানগুলির জন্য বিকল্প, পদ্ধতি, বৈশিষ্ট্য এবং ইভেন্টগুলি বর্ণনা করে৷

প্রমাণ

gapi.analytics.auth

প্রমাণীকরণ উপাদানটি একটি সিঙ্গলটন যা ব্যবহারকারীকে অনুমোদন করতে ব্যবহার করা যেতে পারে।

পদ্ধতি
authorize( options :Object)	রিটার্ন: gapi.analytics.auth ব্যবহারকারীকে তাদের Google অ্যাকাউন্ট দিয়ে সাইন ইন করার অনুমতি দিয়ে নির্দিষ্ট কন্টেইনারের ভিতরে একটি Google Analytics সাইন-ইন বোতাম রেন্ডার করে।
isAuthorized()	রিটার্ন: boolean ব্যবহারকারী সফলভাবে অনুমোদিত হলে true ফেরত দেয়, অন্যথায় false ।
signOut()	রিটার্ন: gapi.analytics.auth বর্তমান ব্যবহারকারীকে সাইন আউট করে। এছাড়াও signOut ইভেন্ট ট্রিগার করে।
getAuthResponse()	রিটার্নস: Object আসল অনুমোদনের অনুরোধ দ্বারা প্রমাণীকরণ ডেটা ফেরত পায়। প্রত্যাবর্তিত বস্তুটিতে অ্যাক্সেস টোকেন অন্তর্ভুক্ত থাকে, যা সাধারণত ম্যানুয়ালি প্রমাণীকৃত অনুরোধ করতে পারে।
getUserProfile()	রিটার্নস: Object বর্তমানে সাইন-ইন করা ব্যবহারকারী সম্পর্কে প্রাথমিক প্রোফাইল তথ্য পায়। এতে ব্যবহারকারীর নাম, ইমেল ঠিকানা এবং সর্বজনীন প্রোফাইল ছবি (যদি সেট করা থাকে) অন্তর্ভুক্ত থাকে।

উত্তরাধিকারসূত্রে প্রাপ্ত পদ্ধতি
on
once
off

অপশন
clientId	প্রকার: string বিকাশকারী কনসোলে আপনার প্রকল্পের ক্লায়েন্ট আইডি।
container	প্রকার: string|HTMLElement DOM-এ একটি HTML উপাদানের ID যা সাইন-ইন বোতাম হোস্ট করবে। আপনি উপাদান নিজেই একটি রেফারেন্স পাস করতে পারেন.
userInfoLabel	প্রকার: string লগ ইন করা ব্যবহারকারীর ইমেল ঠিকানার আগে প্রদর্শিত পাঠ্য। ডিফল্ট 'You are logged in as: ' ।
scopes	প্রকার: Array আপনার অ্যাপ্লিকেশন অনুরোধ করছে এমন Google API প্রমাণীকরণের সুযোগের একটি তালিকা। সমস্ত উপলব্ধ সুযোগগুলি দেখতে, OAuth 2.0 খেলার মাঠে যান৷ Google Analytics API auth স্কোপের জন্য কনফিগারেশন এবং রিপোর্টিং সংস্থানগুলির জন্য বিকাশকারী নির্দেশিকাগুলি দেখুন৷
overwriteDefaultScopes	প্রকার: boolean scopes বিকল্পটি ডিফল্ট এম্বেড API স্কোপগুলিকে প্রতিস্থাপন করে বা সেগুলিতে যোগ করে কিনা তা নির্দেশ করে। false (ডিফল্ট) নির্দিষ্ট করা ডিফল্ট স্কোপগুলিতে যোগ করবে এবং true নির্দিষ্ট করা হলে scopes বিকল্প দ্বারা নির্দিষ্ট করা সেগুলিকে প্রতিস্থাপন করবে। ডিফল্ট স্কোপের মান হল: ['https://www.googleapis.com/auth/analytics.readonly'] । দ্রষ্টব্য: এম্বেড API এর মাধ্যমে প্রমাণীকরণের জন্য ব্যবহারকারীর মৌলিক প্রোফাইলে অ্যাক্সেস প্রয়োজন। এই সুযোগগুলি ওভাররাইট করা যাবে না।
serverAuth.access_token	প্রকার: string আপনার যদি ইতিমধ্যেই একটি বৈধ অ্যাক্সেস টোকেন থাকে, তাহলে আপনি এটি সরাসরি অনুমোদন পদ্ধতিতে পাস করতে পারেন এবং ব্যবহারকারীকে অনুমোদন করার জন্য অনুরোধ করা হবে না। কিভাবে একটি অ্যাক্সেস টোকেন পুনরুদ্ধার করতে হয় তার বিস্তারিত জানার জন্য, OAuth 2.0 ডকুমেন্টেশন দেখুন।

ঘটনা
signIn	যুক্তি: কোনটিই না ব্যবহারকারী সফলভাবে সাইন ইন করলে বহিস্কার করা হয়েছে।
signOut	যুক্তি: কোনটিই না ব্যবহারকারী সফলভাবে সাইন আউট হয়ে গেলে বরখাস্ত করা হয়েছে৷
needsAuthorization	যুক্তি: কোনটিই না gapi.analytics.auth.authorize পদ্ধতি ব্যবহার করার সময়, ব্যবহারকারী বর্তমানে সাইন ইন করেছেন কিনা তা দেখার জন্য একটি প্রাথমিক চেক করা হয়। ব্যবহারকারী সাইন ইন না করলে, এই ইভেন্টটি বরখাস্ত করা হয় যাতে আরও অনুমোদনের প্রয়োজন হয়।
error	যুক্তি: response প্রমাণীকরণ প্রক্রিয়া চলাকালীন একটি ত্রুটি ঘটলে বহিস্কার করা হয়। আপনি যদি প্রতিক্রিয়া অবজেক্ট থেকে ত্রুটি বার্তা পেতে চান তবে এটি হবে response.error.message ।

অপ্রচলিত ঘটনা
success	যুক্তি: response এই ইভেন্টটি পিছনের সামঞ্জস্যের জন্য বিদ্যমান এবং ভবিষ্যতের সংস্করণে সরানো হতে পারে৷ পরিবর্তে signIn ইভেন্ট ব্যবহার করুন।

উদাহরণ

// Standard client-side authorization.

gapi.analytics.auth.authorize({
  clientId: 'XXXXXX',
  container: 'auth-button'
});

gapi.analytics.auth.on('signIn', function() {
  console.log(gapi.analytics.auth.getUserProfile());
});

// Authorization using an access token obtained server-side.
// You do not need to register an event handler because
// authorization happens immediately.

gapi.analytics.auth.authorize({
  serverAuth: {
    access_token: 'XXXXXX'
  }
});

দ্রষ্টব্য: serverAuth.access_token ব্যবহার করার সময় অনুমোদন অবিলম্বে ঘটে, তাই একটি ইভেন্ট হ্যান্ডলার নিবন্ধন করার প্রয়োজন নেই।

গুরুত্বপূর্ণ: serverAuth.access_token ব্যবহার করার সময়, টোকেনটি বৈধ এবং মেয়াদ শেষ হয়নি তা নিশ্চিত করা আপনার উপর নির্ভর করে। মেয়াদোত্তীর্ণ অ্যাক্সেস টোকেন কীভাবে রিফ্রেশ করবেন তার বিস্তারিত জানার জন্য, OAuth 2.0 ডকুমেন্টেশন দেখুন।

ডেটা

gapi.analytics.report.Data

কনস্ট্রাক্টর
Data( options :Object)	ডেটা কম্পোনেন্ট আপনাকে Google Analytics কোর রিপোর্টিং এপিআই জিজ্ঞাসা করতে এবং ফলাফলগুলি ফিরে পেতে দেয়।

অপশন
query	প্রকার: Object কোর রিপোর্টিং API থেকে ক্যোয়ারী প্যারামিটার ধারণকারী একটি বস্তু। API দ্বারা প্রদত্ত নিয়মিত ডিফল্টের পাশাপাশি নিম্নলিখিত ডিফল্ট মানগুলি ব্যবহার করা হয়: { 'start-date': '7daysAgo', 'end-date': 'yesterday }

উত্তরাধিকারসূত্রে প্রাপ্ত পদ্ধতি
get
set
execute
on
once
off
emit

ঘটনা
success	যুক্তি: response কোয়েরি সফলভাবে সম্পন্ন হলে বহিস্কার করা হয়েছে।
error	যুক্তি: response ক্যোয়ারী প্রক্রিয়া চলাকালীন একটি ত্রুটি ঘটলে বহিস্কার করা হয়। আপনি যদি প্রতিক্রিয়া অবজেক্ট থেকে ত্রুটি বার্তা পেতে চান তবে এটি হবে response.error.message ।

উদাহরণ

var report = new gapi.analytics.report.Data({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:city'
  }
});

report.on('success', function(response) {
  console.log(response);
});

report.execute();

ডেটাচার্ট

gapi.analytics.googleCharts.DataChart

কনস্ট্রাক্টর
DataChart( options :Object)	DataChart একটি স্ট্যান্ডার্ড Google চার্ট এবং একটি ডেটা কম্পোনেন্টকে মোড়ে রাখে যাতে আপনি সহজেই একটি ক্যোয়ারী থেকে একটি ভিজ্যুয়ালাইজেশন তৈরি করতে পারেন এবং এটিকে নিজে একত্রিত না করেই।

অপশন
query	প্রকার: Object ডাটা কম্পোনেন্ট ক্যোয়ারী অপশন দেখুন।
chart	প্রকার: Object স্বতন্ত্র চার্ট বিকল্পের বিশদ বিবরণের জন্য নীচে দেখুন।
chart.container	প্রকার: string|HTMLElement DOM-এ একটি HTML উপাদানের ID যা DataChart হোস্ট করবে। আপনি উপাদান নিজেই একটি রেফারেন্স পাস করতে পারেন.
chart.type	প্রকার: string চার্টের ধরন। সম্ভাব্য বিকল্পগুলি হল: LINE , COLUMN , BAR , TABLE , এবং GEO ৷
chart.options	প্রকার: Object সংশ্লিষ্ট Google চার্ট অবজেক্টে পাস করা যেতে পারে এমন যেকোনো বিকল্প।

উত্তরাধিকারসূত্রে প্রাপ্ত পদ্ধতি
get
set
execute
on
once
off
emit

ঘটনা
success	আর্গুমেন্ট: result ক্যোয়ারী সফলভাবে সম্পন্ন হলে এবং চার্ট সম্পূর্ণরূপে রেন্ডার হয়ে গেলে বহিস্কার করা হয়। result.chart – গুগল চার্টের উদাহরণ। result.data – ডেটা প্যারামিটার ফরম্যাটে রিপোর্টের প্রতিক্রিয়া। result.dataTable – result.data অবজেক্ট থেকে তৈরি DataTable উদাহরণ। result.response – raw API রেসপন্স অবজেক্ট।
error	যুক্তি: response কোয়েরি বা রেন্ডারিং প্রক্রিয়া চলাকালীন একটি ত্রুটি ঘটলে বহিস্কার করা হয়। আপনি যদি প্রতিক্রিয়া অবজেক্ট থেকে ত্রুটি বার্তা পেতে চান তবে এটি হবে response.error.message ।

উদাহরণ

var chart = new gapi.analytics.googleCharts.DataChart({
  query: {
    ids: 'ga:XXXX',
    metrics: 'ga:sessions',
    dimensions: 'ga:date'
  },
  chart: {
    type: 'LINE',
    container: 'line-chart',
    options: {
      title: 'Sessions over the past week.',
      fontSize: 12
    }
  }
});
chart.on('success', function(response) {
  // response.chart : the Google Chart instance.
  // response.data : the Google Chart data object.
});

chart.execute();

ভিউ নির্বাচক

gapi.analytics.ViewSelector

কনস্ট্রাক্টর
ViewSelector( options :Object)	ViewSelector উপাদান আপনাকে আপনার অ্যাকাউন্ট, সম্পত্তি, এবং ড্রপডাউন মেনুর মাধ্যমে দেখার অনুমতি দেয়।

অপশন
container	প্রকার: string|HTMLElement DOM-এ একটি HTML উপাদানের ID যা ভিউ সিলেক্টর হোস্ট করবে। আপনি উপাদান নিজেই একটি রেফারেন্স পাস করতে পারেন.

উত্তরাধিকারসূত্রে প্রাপ্ত পদ্ধতি
get
set
execute
on
once
off
emit

উদাহরণ বৈশিষ্ট্য
ids	প্রকার: string ga:XXXX ফর্মের অনন্য টেবিল ID, যেখানে XXXX হল Analytics ভিউ (প্রোফাইল) ID৷

ঘটনা
change	আর্গুমেন্ট: ids ব্যবহারকারী যখন ড্রপডাউন মেনু থেকে একটি নতুন ভিউ নির্বাচন করে তখনই বরখাস্ত করা হয়। যখন ViewSelector দৃষ্টান্তটি প্রথম রেন্ডার করা হয় এবং ডিফল্ট ভিউ প্রদর্শিত হয় তখন এটি গুলি করা হয়।

উদাহরণ

var viewSelector = new gapi.analytics.ViewSelector({
  container: 'view-selector'
});

viewSelector.on('change', function(ids) {
  console.log(ids);
});

viewSelector.execute();

ভাগ করা উপাদান পদ্ধতি

পদ্ধতি
set(options)	ফিরে আসে: this কম্পোনেন্টের কনফিগারেশন অপশন সেট বা আপডেট করে (এটি কনস্ট্রাক্টরের তৈরির সময়ও করা যেতে পারে)।
get()	রিটার্ন: Object একটি উপাদানের বর্তমান কনফিগারেশন বিকল্প প্রদান করে।
execute()	ফিরে আসে: this কম্পোনেন্টের প্রাথমিক ক্রিয়াকে আহ্বান করে। এটি সাধারণত পৃষ্ঠায় কিছু রেন্ডার করা হয় বা একটি প্রতিবেদন চালায় (বা উভয়ই)।
on(event, handler)	ফিরে আসে: this কম্পোনেন্ট যখন নির্দিষ্ট ইভেন্ট নির্গত করে তখন আমন্ত্রণ জানানোর জন্য একটি ফাংশন নিবন্ধন করে।
once(event, handler)	ফিরে আসে: this নির্দিষ্ট ইভেন্টের শুধুমাত্র পরবর্তী ঘটনাতে আহ্বান করার জন্য একটি ফাংশন নিবন্ধন করে। হ্যান্ডলার একবার চালানোর পরে এটি স্বয়ংক্রিয়ভাবে নিজেকে নিবন্ধনমুক্ত করে।
off(opt_event, opt_handler)	ফেরত: undefined একটি উপাদান থেকে একটি ইভেন্ট হ্যান্ডলার সরিয়ে দেয়। কোনো হ্যান্ডলার পাস না হলে, এটি পাস করা ইভেন্টের জন্য সমস্ত হ্যান্ডলারকে সরিয়ে দেয়। কোনো ইভেন্ট পাস না হলে, এটি সমস্ত ইভেন্টের জন্য সমস্ত হ্যান্ডলারকে সরিয়ে দেয়।
emit(event, ...opt_args)	ফেরত: undefined একটি ঘটনা নির্গত. যেকোন নিবন্ধিত হ্যান্ডলারদের কাছে পাঠানোর জন্য আপনি ঐচ্ছিকভাবে আর্গুমেন্ট নির্দিষ্ট করতে পারেন।

set

কম্পোনেন্টের কনফিগারেশন অপশন সেট বা আপডেট করে (এটি কনস্ট্রাক্টরের তৈরির সময়ও করা যেতে পারে)।

ব্যবহার

component.set(options);

পরামিতি

নাম	টাইপ	বর্ণনা
options	Object	এই উপাদানের জন্য কনফিগারেশন বিকল্প. পাস করা বিকল্পগুলি বিদ্যমান বিকল্পগুলির সাথে একত্রিত হবে।

রিটার্নস

this - উপাদান উদাহরণ.

---

get

একটি উপাদানের বর্তমান কনফিগারেশন বিকল্প প্রদান করে।

রিটার্নস

Object - কম্পোনেন্টের বর্তমান কনফিগারেশন অপশন।

---

execute()

কম্পোনেন্টের প্রাথমিক ক্রিয়াকে আহ্বান করে। এটি সাধারণত পৃষ্ঠায় কিছু রেন্ডার করা হয় বা একটি প্রতিবেদন চালায় (বা উভয়ই)।

রিটার্নস

this - উপাদান উদাহরণ.

---

on(event, handler)

কম্পোনেন্ট যখন নির্দিষ্ট ইভেন্ট নির্গত করে তখন আমন্ত্রণ জানানোর জন্য একটি ফাংশন নিবন্ধন করে।

পরামিতি

নাম	টাইপ	বর্ণনা
event	string	অনুষ্ঠানের নাম।
handler	Function	ইভেন্টটি ঘটলে যে ফাংশনটি আহ্বান করা হবে৷ (পরামিটারের বিবরণের জন্য পৃথক ইভেন্টের রেফারেন্স দেখুন।)

রিটার্নস

this - উপাদান উদাহরণ.

---

once(event, handler)

নির্দিষ্ট ইভেন্টের শুধুমাত্র পরবর্তী ঘটনাতে আহ্বান করার জন্য একটি ফাংশন নিবন্ধন করে। হ্যান্ডলার একবার চালানোর পরে এটি স্বয়ংক্রিয়ভাবে নিজেকে নিবন্ধনমুক্ত করে।

পরামিতি

নাম	টাইপ	বর্ণনা
event	string	অনুষ্ঠানের নাম।
handler	Function	ইভেন্টটি ঘটলে যে ফাংশনটি আহ্বান করা হবে৷ (পরামিটারের বিবরণের জন্য পৃথক ইভেন্টের রেফারেন্স দেখুন।)

রিটার্নস

this - উপাদান উদাহরণ.

---

off(opt_event, opt_handler)

একটি উপাদান থেকে একটি ইভেন্ট হ্যান্ডলার সরিয়ে দেয়। কোনো হ্যান্ডলার পাস না হলে, এটি পাস করা ইভেন্টের জন্য সমস্ত হ্যান্ডলারকে সরিয়ে দেয়। কোনো ইভেন্ট পাস না হলে, এটি সমস্ত ইভেন্টের জন্য সমস্ত হ্যান্ডলারকে সরিয়ে দেয়।

পরামিতি

নাম	টাইপ	বর্ণনা
opt_event	string	অনুষ্ঠানের নাম। কোনো ইভেন্ট নির্দিষ্ট না থাকলে, সমস্ত ইভেন্টের জন্য সমস্ত হ্যান্ডলার সরানো হয়। ঐচ্ছিক।
opt_handler	Function	অপসারণ করা ফাংশন হ্যান্ডলারের একটি রেফারেন্স। কোন ফাংশন পাস না হলে, সমস্ত হ্যান্ডলার সরানো হয়। ঐচ্ছিক।

রিটার্নস

undefined

---

emit(event, ...opt_args)

একটি ঘটনা নির্গত. যেকোন নিবন্ধিত হ্যান্ডলারদের কাছে পাঠানোর জন্য আপনি ঐচ্ছিকভাবে আর্গুমেন্ট নির্দিষ্ট করতে পারেন।

পরামিতি

নাম	টাইপ	বর্ণনা
event	string	অনুষ্ঠানের নাম।
...opt_args	*	যে কোনো নিবন্ধিত ইভেন্ট হ্যান্ডলারদের কাছে ঐচ্ছিক আর্গুমেন্ট পাস করতে হবে।

রিটার্নস

undefined