google_api_books v0.8.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
books_mylibrary_annotations_delete(connection, annotation_id, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_annotations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Deletes an annotation.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to serverannotation_id
(type:String.t
) - The ID for the annotation to delete.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:source
(type:String.t
) - String to identify the originator of this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
books_mylibrary_annotations_insert(connection, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_annotations_insert(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Books.V1.Model.Annotation.t()} | {:error, Tesla.Env.t()}
Inserts a new annotation.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:annotationId
(type:String.t
) - The ID for the annotation to insert.:country
(type:String.t
) - ISO-3166-1 code to override the IP-based location.:showOnlySummaryInResponse
(type:boolean()
) - Requests that only the summary of the specified layer be provided in the response.:source
(type:String.t
) - String to identify the originator of this request.:body
(type:GoogleApi.Books.V1.Model.Annotation.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.Annotation{}}
on success{:error, info}
on failure
books_mylibrary_annotations_list(connection, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_annotations_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Books.V1.Model.Annotations.t()} | {:error, Tesla.Env.t()}
Retrieves a list of annotations, possibly filtered.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:contentVersion
(type:String.t
) - The content version for the requested volume.:layerId
(type:String.t
) - The layer ID to limit annotation by.:layerIds
(type:list(String.t)
) - The layer ID(s) to limit annotation by.:maxResults
(type:integer()
) - Maximum number of results to return:pageToken
(type:String.t
) - The value of the nextToken from the previous page.:showDeleted
(type:boolean()
) - Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.:source
(type:String.t
) - String to identify the originator of this request.:updatedMax
(type:String.t
) - RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).:updatedMin
(type:String.t
) - RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).:volumeId
(type:String.t
) - The volume to restrict annotations to.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.Annotations{}}
on success{:error, info}
on failure
books_mylibrary_annotations_summary(connection, layer_ids, volume_id, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_annotations_summary( Tesla.Env.client(), [String.t()], String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Books.V1.Model.AnnotationsSummary.t()} | {:error, Tesla.Env.t()}
Gets the summary of specified layers.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to serverlayer_ids
(type:list(String.t)
) - Array of layer IDs to get the summary for.volume_id
(type:String.t
) - Volume id to get the summary for.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.AnnotationsSummary{}}
on success{:error, info}
on failure
books_mylibrary_annotations_update(connection, annotation_id, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_annotations_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Books.V1.Model.Annotation.t()} | {:error, Tesla.Env.t()}
Updates an existing annotation.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to serverannotation_id
(type:String.t
) - The ID for the annotation to update.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:source
(type:String.t
) - String to identify the originator of this request.:body
(type:GoogleApi.Books.V1.Model.Annotation.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.Annotation{}}
on success{:error, info}
on failure
books_mylibrary_bookshelves_add_volume(connection, shelf, volume_id, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_bookshelves_add_volume( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Adds a volume to a bookshelf.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to servershelf
(type:String.t
) - ID of bookshelf to which to add a volume.volume_id
(type:String.t
) - ID of volume to add.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:reason
(type:String.t
) - The reason for which the book is added to the library.:source
(type:String.t
) - String to identify the originator of this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
books_mylibrary_bookshelves_clear_volumes(connection, shelf, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_bookshelves_clear_volumes( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Clears all volumes from a bookshelf.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to servershelf
(type:String.t
) - ID of bookshelf from which to remove a volume.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:source
(type:String.t
) - String to identify the originator of this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
books_mylibrary_bookshelves_get(connection, shelf, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_bookshelves_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Books.V1.Model.Bookshelf.t()} | {:error, Tesla.Env.t()}
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to servershelf
(type:String.t
) - ID of bookshelf to retrieve.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:source
(type:String.t
) - String to identify the originator of this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.Bookshelf{}}
on success{:error, info}
on failure
books_mylibrary_bookshelves_list(connection, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_bookshelves_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Books.V1.Model.Bookshelves.t()} | {:error, Tesla.Env.t()}
Retrieves a list of bookshelves belonging to the authenticated user.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:source
(type:String.t
) - String to identify the originator of this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.Bookshelves{}}
on success{:error, info}
on failure
books_mylibrary_bookshelves_move_volume(connection, shelf, volume_id, volume_position, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_bookshelves_move_volume( Tesla.Env.client(), String.t(), String.t(), integer(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Moves a volume within a bookshelf.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to servershelf
(type:String.t
) - ID of bookshelf with the volume.volume_id
(type:String.t
) - ID of volume to move.volume_position
(type: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
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:source
(type:String.t
) - String to identify the originator of this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
books_mylibrary_bookshelves_remove_volume(connection, shelf, volume_id, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_bookshelves_remove_volume( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Removes a volume from a bookshelf.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to servershelf
(type:String.t
) - ID of bookshelf from which to remove a volume.volume_id
(type:String.t
) - ID of volume to remove.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:reason
(type:String.t
) - The reason for which the book is removed from the library.:source
(type:String.t
) - String to identify the originator of this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
books_mylibrary_bookshelves_volumes_list(connection, shelf, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_bookshelves_volumes_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Books.V1.Model.Volumes.t()} | {:error, Tesla.Env.t()}
Gets volume information for volumes on a bookshelf.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to servershelf
(type:String.t
) - The bookshelf ID or name retrieve volumes for.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:country
(type:String.t
) - ISO-3166-1 code to override the IP-based location.:maxResults
(type:integer()
) - Maximum number of results to return:projection
(type:String.t
) - Restrict information returned to a set of selected fields.:q
(type:String.t
) - Full-text search query string in this bookshelf.:showPreorders
(type:boolean()
) - Set to true to show pre-ordered books. Defaults to false.:source
(type:String.t
) - String to identify the originator of this request.:startIndex
(type:integer()
) - Index of the first element to return (starts at 0)
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.Volumes{}}
on success{:error, info}
on failure
books_mylibrary_readingpositions_get(connection, volume_id, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_readingpositions_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Books.V1.Model.ReadingPosition.t()} | {:error, Tesla.Env.t()}
Retrieves my reading position information for a volume.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to servervolume_id
(type:String.t
) - ID of volume for which to retrieve a reading position.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:contentVersion
(type:String.t
) - Volume content version for which this reading position is requested.:source
(type:String.t
) - String to identify the originator of this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.Books.V1.Model.ReadingPosition{}}
on success{:error, info}
on failure
books_mylibrary_readingpositions_set_position(connection, volume_id, timestamp, position, optional_params \\ [], opts \\ [])
View Sourcebooks_mylibrary_readingpositions_set_position( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Sets my reading position information for a volume.
Parameters
connection
(type:GoogleApi.Books.V1.Connection.t
) - Connection to servervolume_id
(type:String.t
) - ID of volume for which to update the reading position.timestamp
(type:String.t
) - RFC 3339 UTC format timestamp associated with this reading position.position
(type:String.t
) - Position string for the new volume reading position.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:action
(type:String.t
) - Action that caused this reading position to be set.:contentVersion
(type:String.t
) - Volume content version for which this reading position applies.:deviceCookie
(type:String.t
) - Random persistent device cookie optional on set position.:source
(type:String.t
) - String to identify the originator of this request.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure