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