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

API calls for all endpoints tagged Mylibrary.

Summary

Functions

Retrieves a list of annotations, possibly filtered.

Retrieves metadata for a specific bookshelf belonging to the authenticated user.

Retrieves a list of bookshelves belonging to the authenticated user.

Functions

Link to this function

books_mylibrary_annotations_delete(connection, annotation_id, optional_params \\ [], opts \\ [])

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

Deletes an annotation.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • annotation_id (type: String.t) - The ID for the annotation to delete.
  • 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").
    • :source (type: String.t) - String to identify the originator of this request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Books.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
@spec books_mylibrary_annotations_insert(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Annotation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Inserts a new annotation.

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").
    • :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
Link to this function

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

View Source
@spec books_mylibrary_annotations_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Annotations.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of annotations, possibly filtered.

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").
    • :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
Link to this function

books_mylibrary_annotations_summary(connection, layer_ids, volume_id, optional_params \\ [], opts \\ [])

View Source
@spec books_mylibrary_annotations_summary(
  Tesla.Env.client(),
  [String.t()],
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Books.V1.Model.AnnotationsSummary.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the summary of specified layers.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • layer_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
    • :"$.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").
    • :source (type: String.t) - Optional. String to identify the originator of this request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Books.V1.Model.AnnotationsSummary{}} on success
  • {:error, info} on failure
Link to this function

books_mylibrary_annotations_update(connection, annotation_id, optional_params \\ [], opts \\ [])

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

Updates an existing annotation.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • annotation_id (type: String.t) - The ID for the annotation to update.
  • 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").
    • :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
Link to this function

books_mylibrary_bookshelves_add_volume(connection, shelf, volume_id, optional_params \\ [], opts \\ [])

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

Adds a volume to a bookshelf.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • shelf (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
    • :"$.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").
    • :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, %GoogleApi.Books.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

books_mylibrary_bookshelves_clear_volumes(connection, shelf, optional_params \\ [], opts \\ [])

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

Clears all volumes from a bookshelf.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • shelf (type: String.t) - ID of bookshelf from which to remove a 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").
    • :source (type: String.t) - String to identify the originator of this request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Books.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

books_mylibrary_bookshelves_get(connection, shelf, optional_params \\ [], opts \\ [])

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

Retrieves metadata for a specific bookshelf belonging to the authenticated user.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • shelf (type: String.t) - ID of bookshelf 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").
    • :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
Link to this function

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

View Source
@spec books_mylibrary_bookshelves_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Books.V1.Model.Bookshelves.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a list of bookshelves belonging to the authenticated 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").
    • :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
Link to this function

books_mylibrary_bookshelves_move_volume(connection, shelf, volume_id, volume_position, optional_params \\ [], opts \\ [])

View Source
@spec books_mylibrary_bookshelves_move_volume(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  integer(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Books.V1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Moves a volume within a bookshelf.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • shelf (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
    • :"$.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").
    • :source (type: String.t) - String to identify the originator of this request.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Books.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

books_mylibrary_bookshelves_remove_volume(connection, shelf, volume_id, optional_params \\ [], opts \\ [])

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

Removes a volume from a bookshelf.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • shelf (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
    • :"$.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").
    • :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, %GoogleApi.Books.V1.Model.Empty{}} on success
  • {:error, info} on failure
Link to this function

books_mylibrary_bookshelves_volumes_list(connection, shelf, optional_params \\ [], opts \\ [])

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

Gets volume information for volumes on a bookshelf.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • shelf (type: String.t) - The bookshelf ID or name retrieve volumes for.
  • 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.
    • :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
Link to this function

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

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

Retrieves my reading position information for a volume.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • volume_id (type: String.t) - ID of volume for which to retrieve a reading position.
  • 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").
    • :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
Link to this function

books_mylibrary_readingpositions_set_position(connection, volume_id, position, timestamp, optional_params \\ [], opts \\ [])

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

Sets my reading position information for a volume.

Parameters

  • connection (type: GoogleApi.Books.V1.Connection.t) - Connection to server
  • volume_id (type: String.t) - ID of volume for which to update the reading position.
  • position (type: String.t) - Position string for the new volume reading position.
  • timestamp (type: String.t) - RFC 3339 UTC format timestamp associated with this reading position.
  • 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").
    • :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, %GoogleApi.Books.V1.Model.Empty{}} on success
  • {:error, info} on failure