API চালু করতে REST ব্যবহার করে

এই ডকুমেন্টটি বর্ণনা করে কিভাবে কাস্টম সার্চ JSON API ব্যবহার করতে হয়।

একটি অনুরোধ করা

কাস্টম অনুসন্ধান JSON API-এ REST, বা প্রতিনিধিত্বমূলক রাজ্য স্থানান্তর প্রথাগত REST থেকে কিছুটা আলাদা। সংস্থানগুলিতে অ্যাক্সেস দেওয়ার পরিবর্তে, API একটি পরিষেবাতে অ্যাক্সেস সরবরাহ করে। ফলস্বরূপ, API একটি একক URI প্রদান করে যা পরিষেবার শেষ পয়েন্ট হিসাবে কাজ করে।

আপনি একটি নির্দিষ্ট অনুসন্ধানের জন্য ফলাফল পুনরুদ্ধার করতে পারেন এর URI-তে একটি HTTP GET অনুরোধ পাঠিয়ে৷ আপনি ক্যোয়ারী প্যারামিটার হিসাবে অনুসন্ধান অনুরোধের বিশদ বিবরণ পাস করুন৷ কাস্টম অনুসন্ধান JSON API URI-এর বিন্যাস হল:

https://www.googleapis.com/customsearch/v1?[parameters]

প্রতিটি অনুসন্ধান অনুরোধের সাথে তিনটি ক্যোয়ারী [parameters] প্রয়োজন:

  • API কী - আপনার অ্যাপ্লিকেশন সনাক্ত করতে key ক্যোয়ারী প্যারামিটার ব্যবহার করুন।

  • প্রোগ্রামেবল সার্চ ইঞ্জিন আইডি - এই অনুসন্ধানটি সম্পাদন করতে আপনি যে প্রোগ্রামেবল সার্চ ইঞ্জিন ব্যবহার করতে চান তা নির্দিষ্ট করতে cx ব্যবহার করুন। সার্চ ইঞ্জিন অবশ্যই কন্ট্রোল প্যানেল দিয়ে তৈরি করতে হবে নোট: সার্চ ইঞ্জিন আইডি (cx) বিভিন্ন ফরম্যাটের হতে পারে (যেমন 8ac1ab64606d234f1)

  • অনুসন্ধান ক্যোয়ারী - আপনার অনুসন্ধান অভিব্যক্তি নির্দিষ্ট করতে q ক্যোয়ারী প্যারামিটার ব্যবহার করুন।

অন্যান্য সব ক্যোয়ারী পরামিতি ঐচ্ছিক.

এখানে একটি অনুরোধের একটি উদাহরণ রয়েছে যা লেকচারের জন্য একটি পরীক্ষা প্রোগ্রামেবল সার্চ ইঞ্জিন অনুসন্ধান করে:

GET https://www.googleapis.com/customsearch/v1?key=INSERT_YOUR_API_KEY&cx=017576662512468239146:omuauf_lfve&q=lectures

ক্যোয়ারী প্যারামিটার

দুটি ধরণের পরামিতি রয়েছে যা আপনি আপনার অনুরোধে পাস করতে পারেন:

  • API-নির্দিষ্ট পরামিতি - আপনার অনুসন্ধানের বৈশিষ্ট্যগুলি সংজ্ঞায়িত করুন, যেমন অনুসন্ধানের অভিব্যক্তি, ফলাফলের সংখ্যা, ভাষা ইত্যাদি।
  • স্ট্যান্ডার্ড ক্যোয়ারী প্যারামিটার - আপনার অনুরোধের প্রযুক্তিগত দিকগুলি নির্ধারণ করুন, যেমন API কী।

সমস্ত প্যারামিটার মান URL এনকোড করা প্রয়োজন.

API-নির্দিষ্ট ক্যোয়ারী প্যারামিটার

অনুরোধের পরামিতিগুলি যা কাস্টম অনুসন্ধান JSON API-তে বিশেষভাবে প্রযোজ্য এবং আপনার অনুসন্ধান অনুরোধকে সংজ্ঞায়িত করে রেফারেন্সে সংক্ষিপ্ত করা হয়েছে।

স্ট্যান্ডার্ড ক্যোয়ারী প্যারামিটার

সমস্ত কাস্টম অনুসন্ধান JSON API অপারেশনগুলিতে প্রযোজ্য কোয়েরি প্যারামিটারগুলি সিস্টেম প্যারামিটারে নথিভুক্ত করা হয়।

প্রতিক্রিয়া তথ্য

অনুরোধ সফল হলে, সার্ভার একটি 200 OK HTTP স্ট্যাটাস কোড এবং JSON ফর্ম্যাটে প্রতিক্রিয়া ডেটা দিয়ে প্রতিক্রিয়া জানায়। আপনি রেফারেন্সে প্রতিক্রিয়া ডেটা কাঠামো দেখতে পারেন।

প্রতিক্রিয়া ডেটা একটি JSON অবজেক্ট যা তিন ধরনের বৈশিষ্ট্য অন্তর্ভুক্ত করে:

  • অনুরোধ করা অনুসন্ধানের বর্ণনাকারী মেটাডেটা (এবং, সম্ভবত, সম্পর্কিত অনুসন্ধান অনুরোধ)
  • মেটাডেটা প্রোগ্রামেবল সার্চ ইঞ্জিন বর্ণনা করে
  • অনুসন্ধান ফলাফল

প্রতিটি সম্পত্তির বিস্তারিত বিবরণের জন্য, রেফারেন্স দেখুন।

অনুসন্ধান অনুরোধ মেটাডেটা

অনুসন্ধান মেটাডেটা অন্তর্ভুক্ত:

  • url সম্পত্তি, যাতে এই অনুরোধে ফিরে আসা ফলাফলের জন্য ব্যবহৃত OpenSearch টেমপ্লেট সম্পর্কে তথ্য রয়েছে।
  • queries প্রোপার্টি, যা সম্ভাব্য অনুসন্ধানের বৈশিষ্ট্য বর্ণনাকারী বস্তুর একটি বিন্যাস। অ্যারের প্রতিটি বস্তুর নাম হয় একটি OpenSearch ক্যোয়ারী ভূমিকার নাম অথবা এই API দ্বারা সংজ্ঞায়িত দুটি কাস্টম ভূমিকার একটি: previousPage এবং nextPage । সম্ভাব্য ক্যোয়ারী ভূমিকা অবজেক্ট অন্তর্ভুক্ত:
    • request : মেটাডেটা ফলাফলের বর্তমান সেটের জন্য ক্যোয়ারী বর্ণনা করে।
      • এই ভূমিকা সবসময় প্রতিক্রিয়া উপস্থিত হয়.
      • এটা সবসময় শুধু একটি উপাদান সঙ্গে একটি অ্যারে.
      • nextPage : ফলাফলের পরবর্তী পৃষ্ঠার জন্য ব্যবহার করার জন্য ক্যোয়ারী বর্ণনা করে মেটাডেটা।
        • বর্তমান ফলাফল শেষ পৃষ্ঠা হলে এই ভূমিকা উপস্থিত হয় না। দ্রষ্টব্য: এই API শুধুমাত্র প্রথম 100টি ফলাফল পর্যন্ত প্রদান করে।
        • যখন উপস্থিত থাকে, এটি সর্বদা একটি অ্যারে থাকে শুধুমাত্র একটি উপাদান সহ।
    • previousPage : ফলাফলের পূর্ববর্তী পৃষ্ঠার জন্য ব্যবহার করার জন্য ক্যোয়ারী বর্ণনা করে মেটাডেটা।
      • বর্তমান ফলাফল প্রথম পাতা হলে উপস্থিত না.
      • যখন উপস্থিত থাকে, এটি সর্বদা একটি অ্যারে থাকে শুধুমাত্র একটি উপাদান সহ।

সার্চ ইঞ্জিন মেটাডেটা

context সম্পত্তির মেটাডেটা আছে সার্চ ইঞ্জিনের বর্ণনা করে যেটি সার্চ কোয়েরিটি করেছে। এতে সার্চ ইঞ্জিনের নাম এবং সার্চকে পরিমার্জিত করার জন্য এটি প্রদান করে এমন যেকোনো দিক বস্তু অন্তর্ভুক্ত করে।

অনুসন্ধান ফলাফল

items অ্যারে প্রকৃত অনুসন্ধান ফলাফল ধারণ করে. অনুসন্ধানের ফলাফলে URL, শিরোনাম এবং টেক্সট স্নিপেট অন্তর্ভুক্ত থাকে যা ফলাফল বর্ণনা করে। উপরন্তু, তারা সমৃদ্ধ স্নিপেট তথ্য থাকতে পারে, যদি প্রযোজ্য হয়।

যদি অনুসন্ধানের ফলাফলে একটি promotions সম্পত্তি অন্তর্ভুক্ত থাকে তবে এতে প্রচারগুলির একটি সেট রয়েছে৷

জাভাস্ক্রিপ্ট থেকে REST

আপনি জাভাস্ক্রিপ্ট থেকে REST ব্যবহার করে কাস্টম সার্চ JSON API চালু করতে পারেন, callback ক্যোয়ারী প্যারামিটার এবং একটি কলব্যাক ফাংশন ব্যবহার করে। এটি আপনাকে সমৃদ্ধ অ্যাপ্লিকেশন লিখতে দেয় যা কোনো সার্ভার সাইড কোড না লিখেই প্রোগ্রামেবল সার্চ ইঞ্জিন ডেটা প্রদর্শন করে।

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

<html>
  <head>
    <title>Custom Search JSON API Example</title>
  </head>
  <body>
    <div id="content"></div>
    <script>
      function hndlr(response) {
      for (var i = 0; i < response.items.length; i++) {
        var item = response.items[i];
        // Make sure HTML in item.htmlTitle is escaped.
        document.getElementById("content").append(
          document.createElement("br"),
          document.createTextNode(item.htmlTitle)
        );
      }
    }
    </script>
    <script src="https://www.googleapis.com/customsearch/v1?key=YOUR-KEY&cx=017576662512468239146:omuauf_lfve&q=cars&callback=hndlr">
    </script>
  </body>
</html>