View Source GoogleApi.Books.V1.Api.Volumes (google_api_books v0.21.0)

@spec books_volumes_associated_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Books.V1.Model.Volumes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Return a list of associated books.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
volume_id (type: String.t) - ID of the source volume.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :association (type: String.t) - Association type.
- :locale (type: String.t) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- :maxAllowedMaturityRating (type: String.t) - The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
- :source (type: String.t) - String to identify the originator of this request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Volumes{}} on success
{:error, info} on failure

books_volumes_get(connection, volume_id, optional_params \\ [], opts \\ [])

@spec books_volumes_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Volume.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets volume information for a single volume.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
volume_id (type: String.t) - ID of volume to retrieve.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :country (type: String.t) - ISO-3166-1 code to override the IP-based location.
- :includeNonComicsSeries (type: boolean()) - Set to true to include non-comics series. Defaults to false.
- :partner (type: String.t) - Brand results for partner ID.
- :projection (type: String.t) - Restrict information returned to a set of selected fields.
- :source (type: String.t) - string to identify the originator of this request.
- :user_library_consistent_read (type: boolean()) -
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Volume{}} on success
{:error, info} on failure

books_volumes_list(connection, q, optional_params \\ [], opts \\ [])

@spec books_volumes_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Volumes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Performs a book search.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
q (type: String.t) - Full-text search query string.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :download (type: String.t) - Restrict to volumes by download availability.
- :filter (type: String.t) - Filter search results.
- :langRestrict (type: String.t) - Restrict results to books with this language code.
- :libraryRestrict (type: String.t) - Restrict search to this user's library.
- :maxAllowedMaturityRating (type: String.t) - The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
- :maxResults (type: integer()) - Maximum number of results to return.
- :orderBy (type: String.t) - Sort search results.
- :partner (type: String.t) - Restrict and brand results for partner ID.
- :printType (type: String.t) - Restrict to books or magazines.
- :projection (type: String.t) - Restrict information returned to a set of selected fields.
- :showPreorders (type: boolean()) - Set to true to show books available for preorder. Defaults to false.
- :source (type: String.t) - String to identify the originator of this request.
- :startIndex (type: integer()) - Index of the first result to return (starts at 0)
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Volumes{}} on success
{:error, info} on failure

books_volumes_mybooks_list(connection, optional_params \\ [], opts \\ [])

@spec books_volumes_mybooks_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Volumes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Return a list of books in My Library.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :acquireMethod (type: list(String.t)) - How the book was acquired
- :country (type: String.t) - ISO-3166-1 code to override the IP-based location.
- :locale (type: String.t) - ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.
- :maxResults (type: integer()) - Maximum number of results to return.
- :processingState (type: list(String.t)) - The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.
- :source (type: String.t) - String to identify the originator of this request.
- :startIndex (type: integer()) - Index of the first result to return (starts at 0)
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Volumes{}} on success
{:error, info} on failure

books_volumes_recommended_list(connection, optional_params \\ [], opts \\ [])

@spec books_volumes_recommended_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Volumes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Return a list of recommended books for the current user.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :locale (type: String.t) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- :maxAllowedMaturityRating (type: String.t) - The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
- :source (type: String.t) - String to identify the originator of this request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Volumes{}} on success
{:error, info} on failure

books_volumes_recommended_rate(connection, rating, volume_id, optional_params \\ [], opts \\ [])

@spec books_volumes_recommended_rate(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Books.V1.Model.BooksVolumesRecommendedRateResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Rate a recommended book for the current user.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
rating (type: String.t) - Rating to be given to the volume.
volume_id (type: String.t) - ID of the source volume.
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :locale (type: String.t) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- :source (type: String.t) - String to identify the originator of this request.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.BooksVolumesRecommendedRateResponse{}} on success
{:error, info} on failure

books_volumes_useruploaded_list(connection, optional_params \\ [], opts \\ [])

@spec books_volumes_useruploaded_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Volumes.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Return a list of books uploaded by the current user.

Parameters

connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :"$.xgafv" (type: String.t) - V1 error format.
- :access_token (type: String.t) - OAuth access token.
- :alt (type: String.t) - Data format for response.
- :callback (type: String.t) - JSONP
- :fields (type: String.t) - Selector specifying which fields to include in a partial response.
- :key (type: 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 (type: String.t) - OAuth 2.0 token for the current user.
- :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
- :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
- :locale (type: String.t) - ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
- :maxResults (type: integer()) - Maximum number of results to return.
- :processingState (type: list(String.t)) - The processing state of the user uploaded volumes to be returned.
- :source (type: String.t) - String to identify the originator of this request.
- :startIndex (type: integer()) - Index of the first result to return (starts at 0)
- :volumeId (type: list(String.t)) - The ids of the volumes to be returned. If not specified all that match the processingState are returned.
opts (type: keyword()) - Call options

Returns

{:ok, %GoogleApi.Books.V1.Model.Volumes{}} on success
{:error, info} on failure