बुकशेल्फ़.वॉल्यूम: लिस्ट
संग्रह की मदद से व्यवस्थित रहें
अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.
यह फ़ंक्शन, किसी उपयोगकर्ता के लिए किसी खास किताबों की अलमारी में मौजूद वॉल्यूम को वापस लाता है.
इसे अभी आज़माएं.
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes
पैरामीटर
पैरामीटर का नाम |
मान |
ब्यौरा |
ज़रूरी पैरामीटर |
shelf |
string |
वॉल्यूम वापस पाने के लिए, किताबों की अलमारी का आईडी.
|
userId |
string |
उस उपयोगकर्ता का आईडी जिसके लिए किताबों की अलमारी के वॉल्यूम वापस लाने हैं.
|
ज़रूरी नहीं पैरामीटर |
maxResults |
unsigned integer |
कितने नतीजे दिखाने हैं
|
showPreorders |
boolean |
पहले से ऑर्डर की गई किताबें दिखाने के लिए, इसे 'सही है' पर सेट करें. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होती है.
|
source |
string |
इस अनुरोध को भेजने वाले व्यक्ति की पहचान करने के लिए स्ट्रिंग.
|
startIndex |
unsigned integer |
दिखाए जाने वाले पहले एलिमेंट का इंडेक्स (0 से शुरू होता है)
|
अनुरोध का मुख्य भाग
इस तरीके का इस्तेमाल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर एपीआई सही से जुड़ जाता है, तो यह तरीका इस स्ट्रक्चर के साथ रिस्पॉन्स बॉडी दिखाता है:
{
"kind": "books#volumes",
"totalItems": integer,
"items": [
volumes Resource
]
}
प्रॉपर्टी का नाम |
मान |
ब्यौरा |
नोट |
kind |
string |
संसाधन का टाइप. |
|
totalItems |
integer |
मिले वॉल्यूम की कुल संख्या. अगर नतीजों को पेज के हिसाब से बांटा गया है, तो यह संख्या इस जवाब में दिखाए गए वॉल्यूम की संख्या से ज़्यादा हो सकती है. |
|
items[] |
list |
वॉल्यूम की सूची. |
|
इसे आज़माएं!
लाइव डेटा पर इस तरीके को कॉल करने और जवाब देखने के लिए, नीचे दिए गए एक्सप्लोरर का इस्तेमाल करें.
जब तक कुछ अलग से न बताया जाए, तब तक इस पेज की सामग्री को Creative Commons Attribution 4.0 License के तहत और कोड के नमूनों को Apache 2.0 License के तहत लाइसेंस मिला है. ज़्यादा जानकारी के लिए, Google Developers साइट नीतियां देखें. Oracle और/या इससे जुड़ी हुई कंपनियों का, Java एक रजिस्टर किया हुआ ट्रेडमार्क है.
आखिरी बार 2024-11-08 (UTC) को अपडेट किया गया.
[null,null,["आखिरी बार 2024-11-08 (UTC) को अपडेट किया गया."],[[["\u003cp\u003eRetrieves a list of books from a specific bookshelf belonging to a given user.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by parameters such as maximum results, pre-orders, and starting index for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes the total number of books found and a list of book details.\u003c/p\u003e\n"],["\u003cp\u003eYou can interactively try this method using the provided explorer to test it with live data.\u003c/p\u003e\n"]]],[],null,["# Bookshelves.volumes: list\n\nRetrieves volumes in a specific bookshelf for the specified user.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://www.googleapis.com/books/v1/users/userId/bookshelves/shelf/volumes\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-----------------|--------------------|-----------------------------------------------------------|\n| **Required Parameters** |||\n| `shelf` | `string` | ID of bookshelf to retrieve volumes. |\n| `userId` | `string` | ID of user for whom to retrieve bookshelf volumes. |\n| **Optional Parameters** |||\n| `maxResults` | `unsigned integer` | Maximum number of results to return |\n| `showPreorders` | `boolean` | Set to true to show pre-ordered books. Defaults to false. |\n| `source` | `string` | String to identify the originator of this request. |\n| `startIndex` | `unsigned integer` | Index of the first element to return (starts at 0) |\n\n### Request Body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```objective-c\n{\n \"kind\": \"books#volumes\",\n \"totalItems\": integer,\n \"items\": [\n volumes Resource\n ]\n}\n```\n\n| Property Name | Value | Description | Notes |\n|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `kind` | `string` | Resource type. | |\n| `totalItems` | `integer` | Total number of volumes found. This might be greater than the number of volumes returned in this response if results have been paginated. | |\n| `items[]` | `list` | A list of volumes. | |\n\nTry It!\n-------\n\n\nUse the explorer below to call this method on live data and see the response."]]