এই নথিটি আপনাকে কাস্টম অনুসন্ধান JSON API এবং এর ব্যবহার সম্পর্কে পরিচিত হতে সাহায্য করবে৷
শুরু করার আগে
প্রোগ্রামেবল সার্চ ইঞ্জিন তৈরি করুন
API ব্যবহারকারীকে কল করার মাধ্যমে প্রোগ্রামেবল সার্চ ইঞ্জিনের একটি বিদ্যমান উদাহরণের বিরুদ্ধে অনুরোধগুলি ইস্যু করে৷ অতএব, API ব্যবহার করার আগে, আপনাকে কন্ট্রোল প্যানেলে একটি তৈরি করতে হবে। বিভিন্ন কনফিগারেশন বিকল্প সম্পর্কে আরও জানতে টিউটোরিয়ালটি অনুসরণ করুন। এটি তৈরি হয়ে গেলে, আপনি ওভারভিউ পৃষ্ঠার বেসিক বিভাগে সার্চ ইঞ্জিন আইডি খুঁজে পেতে পারেন। এটি API দ্বারা ব্যবহৃত cx
প্যারামিটার।
API কী দিয়ে Google-এ আপনার আবেদন শনাক্ত করুন
কাস্টম অনুসন্ধান JSON API-এর জন্য একটি API কী ব্যবহার করা প্রয়োজন। একটি API কী হল আপনার ক্লায়েন্টকে Google-এ শনাক্ত করার একটি উপায়।
- প্রোগ্রামেবল সার্চ ইঞ্জিন (ফ্রি সংস্করণ) ব্যবহারকারী: একটি কী পান
আপনার কাছে একটি API কী থাকার পরে, আপনার অ্যাপ্লিকেশনটি সমস্ত অনুরোধের URL-এ ক্যোয়ারী প্যারামিটার key=yourAPIKey
যোগ করতে পারে। API কী URL এ এম্বেড করার জন্য নিরাপদ, এটির কোনো এনকোডিংয়ের প্রয়োজন নেই।
API ওভারভিউ
API অপারেশন
কাস্টম সার্চ JSON API এ আহ্বান করার জন্য শুধুমাত্র একটি পদ্ধতি আছে:
অপারেশন | বর্ণনা | REST HTTP ম্যাপিং |
---|---|---|
তালিকা | একটি প্রোগ্রামেবল সার্চ ইঞ্জিন থেকে অনুরোধ করা অনুসন্ধান ফলাফল ফেরত দেয়। | GET |
API ডেটা মডেল
কাস্টম সার্চ JSON API-এ একটি অনুসন্ধান ক্যোয়ারির ফলাফল হল একটি JSON অবজেক্ট যাতে তিন ধরনের ডেটা অন্তর্ভুক্ত থাকে:
- অনুরোধ করা অনুসন্ধানের বর্ণনাকারী মেটাডেটা (এবং, সম্ভবত, সম্পর্কিত অনুসন্ধান অনুরোধ)
- মেটাডেটা প্রোগ্রামেবল সার্চ ইঞ্জিন বর্ণনা করে
- অনুসন্ধান ফলাফল
আরও বিশদ বিবরণের জন্য REST ব্যবহার করার প্রতিক্রিয়া ডেটা বিভাগটি দেখুন।
ডেটা মডেলটি OpenSearch 1.1 স্পেসিফিকেশনের উপর ভিত্তি করে তৈরি। স্ট্যান্ডার্ড OpenSearch বৈশিষ্ট্য ছাড়াও, কাস্টম অনুসন্ধান JSON API দুটি কাস্টম বৈশিষ্ট্য এবং দুটি কাস্টম ক্যোয়ারী ভূমিকা সংজ্ঞায়িত করে:
- কাস্টম বৈশিষ্ট্য
-
cx
: প্রোগ্রামেবল সার্চ ইঞ্জিনের শনাক্তকারী। -
safe
: ফিরে আসা ফলাফলগুলি ফিল্টার করার জন্য নিরাপদ অনুসন্ধান স্তরের একটি বিবরণ।
-
- কাস্টম ক্যোয়ারী ভূমিকা
-
nextPage
: একটি ভূমিকা যা কোয়েরি নির্দেশ করে ফলাফলের পরবর্তী যৌক্তিক পৃষ্ঠায় অ্যাক্সেস করতে ব্যবহার করা যেতে পারে, যদি থাকে। -
previousPage
: একটি ভূমিকা যা কোয়েরি নির্দেশ করে ফলাফলের পূর্ববর্তী যৌক্তিক পৃষ্ঠায় অ্যাক্সেস করতে ব্যবহার করা যেতে পারে, যদি থাকে।
-
চেষ্টা করে দেখুন
আশেপাশে খেলতে এবং API কী করতে পারে তা দেখতে, কোনো কোড না লিখে, "এই API ব্যবহার করে দেখুন" টুলটিতে যান।
প্যারামিটারের সম্পূর্ণ বিবরণের জন্য cse.list রেফারেন্স দেখুন।
HTTP অনুরোধের মাধ্যমে API কীভাবে ব্যবহার করবেন তা শিখতে, REST ব্যবহার চালিয়ে যান।