Returns the volumes Resource.
addVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)
Adds a volume to a bookshelf.
clearVolumes(shelf, source=None, x__xgafv=None)
Clears all volumes from a bookshelf.
Close httplib2 connections.
get(shelf, source=None, x__xgafv=None)
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
list(source=None, x__xgafv=None)
Retrieves a list of bookshelves belonging to the authenticated user.
moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)
Moves a volume within a bookshelf.
removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)
Removes a volume from a bookshelf.
addVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)
Adds a volume to a bookshelf.
Args:
shelf: string, ID of bookshelf to which to add a volume. (required)
volumeId: string, ID of volume to add. (required)
reason: string, The reason for which the book is added to the library.
Allowed values
REASON_UNDEFINED -
IOS_PREX - Volumes added from the PREX flow on iOS.
IOS_SEARCH - Volumes added from the Search flow on iOS.
ONBOARDING - Volumes added from the Onboarding flow.
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); }
}
clearVolumes(shelf, source=None, x__xgafv=None)
Clears all volumes from a bookshelf.
Args:
shelf: string, ID of bookshelf from which to remove a volume. (required)
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); }
}
close()
Close httplib2 connections.
get(shelf, source=None, x__xgafv=None)
Retrieves metadata for a specific bookshelf belonging to the authenticated user.
Args:
shelf: string, ID of bookshelf to retrieve. (required)
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:
{
"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
"description": "A String", # Description of this bookshelf.
"id": 42, # Id of this bookshelf, only unique by user.
"kind": "A String", # Resource type for bookshelf metadata.
"selfLink": "A String", # URL to this resource.
"title": "A String", # Title of this bookshelf.
"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
"volumeCount": 42, # Number of volumes in this bookshelf.
"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
}
list(source=None, x__xgafv=None)
Retrieves a list of bookshelves belonging to the authenticated user.
Args:
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:
{
"items": [ # A list of bookshelves.
{
"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
"description": "A String", # Description of this bookshelf.
"id": 42, # Id of this bookshelf, only unique by user.
"kind": "A String", # Resource type for bookshelf metadata.
"selfLink": "A String", # URL to this resource.
"title": "A String", # Title of this bookshelf.
"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
"volumeCount": 42, # Number of volumes in this bookshelf.
"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
},
],
"kind": "A String", # Resource type.
}
moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)
Moves a volume within a bookshelf.
Args:
shelf: string, ID of bookshelf with the volume. (required)
volumeId: string, ID of volume to move. (required)
volumePosition: 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.) (required)
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); }
}
removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)
Removes a volume from a bookshelf.
Args:
shelf: string, ID of bookshelf from which to remove a volume. (required)
volumeId: string, ID of volume to remove. (required)
reason: string, The reason for which the book is removed from the library.
Allowed values
REASON_UNDEFINED -
ONBOARDING - Samples removed from the Onboarding flow.
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); }
}