google_api_books v0.2.0 GoogleApi.Books.V1.Api.Volumes View Source

API calls for all endpoints tagged Volumes.

Link to this section Summary

Link to this section Functions

Link to this function books_volumes_associated_list(connection, volume_id, optional_params \\ [], opts \\ []) View Source

Return a list of associated books.

Parameters

  • connection (GoogleApi.Books.V1.Connection): Connection to server
  • volume_id (String.t): ID of the source volume.
  • optional_params (KeywordList): [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.
    • :association (String.t): Association type.
    • :locale (String.t): ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
    • :maxAllowedMaturityRating (String.t): The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
    • :source (String.t): String to identify the originator of this request.

Returns

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

Link to this function books_volumes_get(connection, volume_id, optional_params \\ [], opts \\ []) View Source

Gets volume information for a single volume.

Parameters

  • connection (GoogleApi.Books.V1.Connection): Connection to server
  • volume_id (String.t): ID of volume to retrieve.
  • optional_params (KeywordList): [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.
    • :country (String.t): ISO-3166-1 code to override the IP-based location.
    • :includeNonComicsSeries (boolean()): Set to true to include non-comics series. Defaults to false.
    • :partner (String.t): Brand results for partner ID.
    • :projection (String.t): Restrict information returned to a set of selected fields.
    • :source (String.t): String to identify the originator of this request.
    • :user_library_consistent_read (boolean()):

Returns

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

Link to this function books_volumes_list(connection, q, optional_params \\ [], opts \\ []) View Source

Performs a book search.

Parameters

  • connection (GoogleApi.Books.V1.Connection): Connection to server
  • q (String.t): Full-text search query string.
  • optional_params (KeywordList): [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.
    • :download (String.t): Restrict to volumes by download availability.
    • :filter (String.t): Filter search results.
    • :langRestrict (String.t): Restrict results to books with this language code.
    • :libraryRestrict (String.t): Restrict search to this user's library.
    • :maxAllowedMaturityRating (String.t): The maximum allowed maturity rating of returned recommendations. Books with a higher maturity rating are filtered out.
    • :maxResults (integer()): Maximum number of results to return.
    • :orderBy (String.t): Sort search results.
    • :partner (String.t): Restrict and brand results for partner ID.
    • :printType (String.t): Restrict to books or magazines.
    • :projection (String.t): Restrict information returned to a set of selected fields.
    • :showPreorders (boolean()): Set to true to show books available for preorder. Defaults to false.
    • :source (String.t): String to identify the originator of this request.
    • :startIndex (integer()): Index of the first result to return (starts at 0)

Returns

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

Link to this function books_volumes_mybooks_list(connection, optional_params \\ [], opts \\ []) View Source

Return a list of books in My Library.

Parameters

  • connection (GoogleApi.Books.V1.Connection): Connection to server
  • optional_params (KeywordList): [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.
    • :acquireMethod ([String.t]): How the book was acquired
    • :country (String.t): ISO-3166-1 code to override the IP-based location.
    • :locale (String.t): ISO-639-1 language and ISO-3166-1 country code. Ex:'en_US'. Used for generating recommendations.
    • :maxResults (integer()): Maximum number of results to return.
    • :processingState ([String.t]): The processing state of the user uploaded volumes to be returned. Applicable only if the UPLOADED is specified in the acquireMethod.
    • :source (String.t): String to identify the originator of this request.
    • :startIndex (integer()): Index of the first result to return (starts at 0)

Returns

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

Link to this function books_volumes_useruploaded_list(connection, optional_params \\ [], opts \\ []) View Source

Return a list of books uploaded by the current user.

Parameters

  • connection (GoogleApi.Books.V1.Connection): Connection to server
  • optional_params (KeywordList): [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.
    • :locale (String.t): ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'. Used for generating recommendations.
    • :maxResults (integer()): Maximum number of results to return.
    • :processingState ([String.t]): The processing state of the user uploaded volumes to be returned.
    • :source (String.t): String to identify the originator of this request.
    • :startIndex (integer()): Index of the first result to return (starts at 0)
    • :volumeId ([String.t]): The ids of the volumes to be returned. If not specified all that match the processingState are returned.

Returns

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