google_api_books v0.5.0 GoogleApi.Books.V1.Api.Bookshelves View Source
API calls for all endpoints tagged Bookshelves
.
Link to this section Summary
Functions
Retrieves metadata for a specific bookshelf for the specified user.
Retrieves a list of public bookshelves for the specified user.
Retrieves volumes in a specific bookshelf for the specified user.
Link to this section Functions
books_bookshelves_get(connection, user_id, shelf, optional_params \\ [], opts \\ []) View Source
Retrieves metadata for a specific bookshelf for the specified user.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- user_id (String.t): ID of user for whom to retrieve bookshelves.
- shelf (String.t): ID of bookshelf to retrieve.
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %GoogleApi.Books.V1.Model.Bookshelf{}} on success {:error, info} on failure
books_bookshelves_list(connection, user_id, optional_params \\ [], opts \\ []) View Source
Retrieves a list of public bookshelves for the specified user.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- user_id (String.t): ID of user for whom to retrieve bookshelves.
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %GoogleApi.Books.V1.Model.Bookshelves{}} on success {:error, info} on failure
books_bookshelves_volumes_list(connection, user_id, shelf, optional_params \\ [], opts \\ []) View Source
Retrieves volumes in a specific bookshelf for the specified user.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- user_id (String.t): ID of user for whom to retrieve bookshelf volumes.
- shelf (String.t): ID of bookshelf to retrieve volumes.
optional_params (keyword()): [optional] Optional parameters
- :alt (String.t): Data format for the response.
- :fields (String.t): Selector specifying which fields to include in a partial response.
- :key (String.t): API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
- :oauth_token (String.t): OAuth 2.0 token for the current user.
- :prettyPrint (boolean()): Returns response with indentations and line breaks.
- :quotaUser (String.t): An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (String.t): Deprecated. Please use quotaUser instead.
- :maxResults (integer()): Maximum number of results to return
- :showPreorders (boolean()): Set to true to show pre-ordered books. Defaults to false.
- :source (String.t): String to identify the originator of this request.
- :startIndex (integer()): Index of the first element to return (starts at 0)
Returns
{:ok, %GoogleApi.Books.V1.Model.Volumes{}} on success {:error, info} on failure