विषय सूची
शुरुआती जानकारी
यह दस्तावेज़ उन डेवलपर के लिए है जो Books API के साथ इंटरैक्ट करने वाले ऐप्लिकेशन लिखना चाहते हैं. 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 के लिए अनुमति देने की प्रक्रिया या "तरीका" अलग-अलग हो सकता है. यह इस बात पर निर्भर करता है कि ऐप्लिकेशन किस तरह का है. सभी तरह के ऐप्लिकेशन के लिए नीचे दी गई सामान्य प्रक्रिया लागू होती है:
- ऐप्लिकेशन बनाने के बाद, उसे Google API (एपीआई) कंसोल का इस्तेमाल करके, रजिस्टर किया जाता है. इसके बाद, Google आपको क्लाइंट आईडी और क्लाइंट सीक्रेट जैसी जानकारी देगा. इस जानकारी की ज़रूरत आपको बाद में पड़ेगी.
- Google API कंसोल में Books API चालू करें. (अगर एपीआई को 'API कंसोल' की सूची में नहीं जोड़ा गया है, तो यह चरण छोड़ दें.)
- जब आपके ऐप्लिकेशन को उपयोगकर्ता के डेटा को ऐक्सेस करने की ज़रूरत होती है, तब वह Google से, डेटा के खास लिंक का अनुरोध करता है.
- Google, उपयोगकर्ता को सहमति वाली स्क्रीन दिखाता है, जिसमें उनसे आपके ऐप्लिकेशन को उनके कुछ डेटा को ऐक्सेस करने की अनुमति मांगी जाती है.
- अगर उपयोगकर्ता इसकी अनुमति दे देता है, तो Google आपके ऐप्लिकेशन को कुछ समय के लिए इस्तेमाल किए जा सकने वाला ऐक्सेस टोकन देता है.
- आपका ऐप्लिकेशन, ऐक्सेस टोकन से उपयोगकर्ता के डेटा को ऐक्सेस करने का अनुरोध करता है.
- अगर Google को पता चलता है कि आपका अनुरोध और टोकन मान्य है, तो वह आपके ऐप्लिकेशन को अनुरोध किए गए डेटा का ऐक्सेस दे देता है.
कुछ तरीकों में दूसरे चरण भी शामिल हो सकते हैं, जैसे कि रिफ़्रेश टोकन इस्तेमाल करके, नया ऐक्सेस टोकन पाना. अलग-अलग तरह के ऐप्लिकेशन के लिए डेटा ऐक्सेस करने के तरीकों के बारे में ज़्यादा जानकारी पाने के लिए, Google का OAuth 2.0 दस्तावेज़ पढ़ें.
Books API के लिए, OAuth 2.0 के दायरे की जानकारी यहां दी गई है:
https://www.googleapis.com/auth/books
OAuth 2.0 का इस्तेमाल करके, डेटा ऐक्सेस करने का अनुरोध करने के लिए, आपके ऐप्लिकेशन को अनुरोध के तरीके की जानकारी देनी होगी. साथ ही, वह जानकारी भी देनी होगी जो आपको ऐप्लिकेशन रजिस्टर करते समय, Google से मिली थी, जैसे कि क्लाइंट आईडी और क्लाइंट सीक्रेट.
सलाह: Google API की क्लाइंट लाइब्रेरी आपके लिए अनुमति देने की कुछ प्रक्रियाएं खुद कर सकती है. ये लाइब्रेरी कई प्रोग्रामिंग भाषाओं के लिए उपलब्ध होती हैं. ज़्यादा जानकारी के लिए लाइब्रेरी और नमूनों वाला पेज देखें.
एपीआई पासकोड हासिल करना और उसका इस्तेमाल करना
सार्वजनिक डेटा के लिए Books API के अनुरोधों के साथ एक आइडेंटिफ़ायर दिया जाना चाहिए. यह आइडेंटिफ़ायर, एपीआई पासकोड या ऐक्सेस टोकन हो सकता है.
एपीआई पासकोड हासिल करने के लिए:
- API कंसोल में क्रेडेंशियल पेज खोलें.
-
यह एपीआई दो तरह के क्रेडेंशियल के साथ काम करता है.
अपने प्रोजेक्ट के लिए सही क्रेडेंशियल बनाएं:
-
OAuth 2.0: जब भी आपका ऐप्लिकेशन, उपयोगकर्ता के निजी डेटा का अनुरोध करता है, तो उसे अनुरोध के साथ OAuth 2.0 टोकन भेजना चाहिए. आपका ऐप्लिकेशन, टोकन पाने के लिए सबसे पहले एक क्लाइंट आईडी भेजता है. हो सकता है, यह क्लाइंट सीक्रेट भी भेजा जा सकता है. वेब ऐप्लिकेशन, सेवा खातों या इंस्टॉल किए गए ऐप्लिकेशन के लिए, OAuth 2.0 क्रेडेंशियल जनरेट किए जा सकते हैं.
ज़्यादा जानकारी के लिए, OAuth 2.0 दस्तावेज़ देखें.
-
एपीआई पासकोड: OAuth 2.0 टोकन उपलब्ध न कराने वाले अनुरोध के लिए, एपीआई पासकोड भेजना ज़रूरी है. यह कुंजी आपके प्रोजेक्ट की पहचान करती है. साथ ही, एपीआई ऐक्सेस, कोटा, और रिपोर्ट उपलब्ध कराती है.
एपीआई, एपीआई पासकोड पर कई तरह की पाबंदियों के साथ काम करता है. अगर आपको जिस एपीआई पासकोड की ज़रूरत है वह पहले से मौजूद नहीं है, तो Console में एपीआई पासकोड बनाएं. इसके लिए, क्रेडेंशियल बनाएं > एपीआई पासकोड पर क्लिक करें. कुंजी को प्रोडक्शन में इस्तेमाल करने से पहले उसे सीमित किया जा सकता है. इसके लिए, कुंजी पर पाबंदी लगाएं पर क्लिक करें और पाबंदियां में से कोई एक चुनें.
-
अपनी एपीआई कुंजियों को सुरक्षित रखने के लिए, एपीआई पासकोड का इस्तेमाल सुरक्षित तरीके से करने के सबसे सही तरीके अपनाएं.
एपीआई पासकोड मिलने के बाद, आपका ऐप्लिकेशन, अनुरोध किए गए सभी यूआरएल में क्वेरी पैरामीटर
key=yourAPIKey को जोड़ सकता है.
एपीआई पासकोड, यूआरएल में एम्बेड करने के लिए सुरक्षित होता है. इसे कोड में बदलने की कोई ज़रूरत नहीं होती.
Google Books के आईडी
आपको कुछ एपीआई मेथड कॉल के साथ आईडी फ़ील्ड की जानकारी देनी होगी. Google Books में तीन तरह के आईडी इस्तेमाल किए जाते हैं:
- वॉल्यूम आईडी - हर वॉल्यूम को दी जाने वाली यूनीक स्ट्रिंग जिनके बारे में Google Books
के पास है. वॉल्यूम आईडी का एक उदाहरण
_LettPDhwR0Cहै. एपीआई का इस्तेमाल करके, वॉल्यूम रिसॉर्स को दिखाने का अनुरोध करके, वॉल्यूम आईडी पाया जा सकता है. इसकेidफ़ील्ड में वॉल्यूम आईडी देखा जा सकता है. - बुकशेल्फ़ आईडी - उपयोगकर्ता की लाइब्रेरी में किताबों की अलमारी को दी गई न्यूमेरिक वैल्यू. Google इन आईडी वाले हर उपयोगकर्ता को पहले से तय की गई शेल्फ़ की सुविधा देता है:
- पसंदीदा: 0
- खरीदा गया: 1
- पढ़ने के लिए: 2
- अभी पढ़ना: 3
- पढ़ लिया है: 4
- समीक्षा की गई: पांच
- हाल ही में देखे गए: 6
- मेरी ई-बुक: 7
- आपके लिए किताबें: 8 अगर हमारे पास उपयोगकर्ता के लिए कोई सुझाव नहीं है, तो यह शेल्फ़ मौजूद नहीं होगी.
idफ़ील्ड में देखा जा सकता है. - यूज़र आईडी - हर उपयोगकर्ता को असाइन की गई यूनीक न्यूमेरिक वैल्यू. यह ज़रूरी नहीं है कि ये वैल्यू, Google की अन्य सेवाओं में इस्तेमाल की गई आईडी की वैल्यू से मेल खाती हों. फ़िलहाल, इस यूज़र आईडी को सिर्फ़ उस बुकशेल्फ़ संसाधन में सेल्फ़ लिंक से एक्सट्रैक्ट किया जा सकता है जिसकी पुष्टि हो चुकी है. उपयोगकर्ता, Books की साइट से अपना यूज़र आईडी भी ले सकते हैं. उपयोगकर्ता, एपीआई या 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यूआरएल पैरामीटर में यूज़र आईडी देखा जा सकता है. यहां एक उदाहरण दिया गया है: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:ऐसे नतीजे दिखाता है जहां इस कीवर्ड के बाद दिया गया टेक्स्ट, ऑनलाइन कंप्यूटर लाइब्रेरी सेंटर का नंबर होता है.
अनुरोध
यहां डैनियल कीज़ के "फ़्लावर फ़ॉर एलगेर्नन" को खोजने का एक उदाहरण दिया गया है:
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 */
ध्यान दें: "मेरी लाइब्रेरी" बुकशेल्फ़ की सूची वापस पाने के लिए, उपयोगकर्ता की पुष्टि ज़रूरी है. इसलिए, आपको 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 अनुरोध भेजकर, पुष्टि किए गए उपयोगकर्ता के बुकशेल्फ़ पर वॉल्यूम की सूची पा सकते हैं:
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 है.
अपनी किताबों की अलमारी में वॉल्यूम जोड़ना
पुष्टि किए गए उपयोगकर्ता के बुकशेल्फ़ में वॉल्यूम जोड़ने के लिए, इस फ़ॉर्मैट वाला यूआरआई को एचटीटीपी
POST अनुरोध भेजें:
https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/addVolume
शेल्फ़ पाथ पैरामीटर को बुकशेल्फ़ के आईडी से बदलें. बुकशेल्फ़ आईडी के बारे में ज़्यादा जानकारी के लिए, Google Books के आईडी सेक्शन देखें.
अनुरोध में एक ज़रूरी क्वेरी पैरामीटर है:
volumeId- वॉल्यूम का आईडी. वॉल्यूम आईडी के बारे में ज़्यादा जानकारी के लिए, Google Books के आईडी सेक्शन देखें.
अनुरोध
"पसंदीदा" किताबों की अलमारी में "अल्गेरन के लिए फूल" जोड़ने का एक उदाहरण यहां दिया गया है:
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 एचटीटीपी स्टेटस कोड के साथ जवाब देता है.
वैकल्पिक क्वेरी पैरामीटर
पुष्टि किए गए उपयोगकर्ता के बुकशेल्फ़ में से किसी एक में वॉल्यूम जोड़ते समय, आप स्टैंडर्ड क्वेरी पैरामीटर का इस्तेमाल कर सकते हैं.
मेरी किताबों की अलमारी से वॉल्यूम हटाना
पुष्टि किए गए उपयोगकर्ता के बुकशेल्फ़ से वॉल्यूम हटाने के लिए, इस फ़ॉर्मैट वाला यूआरआई को एचटीटीपी
POST भेजें:
https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/removeVolume
शेल्फ़ पाथ पैरामीटर को बुकशेल्फ़ के आईडी से बदलें. बुकशेल्फ़ आईडी के बारे में ज़्यादा जानकारी के लिए, Google Books के आईडी सेक्शन देखें.
अनुरोध में एक ज़रूरी क्वेरी पैरामीटर है:
volumeId- वॉल्यूम का आईडी. वॉल्यूम आईडी के बारे में ज़्यादा जानकारी के लिए, Google Books के आईडी सेक्शन पर जाएं.
अनुरोध
यहां "पसंदीदा" बुकशेल्फ़ से "फूलों की दुकान" को हटाने का एक उदाहरण दिया गया है:
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 स्टेटस कोड के साथ जवाब देता है.
वैकल्पिक क्वेरी पैरामीटर
पुष्टि किए गए उपयोगकर्ता के बुकशेल्फ़ में से किसी एक से वॉल्यूम हटाते समय, आप स्टैंडर्ड क्वेरी पैरामीटर का इस्तेमाल कर सकते हैं.
मेरी बुकशेल्फ़ से सभी वॉल्यूम साफ़ करना
पुष्टि किए गए उपयोगकर्ता के बुकशेल्फ़ से सभी वॉल्यूम हटाने के लिए, इस फ़ॉर्मैट वाला यूआरआई को एचटीटीपी 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 API के साथ इस्तेमाल किए जा सकने वाले क्वेरी पैरामीटर के बारे में खास जानकारी दी गई है.सभी पैरामीटर वैल्यू को यूआरएल के कोड में बदलना होगा.
स्टैंडर्ड क्वेरी पैरामीटर
Books API की सभी कार्रवाइयों पर लागू होने वाले क्वेरी पैरामीटर के बारे में, सिस्टम पैरामीटर में जानकारी दी गई है.
एपीआई के हिसाब से क्वेरी पैरामीटर
Books API में सिर्फ़ खास कार्रवाइयों पर लागू होने वाले अनुरोध पैरामीटर की खास जानकारी नीचे दी गई है.
| पैरामीटर | मतलब | ज़रूरी जानकारी | लागू होने की शर्तें |
|---|---|---|---|
download |
डाउनलोड की उपलब्धता के हिसाब से वॉल्यूम तक सीमित करें. |
|
|
filter |
आवाज़ के टाइप और उपलब्धता के हिसाब से, खोज के नतीजों को फ़िल्टर करें. |
|
|
langRestrict |
तय की गई भाषा के साथ टैग किए गए वॉल्यूम को सीमित करता है. |
|
|
maxResults |
इस अनुरोध के साथ लौटाए जाने वाले एलिमेंट की ज़्यादा से ज़्यादा संख्या. |
|
|
orderBy |
खोजे गए नतीजों का क्रम. |
|
|
printType |
किताबों या पत्रिकाओं को सीमित करें. |
|
|
projection |
फ़ील्ड के सबसेट के लिए वापस दी गई वॉल्यूम जानकारी को सीमित करें. |
|
|
q |
पूरे टेक्स्ट वाली क्वेरी स्ट्रिंग. |
|
|
startIndex |
कलेक्शन में वह पोज़िशन जहां से नतीजों की सूची शुरू होती है. |
|
|
volumeId |
अनुरोध से जुड़े वॉल्यूम की पहचान करता है. |
|