Books API . mylibrary . readingpositions

Instance Methods

close()

Close httplib2 connections.

get(volumeId, contentVersion=None, source=None, x__xgafv=None)

Retrieves my reading position information for a volume.

setPosition(volumeId, position, timestamp, action=None, contentVersion=None, deviceCookie=None, source=None, x__xgafv=None)

Sets my reading position information for a volume.

Method Details

close()
Close httplib2 connections.
get(volumeId, contentVersion=None, source=None, x__xgafv=None)
Retrieves my reading position information for a volume.

Args:
  volumeId: string, ID of volume for which to retrieve a reading position. (required)
  contentVersion: string, Volume content version for which this reading position is requested.
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "epubCfiPosition": "A String", # Position in an EPUB as a CFI.
  "gbImagePosition": "A String", # Position in a volume for image-based content.
  "gbTextPosition": "A String", # Position in a volume for text-based content.
  "kind": "A String", # Resource type for a reading position.
  "pdfPosition": "A String", # Position in a PDF file.
  "updated": "A String", # Timestamp when this reading position was last updated (formatted UTC timestamp with millisecond resolution).
  "volumeId": "A String", # Volume id associated with this reading position.
}
setPosition(volumeId, position, timestamp, action=None, contentVersion=None, deviceCookie=None, source=None, x__xgafv=None)
Sets my reading position information for a volume.

Args:
  volumeId: string, ID of volume for which to update the reading position. (required)
  position: string, Position string for the new volume reading position. (required)
  timestamp: string, RFC 3339 UTC format timestamp associated with this reading position. (required)
  action: string, Action that caused this reading position to be set.
    Allowed values
      ACTION_UNDEFINED - 
      bookmark - User chose bookmark within volume.
      chapter - User selected chapter from list.
      next-page - Next page event.
      prev-page - Previous page event.
      scroll - User navigated to page.
      search - User chose search results within volume.
  contentVersion: string, Volume content version for which this reading position applies.
  deviceCookie: string, Random persistent device cookie optional on set position.
  source: string, String to identify the originator of this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}