google_api_books v0.2.0 GoogleApi.Books.V1.Api.Mylibrary View Source
API calls for all endpoints tagged Mylibrary
.
Link to this section Summary
Functions
Deletes an annotation
Inserts a new annotation
Retrieves a list of annotations, possibly filtered
Gets the summary of specified layers
Updates an existing annotation
Adds a volume to a bookshelf
Clears all volumes from a bookshelf
Retrieves metadata for a specific bookshelf belonging to the authenticated user
Retrieves a list of bookshelves belonging to the authenticated user
Moves a volume within a bookshelf
Removes a volume from a bookshelf
Gets volume information for volumes on a bookshelf
Retrieves my reading position information for a volume
Sets my reading position information for a volume
Link to this section Functions
Deletes an annotation.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- annotation_id (String.t): The ID for the annotation to delete.
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.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %{}} on success {:error, info} on failure
Inserts a new annotation.
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.
- :annotationId (String.t): The ID for the annotation to insert.
- :country (String.t): ISO-3166-1 code to override the IP-based location.
- :showOnlySummaryInResponse (boolean()): Requests that only the summary of the specified layer be provided in the response.
- :source (String.t): String to identify the originator of this request.
- :body (Annotation):
Returns
{:ok, %GoogleApi.Books.V1.Model.Annotation{}} on success {:error, info} on failure
Retrieves a list of annotations, possibly filtered.
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.
- :contentVersion (String.t): The content version for the requested volume.
- :layerId (String.t): The layer ID to limit annotation by.
- :layerIds ([String.t]): The layer ID(s) to limit annotation by.
- :maxResults (integer()): Maximum number of results to return
- :pageToken (String.t): The value of the nextToken from the previous page.
- :showDeleted (boolean()): Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
- :source (String.t): String to identify the originator of this request.
- :updatedMax (String.t): RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
- :updatedMin (String.t): RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
- :volumeId (String.t): The volume to restrict annotations to.
Returns
{:ok, %GoogleApi.Books.V1.Model.Annotations{}} on success {:error, info} on failure
Gets the summary of specified layers.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- layer_ids ([String.t]): Array of layer IDs to get the summary for.
- volume_id (String.t): Volume id to get the summary for.
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.
Returns
{:ok, %GoogleApi.Books.V1.Model.AnnotationsSummary{}} on success {:error, info} on failure
Updates an existing annotation.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- annotation_id (String.t): The ID for the annotation to update.
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.
- :source (String.t): String to identify the originator of this request.
- :body (Annotation):
Returns
{:ok, %GoogleApi.Books.V1.Model.Annotation{}} on success {:error, info} on failure
Adds a volume to a bookshelf.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- shelf (String.t): ID of bookshelf to which to add a volume.
- volume_id (String.t): ID of volume to add.
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.
- :reason (String.t): The reason for which the book is added to the library.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %{}} on success {:error, info} on failure
Clears all volumes from a bookshelf.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- shelf (String.t): ID of bookshelf from which to remove a 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.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %{}} on success {:error, info} on failure
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- shelf (String.t): ID of bookshelf 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.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %GoogleApi.Books.V1.Model.Bookshelf{}} on success {:error, info} on failure
Retrieves a list of bookshelves belonging to the authenticated 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.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %GoogleApi.Books.V1.Model.Bookshelves{}} on success {:error, info} on failure
Moves a volume within a bookshelf.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- shelf (String.t): ID of bookshelf with the volume.
- volume_id (String.t): ID of volume to move.
- volume_position (integer()): Position on shelf to move the item (0 puts the item before the current first item, 1 puts it between the first and the second and so on.)
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.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %{}} on success {:error, info} on failure
Removes a volume from a bookshelf.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- shelf (String.t): ID of bookshelf from which to remove a volume.
- volume_id (String.t): ID of volume to remove.
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.
- :reason (String.t): The reason for which the book is removed from the library.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %{}} on success {:error, info} on failure
Gets volume information for volumes on a bookshelf.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- shelf (String.t): The bookshelf ID or name retrieve volumes for.
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.
- :maxResults (integer()): Maximum number of results to return
- :projection (String.t): Restrict information returned to a set of selected fields.
- :q (String.t): Full-text search query string in this bookshelf.
- :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
Retrieves my reading position information for a volume.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- volume_id (String.t): ID of volume for which to retrieve a reading position.
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.
- :contentVersion (String.t): Volume content version for which this reading position is requested.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %GoogleApi.Books.V1.Model.ReadingPosition{}} on success {:error, info} on failure
Sets my reading position information for a volume.
Parameters
- connection (GoogleApi.Books.V1.Connection): Connection to server
- volume_id (String.t): ID of volume for which to update the reading position.
- timestamp (String.t): RFC 3339 UTC format timestamp associated with this reading position.
- position (String.t): Position string for the new volume reading position.
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.
- :action (String.t): Action that caused this reading position to be set.
- :contentVersion (String.t): Volume content version for which this reading position applies.
- :deviceCookie (String.t): Random persistent device cookie optional on set position.
- :source (String.t): String to identify the originator of this request.
Returns
{:ok, %{}} on success {:error, info} on failure