বিষয় API বিকাশকারীর নির্দেশিকা৷

পরীক্ষার জন্য Chrome পতাকাগুলি কীভাবে ব্যবহার করবেন তা সহ API এর সাথে কীভাবে কাজ করবেন তা শিখুন৷

বাস্তবায়নের অবস্থা

ডেমো চেষ্টা করুন

দুটি বিষয় API ডেমো রয়েছে যা আপনাকে একক ব্যবহারকারী হিসাবে বিষয়গুলি পরীক্ষা করতে সক্ষম করে।

টপিক ক্লাসিফায়ার মডেল ব্যবহার করে দেখতে আপনি টপিক কোল্যাব চালাতে পারেন।

বিষয়গুলি অ্যাক্সেস করতে JavaScript API ব্যবহার করুন এবং সেগুলি পর্যবেক্ষণ করা হিসাবে রেকর্ড করুন৷

টপিকস জাভাস্ক্রিপ্ট API এর একটি পদ্ধতি রয়েছে: document.browsingTopics() । এর দুটি উদ্দেশ্য রয়েছে:

  • ব্রাউজারকে বলুন বর্তমান পৃষ্ঠা পরিদর্শনটি কলারের জন্য পর্যবেক্ষণ করা হয়েছে বলে রেকর্ড করতে, যাতে এটি পরে ব্যবহারকারীর জন্য (কলারের জন্য) বিষয় গণনা করতে ব্যবহার করা যেতে পারে।
  • কলার দ্বারা পর্যবেক্ষণ করা ব্যবহারকারীর জন্য বিষয়গুলি অ্যাক্সেস করুন৷

পদ্ধতিটি একটি প্রতিশ্রুতি প্রদান করে যা এলোমেলো ক্রমে তিনটি সর্বাধিক সাম্প্রতিক যুগের প্রতিটির জন্য একটি করে তিনটি বিষয়ের একটি অ্যারের সমাধান করে৷ একটি যুগ হল একটি সময়কাল যা Chrome এর বাস্তবায়নে এক সপ্তাহে সেট করা হয়েছে৷

document.browsingTopics() দ্বারা প্রত্যাবর্তিত অ্যারের প্রতিটি বিষয় বস্তুর এই বৈশিষ্ট্যগুলি রয়েছে:

  • configVersion : বর্তমান বিষয় API কনফিগারেশন সনাক্তকারী একটি স্ট্রিং, উদাহরণস্বরূপ chrome.2
  • modelVersion : একটি স্ট্রিং যা মেশিন-লার্নিং ক্লাসিফায়ারকে চিহ্নিত করে যা সাইটের বিষয়গুলি অনুমান করতে ব্যবহৃত হয়, উদাহরণস্বরূপ 4
  • taxonomyVersion : ব্রাউজার দ্বারা ব্যবহৃত বিষয়গুলির সেট সনাক্তকারী একটি স্ট্রিং, উদাহরণস্বরূপ 2
  • topic : শ্রেণীবিন্যাসে বিষয় চিহ্নিতকারী একটি সংখ্যা, উদাহরণস্বরূপ 309
  • version : একটি স্ট্রিং সংযুক্ত কনফিগার configVersion , taxonomyVersion এবং modelVersion , উদাহরণস্বরূপ chrome.2:2:4

এই নির্দেশিকায় বর্ণিত পরামিতি এবং API-এর বিশদ বিবরণ (যেমন শ্রেণীবিন্যাস আকার, প্রতি সপ্তাহে গণনা করা বিষয়ের সংখ্যা এবং প্রতি কলে ফেরত আসা বিষয়ের সংখ্যা) পরিবর্তন সাপেক্ষে যেহেতু আমরা বাস্তুতন্ত্রের প্রতিক্রিয়া অন্তর্ভুক্ত করি এবং API এ পুনরাবৃত্তি করি।

document.browsingTopics-এর জন্য সমর্থন সনাক্ত করুন

API ব্যবহার করার আগে, এটি ব্রাউজার দ্বারা সমর্থিত এবং নথিতে উপলব্ধ কিনা তা পরীক্ষা করুন:

'browsingTopics' in document && document.featurePolicy.allowsFeature('browsing-topics') ?
 console.log('document.browsingTopics() is supported on this page') :
 console.log('document.browsingTopics() is not supported on this page');

JavaScript API দিয়ে বিষয়গুলি অ্যাক্সেস করুন৷

বর্তমান ব্যবহারকারীর জন্য বিষয়গুলি অ্যাক্সেস করতে সম্ভাব্য API ব্যবহারের একটি প্রাথমিক উদাহরণ এখানে। 

try {
  // Get the array of top topics for this user.
  const topics = await document.browsingTopics();
  
  // Request an ad creative, providing topics information.
  const response = await fetch('https://ads.example/get-creative', {
   method: 'POST',
   headers: {
     'Content-Type': 'application/json',
   },
   body: JSON.stringify(topics)
  })
  
  // Get the JSON from the response.
  const creative = await response.json();
  
  // Display ad.

} catch (error) {
  // Handle error.
}

অবস্থা পরিবর্তন না করেই বিষয়গুলি অ্যাক্সেস করুন৷

document.browsingTopics() বর্তমান ব্যবহারকারীর জন্য কলার দ্বারা পর্যবেক্ষণ করা বিষয় ফেরত দেয়। ডিফল্টরূপে, পদ্ধতিটি ব্রাউজারকে বর্তমান পৃষ্ঠার ভিজিট রেকর্ড করার কারণ হিসেবে কলারের দ্বারা পর্যবেক্ষণ করা হয়, তাই এটি পরবর্তীতে বিষয় গণনায় ব্যবহার করা যেতে পারে। Chrome 108 থেকে, পদ্ধতিটি একটি ঐচ্ছিক যুক্তি পাস করা যেতে পারে যাতে পৃষ্ঠা পরিদর্শনটি রেকর্ড করা থেকে এড়িয়ে যায়: {skipObservation:true} ।

অন্য কথায়, {skipObservation:true} মানে মেথড কলের কারণে বর্তমান পৃষ্ঠাকে বিষয়ের গণনায় অন্তর্ভুক্ত করা হবে না।

বিষয়গুলি অ্যাক্সেস করতে হেডার ব্যবহার করুন এবং সেগুলিকে পর্যবেক্ষণ করা হিসাবে চিহ্নিত করুন৷

আপনি বিষয়গুলি অ্যাক্সেস করতে পারেন, এবং অনুরোধ এবং প্রতিক্রিয়া শিরোনামের সাহায্যে পৃষ্ঠা পরিদর্শনগুলি পর্যবেক্ষণ হিসাবে চিহ্নিত করতে পারেন৷

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

একটি fetch() বা XHR অনুরোধের Sec-Browsing-Topics শিরোনাম থেকে বিষয়গুলি অ্যাক্সেস করা যেতে পারে।

একটি Observe-Browsing-Topics: ?1 শিরোনাম ব্রাউজারকে কলকারীর দ্বারা পর্যবেক্ষণ করা বর্তমান পৃষ্ঠার পরিদর্শন রেকর্ড করতে দেয়, তাই এটি পরবর্তীতে বিষয় গণনায় ব্যবহার করা যেতে পারে।

HTTP শিরোনাম দুটি উপায়ে বিষয়গুলি অ্যাক্সেস এবং পর্যবেক্ষণ করা যেতে পারে:

  • fetch() : একটি fetch() অনুরোধের বিকল্প প্যারামিটারে {browsingTopics: true} যোগ করুন। টপিক হেডার ডেমো এর একটি সরলীকৃত উদাহরণ দেখায়।
  • iframe অ্যাট্রিবিউট : একটি <iframe> উপাদানে browsingtopics অ্যাট্রিবিউট যোগ করুন, অথবা সমতুল্য জাভাস্ক্রিপ্ট বৈশিষ্ট্য iframe.browsingTopics = true সেট করুন। iframe উত্সের নিবন্ধীকরণযোগ্য ডোমেন হল কলার ডোমেন: উদাহরণস্বরূপ, <iframe src="https://example.com" browsingtopics></iframe> এর জন্য : কলার হল example.com ।

হেডার সম্পর্কে কিছু অতিরিক্ত নোট:

  • পুনঃনির্দেশ অনুসরণ করা হবে, এবং পুনঃনির্দেশের অনুরোধে পাঠানো বিষয়গুলি পুনঃনির্দেশ URL-এর জন্য নির্দিষ্ট হবে।
  • অনুরূপ প্রতিক্রিয়া শিরোনাম না থাকলে অনুরোধের শিরোনামটি কলারের জন্য অবস্থা পরিবর্তন করবে না। অর্থাৎ, প্রতিক্রিয়া শিরোনাম ছাড়া, পৃষ্ঠা পরিদর্শনটি পর্যবেক্ষণ হিসাবে রেকর্ড করা হবে না, তাই এটি পরবর্তী যুগের জন্য ব্যবহারকারীর বিষয় গণনাকে প্রভাবিত করবে না।
  • প্রতিক্রিয়া শিরোনাম শুধুমাত্র সম্মানিত হয় যদি সংশ্লিষ্ট অনুরোধ বিষয় শিরোনাম অন্তর্ভুক্ত.
  • অনুরোধের URL নিবন্ধনযোগ্য ডোমেন সরবরাহ করে যা কলকারী ডোমেন হিসাবে রেকর্ড করা হয়।

আপনার API বাস্তবায়ন ডিবাগ করুন

chrome://topics-internals পৃষ্ঠাটি ডেস্কটপে Chrome-এ উপলভ্য হয় একবার আপনি টপিক API সক্ষম করলে । এটি বর্তমান ব্যবহারকারীর জন্য বিষয়, হোস্টনামের জন্য অনুমান করা বিষয় এবং API বাস্তবায়ন সম্পর্কে প্রযুক্তিগত তথ্য প্রদর্শন করে। আমরা বিকাশকারীর প্রতিক্রিয়ার উপর ভিত্তি করে পৃষ্ঠার নকশাটি পুনরাবৃত্তি করছি এবং উন্নত করছি: bugs.chromium.org এ আপনার প্রতিক্রিয়া যোগ করুন৷

আপনার ব্রাউজারের জন্য গণনা করা বিষয় দেখুন

ব্যবহারকারীরা chrome://topics-internals দেখে বর্তমান এবং পূর্ববর্তী যুগে তাদের ব্রাউজারের জন্য পর্যবেক্ষণ করা বিষয় সম্পর্কে তথ্য দেখতে পারেন।

টপিক স্টেট প্যানেল সহ chrome://topics-internals পৃষ্ঠা নির্বাচন করা হয়েছে।
chrome://topics-internals পেজ টপিক স্টেট প্যানেল টপিক আইডি, র্যান্ডম এবং রিয়েল টপিক অ্যাসাইনমেন্ট এবং ট্যাক্সোনমি এবং মডেল ভার্সন দেখায়।

এই স্ক্রিনশটটি দেখায় যে সম্প্রতি পরিদর্শন করা সাইটগুলিতে topics-demo-cats.glitch.me এবং cats-cats-cats-cats.glitch.me অন্তর্ভুক্ত রয়েছে। এটি বর্তমান যুগের জন্য দুটি শীর্ষ বিষয় হিসাবে Pets এবং Cats নির্বাচন করতে টপিক এপিআইকে কারণ করে। বাকি তিনটি বিষয় এলোমেলোভাবে বেছে নেওয়া হয়েছে, যেহেতু পাঁচটি বিষয় প্রদান করার জন্য পর্যাপ্ত ব্রাউজিং ইতিহাস (বিষয়গুলি পর্যবেক্ষণ করে এমন সাইটগুলিতে) নেই৷

অবজারভড-বাই কনটেক্সট ডোমেন (হ্যাশড) কলাম একটি হোস্টনামের হ্যাশড মান প্রদান করে যার জন্য একটি বিষয় পর্যবেক্ষণ করা হয়েছে।

হোস্টনামের জন্য অনুমান করা বিষয়গুলি দেখুন

আপনি chrome://topics-internals এ এক বা একাধিক হোস্টনামের জন্য টপিক ক্লাসিফায়ার মডেল দ্বারা অনুমান করা বিষয়গুলিও দেখতে পারেন।

ক্লাসিফায়ার প্যানেল সহ chrome://topics-internals পৃষ্ঠা নির্বাচন করা হয়েছে৷
chrome://topics-internals পৃষ্ঠা ক্লাসিফায়ার প্যানেল নির্বাচিত বিষয়, হোস্ট পরিদর্শন করা এবং মডেল সংস্করণ এবং পথ দেখায়।

টপিক এপিআই-এর বর্তমান বাস্তবায়ন শুধুমাত্র হোস্টনাম থেকে বিষয়গুলিকে অনুমান করে; URL এর অন্য কোনো অংশ থেকে নয়।

chrome://topics-internals Classifier থেকে অনুমান করা বিষয়গুলি দেখতে শুধুমাত্র হোস্টনাম ব্যবহার করুন (প্রটোকল বা পথ ছাড়া)। আপনি হোস্ট ক্ষেত্রে একটি "/" অন্তর্ভুক্ত করার চেষ্টা করলে chrome://topics-internals একটি ত্রুটি প্রদর্শন করবে৷

বিষয় API তথ্য দেখুন

আপনি chrome://topics-internals এ টেক্সোনমি সংস্করণ এবং যুগের সময়কালের মতো বিষয় API বাস্তবায়ন এবং সেটিংস সম্পর্কে তথ্য পেতে পারেন। এই মানগুলি এপিআই বা কমান্ড লাইন থেকে সফলভাবে সেট করা পরামিতিগুলির জন্য ডিফল্ট সেটিংস প্রতিফলিত করে। কমান্ড লাইন পতাকাগুলি প্রত্যাশিত হিসাবে কাজ করেছে তা নিশ্চিত করতে এটি সহায়ক হতে পারে।

উদাহরণে, time_period_per_epoch 15 সেকেন্ডে সেট করা হয়েছে (ডিফল্ট হল সাত দিন)।

chrome://topics-internals পৃষ্ঠা সহ বৈশিষ্ট্য এবং প্যারামিটার প্যানেল নির্বাচন করা হয়েছে৷
chrome://topics-internals বৈশিষ্ট্য এবং পরামিতি প্যানেল সক্ষম বৈশিষ্ট্য, প্রতি যুগে সময়, বিষয় গণনা করতে ব্যবহার করার জন্য যুগের সংখ্যা, শ্রেণিবিন্যাস সংস্করণ এবং অন্যান্য সেটিংস দেখায়।

স্ক্রিনশটে দেখানো প্যারামিটারগুলি ফ্ল্যাগের সাথে মিলে যায় যা কমান্ড লাইন থেকে Chrome চালানোর সময় সেট করা যেতে পারে। উদাহরণস্বরূপ, topic-fetch-demo.glitch.me- এর ডেমো নিম্নলিখিত ফ্ল্যাগগুলি ব্যবহার করার পরামর্শ দেয়:

--enable-features=BrowsingTopics,BrowsingTopicsParameters:time_period_per_epoch/15s/max_epoch_introduction_delay/3s,PrivacySandboxAdsAPIsOverride,PrivacySandboxSettings3,OverridePrivacySandboxSettingsLocalTesting

নিম্নলিখিত তালিকা প্রতিটি পরামিতি, এর ডিফল্ট মান এবং এর উদ্দেশ্য ব্যাখ্যা করে।

ক্রোম পতাকা

BrowsingTopics
ডিফল্ট মান: সক্রিয়
বিষয় API সক্ষম করা আছে কিনা।

PrivacySandboxAdsAPIsOverride
ডিফল্ট মান: সক্রিয়
বিজ্ঞাপন API সক্ষম করে: অ্যাট্রিবিউশন রিপোর্টিং, সুরক্ষিত দর্শক, বিষয়, বেড়াযুক্ত ফ্রেম।

PrivacySandboxSettings4
ডিফল্ট মান: নিষ্ক্রিয়
গোপনীয়তা স্যান্ডবক্স UI সেটিংসের চতুর্থ রিলিজ সক্ষম করে৷

OverridePrivacySandboxSettingsLocalTesting
ডিফল্ট মান: সক্রিয়
সক্ষম হলে, গোপনীয়তা স্যান্ডবক্স বৈশিষ্ট্যগুলি সক্ষম করার জন্য ব্রাউজারটির আর অন্তর্নিহিত সেটিংস সক্ষম করার প্রয়োজন নেই৷

BrowsingTopicsBypassIPIsPubliclyRoutableCheck
ডিফল্ট মান: নিষ্ক্রিয়
যদি সক্রিয় করা থাকে, তাহলে আইপি ঠিকানাটি সর্বজনীনভাবে রাউটেবল কিনা তা পরীক্ষা করে বাইপাস করা হবে যখন বিষয় গণনায় অন্তর্ভুক্ত করার জন্য একটি পৃষ্ঠার যোগ্যতা নির্ধারণ করা হবে৷

BrowsingTopics:number_of_epochs_to_expose
ডিফল্ট মান: 3
একটি অনুরোধের প্রেক্ষাপটে যে বিষয়গুলি গণনা করতে হবে সেখান থেকে যুগের সংখ্যা৷ ব্রাউজারটি অভ্যন্তরীণভাবে N+1 যুগ পর্যন্ত বজায় রাখবে।

BrowsingTopics:time_period_per_epoch
ডিফল্ট মান: 7d-0h-0m-0s
প্রতিটি যুগের সময়কাল। ডিবাগিংয়ের জন্য, ডিফল্ট সাত দিনের পরিবর্তে এটিকে (বলুন) 15 সেকেন্ডে সেট করা কার্যকর হতে পারে।

BrowsingTopics:number_of_top_topics_per_epoch
ডিফল্ট মান: 5
প্রতি যুগে গণনা করা বিষয়ের সংখ্যা।

BrowsingTopics:use_random_topic_probability_percent
ডিফল্ট মান: 5
সম্ভাব্যতা যে একটি যুগের মধ্যে একটি পৃথক বিষয় বিষয়গুলির সম্পূর্ণ শ্রেণীবিন্যাস থেকে এলোমেলোভাবে ফিরে আসে। এলোমেলোতা একটি যুগ এবং সাইটে আঠালো.

BrowsingTopics:number_of_epochs_of_observation_data_to_use_for_filtering
ডিফল্ট মান: 3
একটি কলিং প্রসঙ্গের জন্য বিষয়গুলি ফিল্টার করার জন্য API ব্যবহারের ডেটার কতগুলি যুগ (অর্থাৎ বিষয় পর্যবেক্ষণ) ব্যবহার করা হবে৷

BrowsingTopics:max_number_of_api_usage_context_domains_to_keep_per_topic
ডিফল্ট মান: 1000
প্রতিটি শীর্ষ বিষয়ের জন্য রাখা প্রসঙ্গ ডোমেনের দ্বারা পর্যবেক্ষণ করা সর্বাধিক সংখ্যা৷ উদ্দেশ্য ব্যবহার করা মেমরি ক্যাপ করা হয়.

BrowsingTopics:max_number_of_api_usage_context_entries_to_load_per_epoch
ডিফল্ট মান: 100000
API ব্যবহারের প্রসঙ্গগুলির জন্য প্রতিটি প্রশ্নের জন্য ডাটাবেস থেকে পুনরুদ্ধারের জন্য অনুমোদিত সর্বোচ্চ সংখ্যক এন্ট্রি। বিষয় গণনার সময় প্রতি যুগে একবার প্রশ্নটি ঘটবে। উদ্দেশ্য পিক মেমরি ব্যবহার ক্যাপ করা হয়.

BrowsingTopics:max_number_of_api_usage_context_domains_to_store_per_page_load
ডিফল্ট মান: 30
প্রতি পৃষ্ঠা লোডের জন্য সর্বাধিক সংখ্যক API ব্যবহারের প্রসঙ্গ ডোমেন সংরক্ষণ করার অনুমতি রয়েছে৷

BrowsingTopics:config_version
ডিফল্ট মান: 1
বিষয় API কনফিগারেশন পরামিতি এনকোড করে। প্রতিটি সংস্করণ নম্বর শুধুমাত্র একটি কনফিগারেশন সেটে ম্যাপ করা উচিত। config_version আপডেট না করে কনফিগারেশন প্যারামিটারগুলি আপডেট করা সাধারণত স্থানীয় পরীক্ষার জন্য ঠিক হওয়া উচিত, তবে কিছু পরিস্থিতিতে ব্রাউজারটিকে একটি অসামঞ্জস্যপূর্ণ অবস্থায় ছেড়ে যেতে পারে এবং এর ফলে একটি ব্রাউজার ক্র্যাশ হতে পারে, উদাহরণস্বরূপ number_of_top_topics_per_epoch আপডেট করা।

BrowsingTopics:taxonomy_version
ডিফল্ট মান: 1
API দ্বারা ব্যবহৃত শ্রেণীবিন্যাস সংস্করণ।

আপনার সাইট অপ্ট আউট করুন

আপনি Permissions-Policy: browsing-topics=() অনুমতি-নীতি শিরোনাম একটি পৃষ্ঠায় শুধুমাত্র সেই পৃষ্ঠার সমস্ত ব্যবহারকারীদের জন্য বিষয় গণনা প্রতিরোধ করতে৷ আপনার সাইটের অন্যান্য পৃষ্ঠাগুলিতে পরবর্তী পরিদর্শন প্রভাবিত হবে না: আপনি যদি একটি পৃষ্ঠায় বিষয় API ব্লক করার জন্য একটি নীতি সেট করেন, তাহলে এটি অন্য পৃষ্ঠাগুলিকে প্রভাবিত করবে না।

এছাড়াও আপনি বিষয় API-এ তৃতীয় পক্ষের অ্যাক্সেস নিয়ন্ত্রণ করতে Permissions-Policy শিরোনাম ব্যবহার করে আপনার পৃষ্ঠায় কোন তৃতীয় পক্ষের বিষয়গুলিতে অ্যাক্সেস আছে তা নিয়ন্ত্রণ করতে পারেন। হেডারের পরামিতি হিসাবে, self এবং যেকোনো ডোমেন ব্যবহার করুন যা আপনি API-তে অ্যাক্সেসের অনুমতি দিতে চান। উদাহরণস্বরূপ, আপনার নিজস্ব উত্স এবং https://example.com ব্যতীত সমস্ত ব্রাউজিং প্রসঙ্গে টপিক API-এর ব্যবহার সম্পূর্ণরূপে অক্ষম করতে, নিম্নলিখিত HTTP প্রতিক্রিয়া শিরোনামটি সেট করুন: 

Permissions-Policy: browsing-topics=(self "https://example.com")

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

আরও জানুন

জড়িত এবং মতামত শেয়ার করুন