Mylibrary.bookshelves.volumes: 목록
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
서가의 볼륨 정보를 가져옵니다.
지금 사용해 보기
요청
HTTP 요청
GET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes
파라미터
매개변수 이름 |
값 |
설명 |
필수 매개변수 |
shelf |
string |
볼륨을 가져올 보관함 ID 또는 이름입니다.
|
선택적 매개변수 |
maxResults |
unsigned integer |
반환할 최대 결과 수
|
projection |
string |
선택한 필드 집합으로 반환되는 정보를 제한합니다.
허용되는 값은 다음과 같습니다.
- '
full ': 모든 볼륨 데이터를 포함합니다.
- '
lite ': volumeInfo 및 accessInfo의 필드 하위 집합을 포함합니다.
|
q |
string |
이 보관함의 전체 텍스트 검색 쿼리 문자열입니다.
|
showPreorders |
boolean |
선주문한 책을 표시하려면 true로 설정하세요. 기본값은 false입니다.
|
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 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 Oracle 계열사의 등록 상표입니다.
최종 업데이트: 2024-11-08(UTC)
[null,null,["최종 업데이트: 2024-11-08(UTC)"],[[["\u003cp\u003eRetrieves volume information for books on a specific bookshelf.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by search query, pre-orders, and selected fields.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of volumes with details like total items and individual volume resources.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination for handling large results.\u003c/p\u003e\n"],["\u003cp\u003eCan be tested using the provided interactive explorer.\u003c/p\u003e\n"]]],[],null,["# Mylibrary.bookshelves.volumes: list\n\nGets volume information for volumes on a bookshelf.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://www.googleapis.com/books/v1/mylibrary/bookshelves/shelf/volumes\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|-----------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Required Parameters** |||\n| `shelf` | `string` | The bookshelf ID or name retrieve volumes for. |\n| **Optional Parameters** |||\n| `maxResults` | `unsigned integer` | Maximum number of results to return |\n| `projection` | `string` | Restrict information returned to a set of selected fields. \u003cbr /\u003e \u003cbr /\u003e Acceptable values are: - \"`full`\" - Includes all volume data. - \"`lite`\" - Includes a subset of fields in volumeInfo and accessInfo. |\n| `q` | `string` | Full-text search query string in this bookshelf. |\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."]]