API (एपीआई) का इस्तेमाल करना

कॉन्टेंट

  1. शुरुआती बात
    1. पुष्टि करना और अनुमति देना
    2. Google Books के आईडी
    3. उपयोगकर्ता की जगह की जानकारी सेट करना
  2. आवाज़ के साथ काम करना
    1. खोज करना
    2. खास वॉल्यूम वापस पाना
  3. किताब की अलमारी से काम करना
    1. उपयोगकर्ता की सार्वजनिक शेल्फ़ की सूची वापस पाना
    2. किसी खास सार्वजनिक अलमारी को वापस लाना
    3. सार्वजनिक किताबों की सूची के लिए, वॉल्यूम की सूची फ़ेच की जा रही है
  4. बुकबुक में शेल्फ़ पर काम करना; मेरी लाइब्रेरी"
    1. अपने किताबों की शेल्फ़ वापस पाना
    2. बुकबुक की संख्या के हिसाब से सूची फ़ेच की जा रही है
    3. बुकबुक में वॉल्यूम जोड़ना
    4. बुकबुक से आवाज़ कम करना
    5. बुकबुक से सभी वॉल्यूम हटाना
  5. क्वेरी पैरामीटर का रेफ़रंस
    1. स्टैंडर्ड क्वेरी पैरामीटर
    2. एपीआई के हिसाब से क्वेरी पैरामीटर

सुविधा के बारे में जानकारी

यह दस्तावेज़ उन डेवलपर के लिए है जो Books ऐप्लिकेशन के साथ इंटरैक्ट करने वाले ऐप्लिकेशन लिखना चाहते हैं. Google Books का मिशन दुनिया भर की किताबों को डिजिटल बनाने और उन्हें वेब पर ज़्यादा आसानी से उपलब्ध कराने का है. Books API पर उस कॉन्टेंट को खोजने और उसे ऐक्सेस करने के साथ-साथ उस कॉन्टेंट को अपने हिसाब से बनाया जा सकता है.

अगर आप Google Books के सिद्धांतों के बारे में नहीं जानते, तो आपको कोड शुरू करने से पहले, शुरू करने का तरीका पढ़ना चाहिए.

अनुरोधों को अनुमति देना और आपके ऐप्लिकेशन की पहचान करना

आपका ऐप्लिकेशन, Books API को जो भी अनुरोध भेजता है उसमें Google को आपके ऐप्लिकेशन की पहचान करनी होगी. अपने ऐप्लिकेशन को पहचानने के दो तरीके हैं: OAuth 2.0 टोकन का इस्तेमाल करना (जो अनुरोध को मंज़ूरी भी देता है) और/या ऐप्लिकेशन की एपीआई कुंजी का इस्तेमाल करना. इनमें से किस विकल्प का इस्तेमाल करना है, यह तय करने के लिए यहां दिया गया तरीका अपनाएं:

  • अगर अनुरोध के लिए अनुमति की ज़रूरत होती है, जैसे कि किसी व्यक्ति के निजी डेटा के लिए अनुरोध, तो ऐप्लिकेशन को अनुरोध के साथ OAuth 2.0 टोकन देना होगा. इस ऐप्लिकेशन में एपीआई कुंजी भी दी जा सकती है, लेकिन ज़रूरी नहीं है.
  • अगर अनुरोध के लिए अनुमति की ज़रूरत नहीं होती (जैसे कि सार्वजनिक डेटा के लिए अनुरोध), तो ऐप्लिकेशन को एपीआई कुंजी या OAuth 2.0 टोकन या दोनों उपलब्ध कराना चाहिए—दोनों में से जो भी विकल्प आपके लिए सबसे आसान हो.

अनुमति देने के प्रोटोकॉल के बारे में जानकारी

अनुरोधों को अनुमति देने के लिए, आपके ऐप्लिकेशन में OAuth 2.0 का इस्तेमाल किया जाना चाहिए. अनुमति देने वाले दूसरे प्रोटोकॉल इस्तेमाल नहीं किए जा सकते. अगर आपका ऐप्लिकेशन Google से साइन इन करने की सुविधा इस्तेमाल करता है, तो अनुमति देने से जुड़े कुछ पहलुओं को Google आपके लिए खुद मैनेज करता है.

OAuth 2.0 से अनुरोधों को अनुमति देना

गैर-सार्वजनिक उपयोगकर्ता डेटा के लिए Books API के अनुरोधों को किसी पुष्टि किए गए उपयोगकर्ता से अनुमति मिली होनी चाहिए.

OAuth 2.0 के लिए अनुमति देने की प्रक्रिया या "तरीका" अलग-अलग हो सकता है. यह इस बात पर निर्भर करता है कि ऐप्लिकेशन किस तरह का है. सभी तरह के ऐप्लिकेशन के लिए नीचे दी गई सामान्य प्रक्रिया लागू होती है:

  1. ऐप्लिकेशन बनाने के बाद, उसे Google API (एपीआई) कंसोल का इस्तेमाल करके, रजिस्टर किया जाता है. इसके बाद, Google आपको क्लाइंट आईडी और क्लाइंट सीक्रेट जैसी जानकारी देगा. इस जानकारी की ज़रूरत आपको बाद में पड़ेगी.
  2. Google API (एपीआई) कंसोल में Books API को चालू करें. (अगर एपीआई को 'API कंसोल' की सूची में नहीं जोड़ा गया है, तो यह चरण छोड़ दें.)
  3. जब आपके ऐप्लिकेशन को उपयोगकर्ता के डेटा को ऐक्सेस करने की ज़रूरत होती है, तब वह Google से, डेटा के खास लिंक का अनुरोध करता है.
  4. Google, उपयोगकर्ता को सहमति वाली स्क्रीन दिखाता है, जिसमें उनसे आपके ऐप्लिकेशन को उनके कुछ डेटा को ऐक्सेस करने की अनुमति मांगी जाती है.
  5. अगर उपयोगकर्ता इसकी अनुमति दे देता है, तो Google आपके ऐप्लिकेशन को कुछ समय के लिए इस्तेमाल किए जा सकने वाला ऐक्सेस टोकन देता है.
  6. आपका ऐप्लिकेशन, ऐक्सेस टोकन से उपयोगकर्ता के डेटा को ऐक्सेस करने का अनुरोध करता है.
  7. अगर Google को पता चलता है कि आपका अनुरोध और टोकन मान्य है, तो वह आपके ऐप्लिकेशन को अनुरोध किए गए डेटा का ऐक्सेस दे देता है.

कुछ तरीकों में दूसरे चरण भी शामिल हो सकते हैं, जैसे कि रिफ़्रेश टोकन इस्तेमाल करके, नया ऐक्सेस टोकन पाना. अलग-अलग तरह के ऐप्लिकेशन के लिए डेटा ऐक्सेस करने के तरीकों के बारे में ज़्यादा जानकारी पाने के लिए, Google का OAuth 2.0 दस्तावेज़ पढ़ें.

यहां Books API के लिए, OAuth 2.0 के दायरे की जानकारी दी गई है:

https://www.googleapis.com/auth/books

OAuth 2.0 का इस्तेमाल करके, डेटा ऐक्सेस करने का अनुरोध करने के लिए, आपके ऐप्लिकेशन को अनुरोध के तरीके की जानकारी देनी होगी. साथ ही, वह जानकारी भी देनी होगी जो आपको ऐप्लिकेशन रजिस्टर करते समय, Google से मिली थी, जैसे कि क्लाइंट आईडी और क्लाइंट सीक्रेट.

सलाह: Google API की क्लाइंट लाइब्रेरी आपके लिए अनुमति देने की कुछ प्रक्रियाएं खुद कर सकती है. ये लाइब्रेरी कई प्रोग्रामिंग भाषाओं के लिए उपलब्ध होती हैं. ज़्यादा जानकारी के लिए लाइब्रेरी और नमूनों वाला पेज देखें.

एपीआई कुंजी को हासिल करना और उसका इस्तेमाल करना

सार्वजनिक डेटा के लिए Books API के अनुरोधों के साथ, एक आइडेंटिफ़ायर शामिल होना चाहिए. यह एपीआई कुंजी या ऐक्सेस टोकन हो सकता है.

एपीआई कुंजी पाने के लिए:

  1. एपीआई कंसोल में क्रेडेंशियल पेज खोलें.
  2. यह एपीआई दो तरह के क्रेडेंशियल के साथ काम करता है. अपने प्रोजेक्ट के लिए सही क्रेडेंशियल बनाएं:
    • OAuth 2.0: जब भी आपका ऐप्लिकेशन निजी उपयोगकर्ता के डेटा का अनुरोध करता है, तब उसे अनुरोध के साथ OAuth 2.0 टोकन भेजना चाहिए. आपका ऐप्लिकेशन सबसे पहले क्लाइंट आईडी भेजता है और क्लाइंट-साइड टोकन बनाता है. वेब ऐप्लिकेशन, सेवा खातों या इंस्टॉल किए गए ऐप्लिकेशन के लिए, OAuth 2.0 क्रेडेंशियल जनरेट किया जा सकता है.

      ज़्यादा जानकारी के लिए, OAuth 2.0 दस्तावेज़ देखें.

    • एपीआई कुंजियां: ऐसे अनुरोध में जो एपीआई 2.0 का टोकन नहीं देते हैं, उन्हें एपीआई कुंजी भेजनी होगी. कुंजी आपके प्रोजेक्ट की पहचान करती है और एपीआई का ऐक्सेस, कोटा, और रिपोर्ट देती है.

      एपीआई कुंजियों पर कई तरह की पाबंदियां काम करती हैं. अगर आपको जिस एपीआई कुंजी की ज़रूरत है वह पहले से मौजूद नहीं है, तो क्रेडेंशियल बनाएं > एपीआई कुंजी पर क्लिक करके, कंसोल में एपीआई कुंजी बनाएं. कुंजी का इस्तेमाल करने से पहले, आप उसे प्रतिबंधित कर सकते हैं. ऐसा करने के लिए, आपको कुंजी मैनेज करें पर क्लिक करना होगा और पाबंदियां में से कोई एक चुनना होगा.

अपनी एपीआई कुंजियां सुरक्षित रखने के लिए, एपीआई कुंजियों का सुरक्षित तरीके से इस्तेमाल करने के सबसे सही तरीके अपनाएं.

एपीआई कुंजी मिलने के बाद, आपका ऐप्लिकेशन सभी अनुरोध यूआरएल के लिए, क्वेरी पैरामीटर key=yourAPIKey को जोड़ सकता है.

एपीआई कुंजी को यूआरएल में एम्बेड करना सुरक्षित है; इसे कोड में बदलने की ज़रूरत नहीं होती है.

Google Books के आईडी

आपको कुछ एपीआई मेथड कॉल के साथ आईडी फ़ील्ड की जानकारी देनी होगी. Google Books में आईडी के तीन टाइप इस्तेमाल किए जाते हैं:

  • आवाज़ आईडी - हर उस वॉल्यूम को दी गई खास स्ट्रिंग जिसके बारे में Google Books को पता है. वॉल्यूम आईडी का उदाहरण _LettPDhwR0C है. आप वॉल्यूम रिसॉर्स पाने का अनुरोध करके, वॉल्यूम आईडी पाने के लिए एपीआई का इस्तेमाल कर सकते हैं. आप वॉल्यूम आईडी, उसके id फ़ील्ड में देख सकते हैं.
  • किताबों की शेल्फ़ आईडी - उपयोगकर्ता की लाइब्रेरी में मौजूद किताबों की अलमारी को दिए गए अंक. Google हर उपयोगकर्ता के लिए, इन आईडी के साथ पहले से तय कुछ शेल्फ़ उपलब्ध कराता है:
    • पसंदीदा: 0
    • खरीदे गए: 1
    • पढ़ने के लिए: 2
    • अभी पढ़ा जा रहा है: 3
    • ये पढ़ें: 4
    • समीक्षा की गई: 5
    • हाल ही में देखे गए: 6
    • मेरी ई-बुक: 7
    • आपके लिए Books: 8 अगर हमारे पास उपयोगकर्ता के लिए कोई सुझाव नहीं है, तो यह शेल्फ़ मौजूद नहीं है.
    पसंद के मुताबिक बनाए गए शेल्फ़ में 1000 से ज़्यादा आईडी होते हैं. दिए गए उपयोगकर्ता के लिए, अलमारी का आईडी एक यूनीक आईडी होता है. इसका मतलब है कि दो उपयोगकर्ताओं के पास एक ही आईडी वाले किताबों की अलमारी हो सकती है, जिससे अलग-अलग किताबों की शेल्फ़ की जानकारी मिलती है. बुकशेल्फ़ आईडी पाने के लिए, एपीआई का इस्तेमाल किया जा सकता है. इसके लिए, आपको बुकशेल शेल्फ़ से मिलने वाले संसाधन की जानकारी दिखेगी. आपको इसके id फ़ील्ड में किताबों की सूची का आईडी मिल जाएगा.
  • यूज़र आईडी - हर उपयोगकर्ता को असाइन की गई यूनीक न्यूमेरिक वैल्यू. यह ज़रूरी नहीं है कि ये वैल्यू, Google की अन्य सेवाओं में इस्तेमाल की जाने वाली आईडी की वैल्यू हों. फ़िलहाल, User-ID को वापस पाने का सिर्फ़ एक तरीका है. इसे किताबों के शेल्फ़ वाले रिसॉर्स के सेल्फ़ लिंक से निकाला जाता है, जिसके लिए पुष्टि करने का अनुरोध किया जाता है. उपयोगकर्ता Books साइट से अपना उपयोगकर्ता आईडी भी पा सकते हैं. कोई उपयोगकर्ता, एपीआई या किताबों की साइट से किसी दूसरे उपयोगकर्ता का यूज़र आईडी नहीं पा सकता. उदाहरण के लिए, दूसरे उपयोगकर्ता को ईमेल से यह जानकारी साफ़ तौर पर शेयर करनी होगी.

Google Books की साइट पर आईडी

Books API के साथ जिस आईडी का इस्तेमाल किया जाता है वही आईडी Google Books साइट पर इस्तेमाल किए जाते हैं.

  • वॉल्यूम आईडी

    साइट पर किसी खास वॉल्यूम को देखते समय, आप id यूआरएल पैरामीटर में वॉल्यूम आईडी देख सकते हैं. यहां एक उदाहरण दिया गया है:

    https://books.google.com/ebooks?id=buc0AAAAMAAJ&dq=holmes&as_brr=4&source=webstore_bookcard

  • किताब का आईडी

    साइट पर कोई खास अलमारी देखते समय, आपको as_coll यूआरएल पैरामीटर में किताबों की सूची का आईडी मिल सकता है. यहां एक उदाहरण दिया गया है:

    https://books.google.com/books?hl=en&as_coll=0&num=10&uid=11122233344455566778&source=gbs_slider_cls_metadata_0_mylibrary

  • यूज़र आईडी

    साइट पर अपनी लाइब्रेरी देखते समय, uid यूआरएल पैरामीटर में User-ID देखी जा सकती है. यहां एक उदाहरण दिया गया है:

    https://books.google.com/books?uid=11122233344455566778&source=gbs_lp_bookshelf_list

उपयोगकर्ता की जगह सेट की जा रही है

Google Books, असली उपयोगकर्ता की जगह से जुड़े कॉपीराइट, समझौते, और अन्य कानूनी प्रतिबंधों का पालन करता है. इस वजह से, हो सकता है कि कुछ उपयोगकर्ता, कुछ देशों में उपलब्ध किताब के कॉन्टेंट को ऐक्सेस न कर पाएं. उदाहरण के लिए, कुछ किताबें सिर्फ़ अमेरिका में इस्तेमाल की जा सकती हैं और उनकी झलक देखी जा सकती है. साथ ही, हम दूसरे देशों के उपयोगकर्ताओं के लिए झलक के ऐसे लिंक नहीं दिखाते. इसलिए, आपके नतीजे आपके सर्वर या क्लाइंट ऐप्लिकेशन के आईपी पते के आधार पर प्रतिबंधित होते हैं.

आवाज़ के साथ काम करना

खोज करना

आप कुछ यूआरआई खोजने के लिए, इन यूआरआई के साथ एक एचटीटीपी GET अनुरोध भेज सकते हैं:

https://www.googleapis.com/books/v1/volumes?q=search+terms

इस अनुरोध में एक ज़रूरी पैरामीटर है:

  • q - उन वॉल्यूम को खोजें जिनमें यह टेक्स्ट स्ट्रिंग शामिल है. ऐसे कुछ खास कीवर्ड होते हैं जिन्हें आप किसी खास फ़ील्ड में खोजने के लिए, खोज के लिए इस्तेमाल होने वाले शब्दों में बता सकते हैं, जैसे:
    • intitle: वे नतीजे दिखाता है जिनमें इस कीवर्ड के बाद का टेक्स्ट, शीर्षक में मौजूद होता है.
    • inauthor: ऐसे नतीजे दिखाता है जिनमें इस कीवर्ड के बाद का टेक्स्ट, लेखक में मिला होता है.
    • inpublisher: ऐसे नतीजे दिखाता है जिनमें इस कीवर्ड के बाद आने वाला टेक्स्ट, पब्लिशर को मिलता है.
    • subject: ऐसे नतीजे दिखाता है जिनमें इस कीवर्ड के बाद दिया गया टेक्स्ट, वॉल्यूम की कैटगरी सूची में शामिल है.
    • isbn: ऐसे नतीजे दिखाता है जिनमें इस कीवर्ड के बाद मौजूद टेक्स्ट, ISBN नंबर होता है.
    • lccn: ऐसे नतीजे दिखाता है जिनमें इस कीवर्ड के बाद दिखने वाला टेक्स्ट, लाइब्रेरी कंट्रोल नंबर की लाइब्रेरी होता है.
    • oclc: ऐसे नतीजे दिखाता है जिनमें इस कीवर्ड के आगे मौजूद टेक्स्ट, ऑनलाइन कंप्यूटर लाइब्रेरी सेंटर नंबर होता है.

अनुरोध करें

यहां 'डैनियल कीज़' "Flowers for Algernon" को खोजने का उदाहरण दिया गया है:

GET https://www.googleapis.com/books/v1/volumes?q=flowers+inauthor:keyes&key=yourAPIKey

ध्यान दें: खोज करने के लिए पुष्टि करने की ज़रूरत नहीं होती है. इसलिए, आपको GET अनुरोध से Authorization एचटीटीपी हेडर नहीं देना होगा. हालांकि, अगर कॉल करने के लिए पुष्टि करने की सुविधा का इस्तेमाल किया जाता है, तो हर वॉल्यूम में उपयोगकर्ता की खास जानकारी शामिल होगी, जैसे कि खरीदारी की स्थिति.

जवाब

अगर अनुरोध पूरा हो जाता है, तो सर्वर 200 OK एचटीटीपी स्टेटस कोड और वॉल्यूम के नतीजों के साथ जवाब देता है:

200 OK

{
 "kind": "books#volumes",
 "items": [
  {
   "kind": "books#volume",
   "id": "_ojXNuzgHRcC",
   "etag": "OTD2tB19qn4",
   "selfLink": "https://www.googleapis.com/books/v1/volumes/_ojXNuzgHRcC",
   "volumeInfo": {
    "title": "Flowers",
    "authors": [
     "Vijaya Khisty Bodach"
    ],
   ...
  },
  {
   "kind": "books#volume",
   "id": "RJxWIQOvoZUC",
   "etag": "NsxMT6kCCVs",
   "selfLink": "https://www.googleapis.com/books/v1/volumes/RJxWIQOvoZUC",
   "volumeInfo": {
    "title": "Flowers",
    "authors": [
     "Gail Saunders-Smith"
    ],
    ...
  },
  {
   "kind": "books#volume",
   "id": "zaRoX10_UsMC",
   "etag": "pm1sLMgKfMA",
   "selfLink": "https://www.googleapis.com/books/v1/volumes/zaRoX10_UsMC",
   "volumeInfo": {
    "title": "Flowers",
    "authors": [
     "Paul McEvoy"
    ],
    ...
  },
  "totalItems": 3
}

वैकल्पिक क्वेरी पैरामीटर

आवाज़ की खोज करते समय, स्टैंडर्ड क्वेरी पैरामीटर के अलावा, नीचे दिए गए क्वेरी पैरामीटर का भी इस्तेमाल किया जा सकता है.

फ़ॉर्मैट डाउनलोड करें

आप download पैरामीटर का इस्तेमाल करके, लौटाए गए नतीजों को उन वॉल्यूम तक सीमित कर सकते हैं जिनका epubडाउनलोड फ़ॉर्मैट उपलब्ध है. इसके लिए, वैल्यू को epub पर सेट करें.

नीचे दिए गए उदाहरण में, epub डाउनलोड वाली किताबें उपलब्ध हैं:

GET https://www.googleapis.com/books/v1/volumes?q=pride+prejudice&download=epub&key=yourAPIKey
फ़िल्टर करना

आप filter पैरामीटर का इस्तेमाल करके, नीचे दिए गए किसी एक मान पर सेट करके, नतीजों को और ज़्यादा सीमित कर सकते हैं:

  • partial - ऐसे नतीजे दिखाता है जिनमें टेक्स्ट के कम से कम कुछ हिस्से की झलक दिखाई जा सकती है.
  • full - सिर्फ़ ऐसे नतीजे दिखाता है जिनमें पूरा टेक्स्ट दिखता है.
  • free-ebooks - सिर्फ़ ऐसे नतीजे दिखाता है जो मुफ़्त Google ई-बुक हैं.
  • paid-ebooks - सिर्फ़ वे नतीजे दिखाता है जो Google ई-बुक की कीमत में हैं.
  • ebooks - सिर्फ़ ऐसे नतीजे दिखाता है जो Google ई-बुक, पैसे लेकर दिखाए गए हैं या मुफ़्त हैं. ई-बुक के उदाहरण, प्रकाशक का ऐसा कॉन्टेंट हो सकता है जो सीमित झलक के तौर पर दिख रहा हो. यह बिक्री या पत्रिका के लिए उपलब्ध नहीं हो.

नीचे दिए गए उदाहरण में, उन किताबों को खोज के नतीजों में नहीं दिखाया जा सकता जो मुफ़्त ई-बुक के तौर पर उपलब्ध हैं:

GET https://www.googleapis.com/books/v1/volumes?q=flowers&filter=free-ebooks&key=yourAPIKey
पेजों को क्रम में लगाना

आप अनुरोध के लिए पैरामीटर में दो वैल्यू तय करके, वॉल्यूम सूची का इस्तेमाल कर सकते हैं:

  • startIndex - कलेक्शन की वह जगह जहां से शुरू होना है. पहले आइटम का इंडेक्स 0 है.
  • maxResults - लौटाए जाने वाले ज़्यादा से ज़्यादा नतीजे. डिफ़ॉल्ट वैल्यू 10 है और वैल्यू ज़्यादा से ज़्यादा 40 हो सकती है.

आप printType पैरामीटर का इस्तेमाल करके, लौटाए गए नतीजों को खास प्रिंट या प्रकाशन के प्रकार पर लागू करने के लिए, इन वैल्यू में से किसी एक को सेट कर सकते हैं:

  • all - प्रिंट टाइप के हिसाब से इन पर पाबंदी नहीं होती (डिफ़ॉल्ट तरीका).
  • books - सिर्फ़ नतीजे दिखाता है.
  • magazines - पत्रिकाएं वाले नतीजे दिखाता है.

नीचे दिए गए उदाहरण में पत्रिकाओं के लिए खोज के नतीजों को दिखाने पर पाबंदी है:

GET https://www.googleapis.com/books/v1/volumes?q=time&printType=magazines&key=yourAPIKey
अनुमान की रिपोर्ट

आप वॉल्यूम पैरामीटर के लिए पहले से तय किए गए सेट को तय करने के लिए, इनमें से किसी एक वैल्यू के साथ projection पैरामीटर का इस्तेमाल कर सकते हैं:

  • full - आवाज़ के सभी फ़ील्ड दिखाता है.
  • lite - सिर्फ़ कुछ फ़ील्ड दिखाता है. यह जानने के लिए कि कौनसे फ़ील्ड शामिल हैं, वॉल्यूम कॉन्टेक्स्ट में दो बार तारे के निशान वाले फ़ील्ड के ब्यौरे देखें.

यह उदाहरण, सीमित वॉल्यूम की जानकारी के साथ खोज के नतीजे दिखाता है:

GET https://www.googleapis.com/books/v1/volumes?q=flowers&projection=lite&key=yourAPIKey
क्रम से लगाना

डिफ़ॉल्ट रूप से, क्वेरी खोजने के लिए मिले अनुरोध से maxResults नतीजे मिलते हैं, जहां maxResults, पैरामीटर का इस्तेमाल करके खोज के लिए इस्तेमाल हुए शब्दों को क्रम में लगाता है (ऊपर).

आप orderBy पैरामीटर को इनमें से किसी एक मान के तौर पर सेट करके क्रम बदल सकते हैं:

  • relevance - इससे, खोज के लिए शब्दों की प्रासंगिकता के आधार पर नतीजे मिलते हैं. यह डिफ़ॉल्ट रूप से होता है.
  • newest - सबसे हाल ही में प्रकाशित किए गए कम से कम नतीजों के क्रम में नतीजे दिखाता है.

नीचे दिए गए उदाहरण में, पब्लिश होने की तारीख के साथ-साथ सबसे नए, नतीजों को सूची में दिखाया गया है:

GET https://www.googleapis.com/books/v1/volumes?q=flowers&orderBy=newest&key=yourAPIKey

किसी तय वॉल्यूम को वापस पाना

आप वॉल्यूम रिसॉर्स यूआरआई के साथ एक एचटीटीपी अनुरोध GET भेजकर, किसी खास वॉल्यूम के बारे में जानकारी पा सकते हैं:

https://www.googleapis.com/books/v1/volumes/volumeId

volumeId पाथ पैरामीटर को वॉल्यूम के आईडी से बदलें. वॉल्यूम आईडी के बारे में ज़्यादा जानकारी के लिए, Google Books आईडी सेक्शन देखें.

अनुरोध करें

यहां एक GET अनुरोध का उदाहरण दिया गया है, जिसे सिर्फ़ एक वॉल्यूम मिलता है:

GET https://www.googleapis.com/books/v1/volumes/zyTCAlFPjgYC?key=yourAPIKey

ध्यान दें: वॉल्यूम की जानकारी वापस पाने के लिए, पुष्टि करने की ज़रूरत नहीं होती. इसलिए, आपको GET अनुरोध के साथ Authorization एचटीटीपी हेडर नहीं देना होगा. हालांकि, अगर कॉल पुष्टि के दौरान किया जाता है, तो वॉल्यूम में उपयोगकर्ता की खास जानकारी शामिल होगी, जैसे कि खरीदा गया स्टेटस.

जवाब

अगर अनुरोध पूरा हो जाता है, तो सर्वर 200 OK एचटीटीपी स्टेटस कोड और अनुरोध किए गए वॉल्यूम रिसॉर्स का जवाब देता है:

200 OK

{
 "kind": "books#volume",
 "id": "zyTCAlFPjgYC",
 "etag": "f0zKg75Mx/I",
 "selfLink": "https://www.googleapis.com/books/v1/volumes/zyTCAlFPjgYC",
 "volumeInfo": {
  "title": "The Google story",
  "authors": [
   "David A. Vise",
   "Mark Malseed"
  ],
  "publisher": "Random House Digital, Inc.",
  "publishedDate": "2005-11-15",
  "description": "\"Here is the story behind one of the most remarkable Internet
  successes of our time. Based on scrupulous research and extraordinary access
  to Google, ...",
  "industryIdentifiers": [
   {
    "type": "ISBN_10",
    "identifier": "055380457X"
   },
   {
    "type": "ISBN_13",
    "identifier": "9780553804577"
   }
  ],
  "pageCount": 207,
  "dimensions": {
   "height": "24.00 cm",
   "width": "16.03 cm",
   "thickness": "2.74 cm"
  },
  "printType": "BOOK",
  "mainCategory": "Business & Economics / Entrepreneurship",
  "categories": [
   "Browsers (Computer programs)",
   ...
  ],
  "averageRating": 3.5,
  "ratingsCount": 136,
  "contentVersion": "1.1.0.0.preview.2",
  "imageLinks": {
   "smallThumbnail": "https://books.google.com/books?id=zyTCAlFPjgYC&printsec=frontcover&img=1&zoom=5&edge=curl&source=gbs_api",
   "thumbnail": "https://books.google.com/books?id=zyTCAlFPjgYC&printsec=frontcover&img=1&zoom=1&edge=curl&source=gbs_api",
   "small": "https://books.google.com/books?id=zyTCAlFPjgYC&printsec=frontcover&img=1&zoom=2&edge=curl&source=gbs_api",
   "medium": "https://books.google.com/books?id=zyTCAlFPjgYC&printsec=frontcover&img=1&zoom=3&edge=curl&source=gbs_api",
   "large": "https://books.google.com/books?id=zyTCAlFPjgYC&printsec=frontcover&img=1&zoom=4&edge=curl&source=gbs_api",
   "extraLarge": "https://books.google.com/books?id=zyTCAlFPjgYC&printsec=frontcover&img=1&zoom=6&edge=curl&source=gbs_api"
  },
  "language": "en",
  "infoLink": "https://books.google.com/books?id=zyTCAlFPjgYC&ie=ISO-8859-1&source=gbs_api",
  "canonicalVolumeLink": "https://books.google.com/books/about/The_Google_story.html?id=zyTCAlFPjgYC"
 },
 "saleInfo": {
  "country": "US",
  "saleability": "FOR_SALE",
  "isEbook": true,
  "listPrice": {
   "amount": 11.99,
   "currencyCode": "USD"
  },
  "retailPrice": {
   "amount": 11.99,
   "currencyCode": "USD"
  },
  "buyLink": "https://books.google.com/books?id=zyTCAlFPjgYC&ie=ISO-8859-1&buy=&source=gbs_api"
 },
 "accessInfo": {
  "country": "US",
  "viewability": "PARTIAL",
  "embeddable": true,
  "publicDomain": false,
  "textToSpeechPermission": "ALLOWED_FOR_ACCESSIBILITY",
  "epub": {
   "isAvailable": true,
   "acsTokenLink": "https://books.google.com/books/download/The_Google_story-sample-epub.acsm?id=zyTCAlFPjgYC&format=epub&output=acs4_fulfillment_token&dl_type=sample&source=gbs_api"
  },
  "pdf": {
   "isAvailable": false
  },
  "accessViewStatus": "SAMPLE"
 }
}
ऐक्सेस की जानकारी

accessInfo सेक्शन में खास तौर पर यह तय करने में दिलचस्पी होती है कि ई-बुक के लिए कौनसी सुविधाएं उपलब्ध हैं. epub एक फ़्लोइंग टेक्स्ट फ़ॉर्मैट ई-बुक है. epub सेक्शन में isAvailable प्रॉपर्टी होगी, जो बताएगी कि इस तरह की ई-बुक उपलब्ध है या नहीं. अगर किताब का कोई सैंपल है या कोई उपयोगकर्ता किताब खरीदने के बाद या उसकी जगह पर सार्वजनिक डोमेन होने की वजह से किताब को डाउनलोड कर सकता है, तो उसके लिए एक डाउनलोड लिंक होगा. Google Books के लिए कोई pdf, ई-बुक के स्कैन किए गए पेजों वाले वर्शन के बारे में बताता है. इससे, यह जानने में मदद मिलती है कि ई-बुक, डाउनलोड और डाउनलोड के लिए उपलब्ध है या नहीं. Google, ई-रीडर और स्मार्टफ़ोन के लिए epub फ़ाइलों का सुझाव देता है, क्योंकि इन डिवाइस पर स्कैन किए गए पेजों को पढ़ना मुश्किल हो सकता है. अगर accessInfo सेक्शन नहीं है, तो Google ई-बुक के तौर पर वॉल्यूम उपलब्ध नहीं होता है.

वैकल्पिक क्वेरी पैरामीटर

स्टैंडर्ड क्वेरी पैरामीटर के अलावा, कोई खास वॉल्यूम पाने के लिए, आप नीचे दिए गए क्वेरी पैरामीटर का भी इस्तेमाल कर सकते हैं.

अनुमान की रिपोर्ट

आप वॉल्यूम पैरामीटर के लिए पहले से तय किए गए सेट को तय करने के लिए, इनमें से किसी एक वैल्यू के साथ projection पैरामीटर का इस्तेमाल कर सकते हैं:

  • full - आवाज़ के सभी फ़ील्ड दिखाता है.
  • lite - सिर्फ़ कुछ फ़ील्ड दिखाता है. यह जानने के लिए कि कौनसे फ़ील्ड शामिल हैं, वॉल्यूम कॉन्टेक्स्ट में दो बार तारे के निशान वाले फ़ील्ड के ब्यौरे देखें.

यह उदाहरण, एक वॉल्यूम के लिए सीमित वॉल्यूम की जानकारी दिखाता है:

GET https://www.googleapis.com/books/v1/volumes/zyTCAlFPjgYC?projection=lite&key=yourAPIKey

किताबों की अलमारी के साथ काम करना

उपयोगकर्ता के सार्वजनिक शेल्फ़ की सूची फ़ेच की जा रही है

आप नीचे दिए गए फ़ॉर्मैट के साथ यूआरआई का एचटीटीपी GET अनुरोध भेजकर, उपयोगकर्ता के सार्वजनिक शेल्फ़ की सूची पा सकते हैं:

https://www.googleapis.com/books/v1/users/userId/bookshelves

userId पाथ पैरामीटर को उस उपयोगकर्ता के आईडी से बदलें जिसकी किताबों को आप फिर से पाना चाहते हैं. यूज़र आईडी के बारे में ज़्यादा जानने के लिए, Google Books आईडी सेक्शन देखें.

अनुरोध करें

यहां एक उदाहरण दिया गया है:

GET https://www.googleapis.com/books/v1/users/1112223334445556677/bookshelves&key=yourAPIKey

सार्वजनिक किताबों की शेल्फ़ के बारे में जानकारी पाने के लिए, उपयोगकर्ता की पुष्टि ज़रूरी नहीं है. इसलिए, आपको GET अनुरोध के साथ Authorization एचटीटीपी हेडर नहीं देना होगा.

जवाब

अनुरोध पूरा होने पर, सर्वर 200 OK एचटीटीपी स्टेटस कोड और किताबों की शेल्फ़ वाली सूची दिखाता है:

200 OK

{
 "kind": "books#bookshelves",
 "items": [
  {
   ...
  },
  {
   "kind": "books#bookshelf",
   "id": 3,
   "selfLink": "https://www.googleapis.com/books/v1/users/1112223334445556677/bookshelves/3",
   "title": "Reading now",
   "description": "",
   "access": "PUBLIC",
   "updated": "2011-02-02T20:34:20.146Z",
   "created": "2011-02-02T20:34:20.146Z",
   "volumeCount": 2,
   "volumesLastUpdated": "2011-02-02T20:34:20.110Z"
  },
  ...
 ]
}

वैकल्पिक क्वेरी पैरामीटर

उपयोगकर्ता की सार्वजनिक शेल्फ़ में दी गई सूची को फ़ेच करते समय, स्टैंडर्ड क्वेरी पैरामीटर का इस्तेमाल किया जा सकता है.

किसी खास सार्वजनिक अलमारी को वापस लाना

आप यूआरआई के साथ एचटीटीपी GET अनुरोध भेजकर, किसी खास सार्वजनिक अलमारी को वापस पा सकते हैं:

https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf

userId और शेल्फ़ पाथ पैरामीटर की जगह, ऐसे आईडी डालें जिनमें उस उपयोगकर्ता और किताबों की कैटगरी को शामिल किया गया हो जिसे आपको वापस पाना है. ज़्यादा जानकारी के लिए, Google Books आईडी सेक्शन देखें.

अनुरोध करें

यहां एक उदाहरण दिया गया है:

GET https://www.googleapis.com/books/v1/users/1112223334445556677/bookshelves/3?key=yourAPIKey

सार्वजनिक किताबों की शेल्फ़ के बारे में जानकारी पाने के लिए, उपयोगकर्ता की पुष्टि ज़रूरी नहीं है. इसलिए, आपको GET अनुरोध के साथ Authorization एचटीटीपी हेडर नहीं देना होगा.

जवाब

अगर अनुरोध पूरा होता है, तो सर्वर 200 OK एचटीटीपी स्टेटस कोड और किताबों की कैटगरी के रिसॉर्स को जवाब देता है:

200 OK

{
  "kind": "books#bookshelf",
  "id": 3,
  "selfLink": "https://www.googleapis.com/books/v1/users/1112223334445556677/bookshelves/3",
  "title": "Reading now",
  "description": "",
  "access": "PUBLIC",
  "updated": "2011-02-02T20:34:20.146Z",
  "created": "2011-02-02T20:34:20.146Z",
  "volumeCount": 2,
  "volumesLastUpdated": "2011-02-02T20:34:20.110Z"
}

वैकल्पिक क्वेरी पैरामीटर

किसी खास सार्वजनिक किताबों की सूची वापस पाने के लिए, स्टैंडर्ड क्वेरी पैरामीटर का इस्तेमाल किया जा सकता है.

सार्वजनिक किताबों की लाइब्रेरी में, वॉल्यूम की सूची फ़ेच की जा रही है

आप नीचे दिए गए फ़ॉर्मैट से यूआरआई का अनुरोध करने के लिए, उपयोगकर्ता के सार्वजनिक अलमारी की सूची शामिल कर सकते हैं. इसके लिए, आपको एचटीटीपी GET भेजना होगा:

https://www.googleapis.com/books/v1/user/userId/bookshelves/shelf/volumes

अनुरोध करें

यहां एक उदाहरण दिया गया है:

GET https://www.googleapis.com/books/v1/users/1112223334445556677/bookshelves/3/volumes?key=yourAPIKey

userId और शेल्फ़ पाथ पैरामीटर की जगह, ऐसे आईडी डालें जिनमें उस उपयोगकर्ता और किताबों की कैटगरी को शामिल किया गया हो जिसे आपको वापस पाना है. ज़्यादा जानकारी के लिए, Google Books आईडी सेक्शन देखें.

सार्वजनिक किताबों की शेल्फ़ के बारे में जानकारी पाने के लिए, उपयोगकर्ता की पुष्टि ज़रूरी नहीं है. इसलिए, आपको GET अनुरोध के साथ Authorization एचटीटीपी हेडर नहीं देना होगा.

जवाब

अनुरोध पूरा होने पर, सर्वर 200 OK एचटीटीपी स्टेटस कोड और उपयोगकर्ता की शेल्फ़ की सूची दिखाता है:

200 OK

{
 "kind": "books#volumes",
 "items": [
  {
   "kind": "books#volume",
   "id": "AZ5J6B1-4BoC",
   "etag": "kIzQA7IUObk",
   "selfLink": "https://www.googleapis.com/books/v1/volumes/AZ5J6B1-4BoC",
   "volumeInfo": {
    "title": "The Girl Who Kicked the Hornet's Nest",
    "authors": [
     "Stieg Larsson"
    ],
    "publisher": "Knopf",
    "publishedDate": "2010-05-25",
    ...
  },
  {
   "kind": "books#volume",
   "id": "UvK1Slvkz3MC",
   "etag": "otKmdbRgdFQ",
   "selfLink": "https://www.googleapis.com/books/v1/volumes/UvK1Slvkz3MC",
   "volumeInfo": {
    "title": "The Girl who Played with Fire",
    "authors": [
     "Stieg Larsson"
    ],
    "publisher": "Knopf",
    "publishedDate": "2009-07-28",
    ...
  },
  {
   "kind": "books#volume",
   "id": "OBM3AAAAIAAJ",
   "etag": "xb47kTr8HsQ",
   "selfLink": "https://www.googleapis.com/books/v1/volumes/OBM3AAAAIAAJ",
   "volumeInfo": {
    "title": "The Sign of Four",
    "authors": [
     "Sir Arthur Conan Doyle"
    ],
    "publishedDate": "1890",
    ...
  }
 ],
 "totalItems": 3
}

वैकल्पिक क्वेरी पैरामीटर

स्टैंडर्ड क्वेरी पैरामीटर के अलावा, किसी सार्वजनिक अलमारी में वॉल्यूम की सूची फ़ेच करते समय, नीचे दिए गए क्वेरी पैरामीटर का इस्तेमाल किया जा सकता है.

पेजों को क्रम में लगाना

आप अनुरोध के लिए पैरामीटर में दो वैल्यू तय करके, वॉल्यूम सूची का इस्तेमाल कर सकते हैं:

  • startIndex - कलेक्शन की वह जगह जहां से शुरू होना है. पहले आइटम का इंडेक्स 0 है.
  • maxResults - लौटाए जाने वाले ज़्यादा से ज़्यादा नतीजे. डिफ़ॉल्ट वैल्यू 10 है और वैल्यू ज़्यादा से ज़्यादा 40 हो सकती है.

किताबों की अलमारी और कोट; मेरी लाइब्रेरी में काम करना

सभी "मेरी लाइब्रेरी" अनुरोध, पुष्टि किए गए उपयोगकर्ता के डेटा पर लागू होते हैं.

किताबों की शेल्फ़ की सूची फ़ेच की जा रही है

आप नीचे दिए गए फ़ॉर्मैट में, यूआरआई GET को एक एचटीटीपी अनुरोध भेजकर, सभी पुष्टि किए गए उपयोगकर्ता और शेल्फ़ की सूची फिर से पा सकते हैं:

https://www.googleapis.com/books/v1/mylibrary/bookshelves

अनुरोध करें

यहां एक उदाहरण दिया गया है:

GET https://www.googleapis.com/books/v1/mylibrary/bookshelves?key=yourAPIKey
Authorization: /* auth token here */

ध्यान दें: &book"बुकबुक की लिस्टिंग दोबारा पाने के लिए, उपयोगकर्ता की पुष्टि होनी ज़रूरी है. इसलिए, आपको GET अनुरोध के साथ Authorization एचटीटीपी हेडर देना होगा.

जवाब

अगर अनुरोध पूरा होता है, तो सर्वर 200 OK एचटीटीपी स्टेटस कोड और मौजूदा पुष्टि किए गए उपयोगकर्ता के लिए सभी किताबों की शेल्फ़ का जवाब देगा:

200 OK

{
 "kind": "books#bookshelves",
 "items": [
  {
   "kind": "books#bookshelf",
   "id": 0,
   "selfLink": "https://www.googleapis.com/books/v1/users/1112223334445556677/bookshelves/0",
   "title": "Favorites",
   "access": "PRIVATE",
   "updated": "2011-04-22T04:03:15.416Z",
   "created": "2011-04-22T04:03:15.416Z",
   "volumeCount": 0,
   "volumesLastUpdated": "2011-04-22T04:03:17.000Z"
  },
  {
   "kind": "books#bookshelf",
   "id": 3,
   "selfLink": "https://www.googleapis.com/books/v1/users/1112223334445556677/bookshelves/3",
   "title": "Reading now",
   "access": "PUBLIC",
   "updated": "2010-11-11T19:44:22.377Z",
   "created": "2010-11-11T19:44:22.377Z",
   "volumeCount": 1,
   "volumesLastUpdated": "2010-11-11T19:44:22.341Z"
  }
 ]
}

वैकल्पिक क्वेरी पैरामीटर

पुष्टि किए गए उपयोगकर्ता की सूची को वापस लाने के लिए, स्टैंडर्ड क्वेरी पैरामीटर का इस्तेमाल किया जा सकता है.

मेरे किताबों की दुकान पर आवाज़ की सूची फ़ेच की जा रही है

आप इस फ़ॉर्मैट वाले एचटीटीपी GET अनुरोध को यूआरआई के साथ भेजकर, पुष्टि किए गए इस्तेमाल करने वाले के';;s किताबों की सूची पर वॉल्यूम की सूची पा सकते हैं:

https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes

शेल्फ़ पाथ पैरामीटर को प्लेसमार्क के आईडी से बदलें. अलमारी के आईडी की ज़्यादा जानकारी के लिए, Google Books का आईडी सेक्शन देखें.

अनुरोध करें

यहां एक उदाहरण दिया गया है:

GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/7/volumes?key=yourAPIKey
Authorization: /* auth token here */

ध्यान दें: &मेरी लाइब्रेरी और कोटेशन की सूची को फिर से पाने के लिए, उपयोगकर्ता की पुष्टि की जानी ज़रूरी है. इसलिए, आपको GET अनुरोध के साथ Authorization एचटीटीपी हेडर देना होगा.

जवाब

अगर अनुरोध पूरा होता है, तो सर्वर 200 OK एचटीटीपी स्टेटस कोड और किताबों की संख्या वाले वॉल्यूम की सूची के साथ जवाब देता है:

200 OK

{
 "kind": "books#volumes",
 "items": [
  {
   "kind": "books#volume",
   "id": "AZ5J6B1-4BoC",
   "etag": "kIzQA7IUObk",
   "selfLink": "https://www.googleapis.com/books/v1/volumes/AZ5J6B1-4BoC",
   "volumeInfo": {
    "title": "The Girl Who Kicked the Hornet's Nest",
    "authors": [
     "Stieg Larsson"
    ],
    "publisher": "Knopf",
    "publishedDate": "2010-05-25",
    ...
  },
  {
   "kind": "books#volume",
   "id": "UvK1Slvkz3MC",
   "etag": "otKmdbRgdFQ",
   "selfLink": "https://www.googleapis.com/books/v1/volumes/UvK1Slvkz3MC",
   "volumeInfo": {
    "title": "The Girl who Played with Fire",
    "authors": [
     "Stieg Larsson"
    ],
    "publisher": "Knopf",
    "publishedDate": "2009-07-28",
    ...
  },
  {
   "kind": "books#volume",
   "id": "OBM3AAAAIAAJ",
   "etag": "xb47kTr8HsQ",
   "selfLink": "https://www.googleapis.com/books/v1/volumes/OBM3AAAAIAAJ",
   "volumeInfo": {
    "title": "The Sign of Four",
    "authors": [
     "Sir Arthur Conan Doyle"
    ],
    "publishedDate": "1890",
    ...
  }
 ],
 "totalItems": 3
}

वैकल्पिक क्वेरी पैरामीटर

स्टैंडर्ड क्वेरी पैरामीटर के अलावा, आप पुष्टि किए गए किसी उपयोगकर्ता और किसी किताब के शेल्फ़ पर वॉल्यूम की सूची देखते समय, नीचे दिए गए क्वेरी पैरामीटर का इस्तेमाल कर सकते हैं.

पेजों को क्रम में लगाना

आप अनुरोध के लिए पैरामीटर में दो वैल्यू तय करके, वॉल्यूम सूची का इस्तेमाल कर सकते हैं:

  • startIndex - कलेक्शन की वह जगह जहां से शुरू होना है. पहले आइटम का इंडेक्स 0 है.
  • maxResults - लौटाए जाने वाले ज़्यादा से ज़्यादा नतीजे. डिफ़ॉल्ट 10 है.

मेरे Pixelbook में वॉल्यूम जोड़ा जा रहा है

यूआरआई और पुष्टि किए गए उपयोगकर्ता के Chromebook पर कोई वॉल्यूम जोड़ने के लिए, यूआरआई का एचटीटीपी POST अनुरोध इस फ़ॉर्मैट में भेजें:

https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/addVolume

शेल्फ़ पाथ पैरामीटर को प्लेसमार्क के आईडी से बदलें. अलमारी के आईडी की ज़्यादा जानकारी के लिए, Google Books का आईडी सेक्शन देखें.

अनुरोध में एक ज़रूरी क्वेरी पैरामीटर है:

  • volumeId - वॉल्यूम का आईडी. वॉल्यूम आईडी के बारे में ज़्यादा जानकारी के लिए, Google Books आईडी सेक्शन देखें.

अनुरोध करें

यहां एक उदाहरण दिया गया है, जिसमें &Altnon "Flowers & &tt&st "प्लेसबुक: को जोड़ने और कोट करने के बारे में बताया गया है:

POST https://www.googleapis.com/books/v1/mylibrary/bookshelves/0/addVolume?volumeId=NRWlitmahXkC&key=yourAPIKey
Authorization: /* auth token here */
Content-Type: application/json
Content-Length: CONTENT_LENGTH

ध्यान दें: किताबों की शेल्फ़ में बदलाव करने के लिए, उपयोगकर्ता की पुष्टि की जानी ज़रूरी है. इसलिए, आपको POST अनुरोध के साथ Authorization एचटीटीपी हेडर देना होगा. हालांकि, इस POST के लिए डेटा की ज़रूरत नहीं है.

जवाब

अनुरोध पूरा होने पर, सर्वर 204 No Content एचटीटीपी स्टेटस कोड दिखाता है.

वैकल्पिक क्वेरी पैरामीटर

किसी पुष्टि किए गए उपयोगकर्ता की शेल्फ़ में वॉल्यूम जोड़ते समय, स्टैंडर्ड क्वेरी पैरामीटर का इस्तेमाल किया जा सकता है.

मेरे बुक रूम से आवाज़ कम की जा रही है

पुष्टि किए गए उपयोगकर्ता और # 39; के अलमारी से कोई वॉल्यूम हटाने के लिए, यूआरआई को POST इस फ़ॉर्मैट में भेजें:

https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/removeVolume

शेल्फ़ पाथ पैरामीटर को प्लेसमार्क के आईडी से बदलें. अलमारी के आईडी की ज़्यादा जानकारी के लिए, Google Books का आईडी सेक्शन देखें.

अनुरोध में एक ज़रूरी क्वेरी पैरामीटर है:

  • volumeId - वॉल्यूम का आईडी. वॉल्यूम आईडी के बारे में ज़्यादा जानकारी के लिए, Google Books आईडी सेक्शन देखें.

अनुरोध करें

यहां एक उदाहरण दिया गया है, जिसमें &पौधे के लिए & &tt>पसंदीदा और&कोट;

POST https://www.googleapis.com/books/v1/mylibrary/bookshelves/0/removeVolume?volumeId=NRWlitmahXkC&key=yourAPIKey
Authorization: /* auth token here */
Content-Type: application/json
Content-Length: CONTENT_LENGTH

ध्यान दें: किताबों की शेल्फ़ में बदलाव करने के लिए, उपयोगकर्ता की पुष्टि की जानी ज़रूरी है. इसलिए, आपको POST अनुरोध के साथ Authorization एचटीटीपी हेडर देना होगा. हालांकि, इस POST के लिए डेटा की ज़रूरत नहीं है.

जवाब

अनुरोध पूरा होने पर, सर्वर 204 No Content स्टेटस कोड के साथ जवाब देता है.

वैकल्पिक क्वेरी पैरामीटर

किसी पुष्टि किए गए उपयोगकर्ता की किताब के शेल्फ़ से मात्रा हटाते समय, स्टैंडर्ड क्वेरी पैरामीटर का इस्तेमाल किया जा सकता है.

मेरे Pixelbook से सभी वॉल्यूम मिटाए जा रहे हैं

पुष्टि किए गए उपयोगकर्ता's Pixelbook से सभी वॉल्यूम हटाने के लिए, यूआरआई के साथ एक एचटीटीपी POST इस फ़ॉर्मैट में भेजें:

https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/clearVolumes

शेल्फ़ पाथ पैरामीटर को प्लेसमार्क के आईडी से बदलें. अलमारी के आईडी की ज़्यादा जानकारी के लिए, Google Books का आईडी सेक्शन देखें.

अनुरोध करें

& शर्तों को पसंद करने और कोट करने के लिए, यहां एक उदाहरण दिया गया है: अलमारी:

POST https://www.googleapis.com/books/v1/mylibrary/bookshelves/0/clearVolumes?key=yourAPIKey
Authorization: /* auth token here */
Content-Type: application/json
Content-Length: CONTENT_LENGTH
  

ध्यान दें: किताबों की शेल्फ़ में बदलाव करने के लिए, उपयोगकर्ता की पुष्टि की जानी ज़रूरी है. इसलिए, आपको POST अनुरोध के साथ Authorization एचटीटीपी हेडर देना होगा. हालांकि, इस POST के लिए डेटा की ज़रूरत नहीं है.

जवाब

अनुरोध पूरा होने पर, सर्वर 204 No Content स्टेटस कोड के साथ जवाब देता है.

वैकल्पिक क्वेरी पैरामीटर

किसी पुष्टि किए गए उपयोगकर्ता की शेल्फ़ से सभी वॉल्यूम मिटाकर, स्टैंडर्ड क्वेरी पैरामीटर का इस्तेमाल किया जा सकता है.

क्वेरी पैरामीटर का रेफ़रंस

आपको इस सेक्शन में उन क्वेरी पैरामीटर की खास जानकारी मिली है जिनका इस्तेमाल Books बुक के साथ किया जा सकता है.सभी पैरामीटर की वैल्यू, यूआरएल के हिसाब से होनी चाहिए.

स्टैंडर्ड क्वेरी पैरामीटर

सभी बुक एपीआई कार्रवाइयों पर लागू होने वाले क्वेरी पैरामीटर को सिस्टम पैरामीटर में दर्ज किया गया है.

एपीआई के हिसाब से क्वेरी पैरामीटर

अनुरोध की पैरामीटर के बारे में नीचे दी गई टेबल में, उन पैरामीटर के बारे में खास जानकारी दी गई है जो सिर्फ़ किताबों के एपीआई की खास कार्रवाइयों पर लागू होते हैं.

पैरामीटर लिंक ज़रूरी जानकारी लागू होने की शर्तें
download डाउनलोड करने की उपलब्धता के हिसाब से, वॉल्यूम को सीमित करें.
  • फ़िलहाल, epub के लिए ही वैल्यू इस्तेमाल की जा सकती है.
  • डाउनलोड ऐक्सेस के लिए खरीदारी करनी पड़ सकती है.
filter वॉल्यूम टाइप और उपलब्धता के हिसाब से खोज नतीजे फ़िल्टर करें.
  • इन फ़िल्टर का इस्तेमाल किया जा सकता है:
    • filter=partial - नतीजों को उन वॉल्यूम तक सीमित करें जहां टेक्स्ट का कम से कम कुछ हिस्सा झलक वाला हो.
    • filter=full - नतीजों को उन वॉल्यूम तक सीमित करें जहां पूरा टेक्स्ट दिख सकता है.
    • filter=free-ebooks - मुफ़्त Google ई-बुक के नतीजे सीमित करें.
    • filter=paid-ebooks - खरीदारी के मूल्य के साथ Google ई-बुक के नतीजे सीमित करें.
    • filter=ebooks - नतीजों को 'Google ई-बुक', पैसे चुकाकर डाउनलोड किए जाने वाले या मुफ़्त में उपलब्ध कराएं.गैर-ई-बुक के उदाहरण ऐसे प्रकाशक कॉन्टेंट हो सकते हैं जो सीमित झलक के तौर पर उपलब्ध हों और बिक्री या बिक्री के लिए उपलब्ध न हों.

 

langRestrict उन वॉल्यूम को सीमित करता है जिन्हें खास भाषा के साथ टैग किया गया है.
  • खोज के नतीजों को किसी खास भाषा तक सीमित करें. इसके लिए, langRestrict को दो अक्षरों वाले ISO-639-1 कोड से तय करें, जैसे कि "en" या "fr".
maxResults इस अनुरोध पर मिलने वाले एलिमेंट की ज़्यादा से ज़्यादा संख्या.
  • किसी कलेक्शन के सभी आइटम के लिए किसी भी अनुरोध के लिए, आप अनुरोध के पैरामीटर में startIndex और maxResults तय करके, पेजों को क्रम में लगा सकते हैं.
  • डिफ़ॉल्ट: maxResults=10
  • ज़्यादा से ज़्यादा maxResults=40. वैल्यू डाली जा सकती है
orderBy

वॉल्यूम के खोज के नतीजों का क्रम.

  • डिफ़ॉल्ट रूप से, खोज के अनुरोध पर maxResults नतीजे दिखते हैं. पेज पर नंबर डालने के लिए, maxResults पैरामीटर का इस्तेमाल किया जाता है. क्रम से लगाने के लिए सबसे पहले इसे क्रम में लगाया जाता है.
  • क्रम में बदलाव करने के लिए, orderBy पैरामीटर को इनमें से किसी एक वैल्यू पर सेट किया जा सकता है:
    • orderBy=relevance - खोज के नतीजों को सबसे काम के क्रम में दिखाता है. यह डिफ़ॉल्ट रूप से इस्तेमाल होता है.
    • orderBy=newest - पब्लिश की गई सबसे नई तारीख के हिसाब से, खोज के नतीजे दिखाता है. ये नतीजे सबसे पुराने तारीख के हिसाब से दिखाए जाते हैं.
printType किताबों या पत्रिकाओं तक सीमित रखें.
  • इस्तेमाल की जा सकने वाली वैल्यू ये हैं:
    • printType=all - सभी तरह के वॉल्यूम वाले कॉन्टेंट दिखाएं (कोई पाबंदी नहीं). यह डिफ़ॉल्ट रूप से होता है.
    • printType=books - सिर्फ़ किताबें दिखाएं.
    • printType=magazines - सिर्फ़ पत्रिकाएं दिखाएं.
projection फ़ील्ड के सबसेट पर मिलने वाली वॉल्यूम की जानकारी को प्रतिबंधित करें.
  • ये अनुमान लगाए जा सकते हैं:
    • projection=full - सभी वॉल्यूम मेटाडेटा शामिल है (डिफ़ॉल्ट).
    • projection=lite - इसमें सिर्फ़ वॉल्यूम और ऐक्सेस मेटाडेटा का विषय शामिल होता है.
q पूरे टेक्स्ट वाली क्वेरी स्ट्रिंग.
  • क्वेरी बनाते समय, खोज के लिए इस्तेमाल हुए शब्दों को q=term1+term2_term3 के तौर पर सूची में शामिल करें. (इसके अलावा, आप उन्हें स्पेस से अलग भी कर सकते हैं, लेकिन क्वेरी पैरामीटर की सभी वैल्यू की तरह, स्पेस भी यूआरएल के कोड में बदले जाने चाहिए.) एपीआई उन सभी एंट्री को दिखाता है जो खोजे गए सभी शब्दों से मैच करती हैं. जैसे, शब्दों के बीच AND का इस्तेमाल करना. Google की वेब खोज की तरह ही, एपीआई पूरा शब्द (और उसी स्टेम से जुड़े शब्द) खोजता है, न कि सबस्ट्रिंग.
  • सटीक वाक्यांश खोजने के लिए, वाक्यांश को इन्वर्टेड कॉमा के बीच में रखें: q="exact phrase".
  • किसी शब्द से मिलती-जुलती एंट्री हटाने के लिए, q=-term फ़ॉर्म का इस्तेमाल करें.
  • खोज के लिए इस्तेमाल होने वाले शब्द, केस-इनसेंसिटिव होते हैं.
  • उदाहरण: ऐसी सभी एंट्री खोजने के लिए जिनमें "Elizabeth Bennet" और "Darcy" शब्द शामिल हो, लेकिन इसमें "Austen" शब्द शामिल न हो, क्वेरी पैरामीटर के लिए यहां दी गई वैल्यू का इस्तेमाल करें:
    q="Elizabeth+Bennet"+Darcy-Austen
  • ऐसे कुछ खास (केस-सेंसिटिव) कीवर्ड होते हैं जिन्हें आप खोज के लिए इस्तेमाल होने वाले शब्दों के ज़रिए खोज सकते हैं. आप इन कीवर्ड को कुछ खास फ़ील्ड में खोज सकते हैं, जैसे:
    • intitle: नतीजे दिखाता है, जहां इस कीवर्ड के बाद का टेक्स्ट, शीर्षक में मिलता है.
    • inauthor: ऐसे नतीजे दिखाता है जिनमें इस कीवर्ड के बाद का टेक्स्ट, लेखक में मिला होता है.
    • inpublisher: नतीजे दिखाता है कि इस कीवर्ड के बाद का टेक्स्ट, प्रकाशक में मिलता है या नहीं.
    • subject: नतीजे दिखाता है, जहां इस कीवर्ड के बाद का टेक्स्ट, वॉल्यूम की कैटगरी सूची में शामिल होता है.
    • isbn: नतीजे दिखाता है, जहां इस कीवर्ड के बाद वाला टेक्स्ट ISBN नंबर होता है.
    • lccn: इस कीवर्ड के बाद आने वाले टेक्स्ट के लिए, कांग्रेस के कंट्रोल नंबर की लाइब्रेरी का इस्तेमाल किया जाता है.
    • oclc: यह विकल्प दिखाता है कि इस कीवर्ड के बाद मौजूद टेक्स्ट, ऑनलाइन कंप्यूटर लाइब्रेरी सेंटर नंबर है.
startIndex कलेक्शन की वह जगह जिस पर नतीजों की सूची शुरू करनी है.
  • कलेक्शन के सभी आइटम के लिए किसी भी अनुरोध के लिए, अनुरोधों के लिए पैरामीटर में startIndex और maxResults की जानकारी दी जा सकती है. इसके लिए, आपको पेजों को क्रम में लगाना होगा.
  • पहले आइटम का इंडेक्स 0 है.
volumeId अनुरोध से जुड़े वॉल्यूम की पहचान करता है.
  • यह तय करता है कि किसी प्लेसमार्क को कितना जोड़ना है या कितना हटाना है.