Blame - docs/dyn/books_v1.mylibrary.bookshelves.html - platform/external/python/google-api-python-client

blob: f5a914fa3565e61fc8d1cac5ca5fd94daf08ade4 [file] [log] [blame]

John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.mylibrary.html">mylibrary</a> . <a href="books_v1.mylibrary.bookshelves.html">bookshelves</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="books_v1.mylibrary.bookshelves.volumes.html">volumes()</a></code>
				79	</p>
				80	<p class="firstline">Returns the volumes Resource.</p>
				81
				82	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	83	<code><a href="#addVolume">addVolume(shelf, volumeId, source=None, reason=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	84	<p class="firstline">Adds a volume to a bookshelf.</p>
				85	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	86	<code><a href="#clearVolumes">clearVolumes(shelf, source=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	87	<p class="firstline">Clears all volumes from a bookshelf.</p>
				88	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	89	<code><a href="#close">close()</a></code></p>
				90	<p class="firstline">Close httplib2 connections.</p>
				91	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	92	<code><a href="#get">get(shelf, source=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	93	<p class="firstline">Retrieves metadata for a specific bookshelf belonging to the authenticated user.</p>
				94	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	95	<code><a href="#list">list(source=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	96	<p class="firstline">Retrieves a list of bookshelves belonging to the authenticated user.</p>
				97	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	98	<code><a href="#moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	99	<p class="firstline">Moves a volume within a bookshelf.</p>
				100	<p class="toc_element">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	101	<code><a href="#removeVolume">removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	102	<p class="firstline">Removes a volume from a bookshelf.</p>
				103	<h3>Method Details</h3>
				104	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	105	<code class="details" id="addVolume">addVolume(shelf, volumeId, source=None, reason=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	106	<pre>Adds a volume to a bookshelf.
				107
				108	Args:
				109	shelf: string, ID of bookshelf to which to add a volume. (required)
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	110	volumeId: string, ID of volume to add. (required)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	111	source: string, String to identify the originator of this request.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	112	reason: string, The reason for which the book is added to the library.
				113	Allowed values
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	114	REASON_UNDEFINED -
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	115	IOS_PREX - Volumes added from the PREX flow on iOS.
				116	IOS_SEARCH - Volumes added from the Search flow on iOS.
				117	ONBOARDING - Volumes added from the Onboarding flow.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	118	x__xgafv: string, V1 error format.
				119	Allowed values
				120	1 - v1 error format
				121	2 - v2 error format
				122
				123	Returns:
				124	An object of the form:
				125
				126	{ # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
				127	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	128	</div>
				129
				130	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	131	<code class="details" id="clearVolumes">clearVolumes(shelf, source=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	132	<pre>Clears all volumes from a bookshelf.
				133
				134	Args:
				135	shelf: string, ID of bookshelf from which to remove a volume. (required)
				136	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	137	x__xgafv: string, V1 error format.
				138	Allowed values
				139	1 - v1 error format
				140	2 - v2 error format
				141
				142	Returns:
				143	An object of the form:
				144
				145	{ # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
				146	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	147	</div>
				148
				149	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	150	<code class="details" id="close">close()</code>
				151	<pre>Close httplib2 connections.</pre>
				152	</div>
				153
				154	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	155	<code class="details" id="get">get(shelf, source=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	156	<pre>Retrieves metadata for a specific bookshelf belonging to the authenticated user.
				157
				158	Args:
				159	shelf: string, ID of bookshelf to retrieve. (required)
				160	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	161	x__xgafv: string, V1 error format.
				162	Allowed values
				163	1 - v1 error format
				164	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	165
				166	Returns:
				167	An object of the form:
				168
				169	{
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	170	"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	171	"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	172	"id": 42, # Id of this bookshelf, only unique by user.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	173	"kind": "A String", # Resource type for bookshelf metadata.
				174	"selfLink": "A String", # URL to this resource.
				175	"description": "A String", # Description of this bookshelf.
				176	"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
				177	"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
				178	"title": "A String", # Title of this bookshelf.
				179	"volumeCount": 42, # Number of volumes in this bookshelf.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	180	}</pre>
				181	</div>
				182
				183	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	184	<code class="details" id="list">list(source=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	185	<pre>Retrieves a list of bookshelves belonging to the authenticated user.
				186
				187	Args:
				188	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	189	x__xgafv: string, V1 error format.
				190	Allowed values
				191	1 - v1 error format
				192	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	193
				194	Returns:
				195	An object of the form:
				196
				197	{
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	198	"kind": "A String", # Resource type.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	199	"items": [ # A list of bookshelves.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	200	{
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame]	201	"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	202	"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	203	"id": 42, # Id of this bookshelf, only unique by user.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	204	"kind": "A String", # Resource type for bookshelf metadata.
				205	"selfLink": "A String", # URL to this resource.
				206	"description": "A String", # Description of this bookshelf.
				207	"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
				208	"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
				209	"title": "A String", # Title of this bookshelf.
				210	"volumeCount": 42, # Number of volumes in this bookshelf.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	211	},
				212	],
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	213	}</pre>
				214	</div>
				215
				216	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	217	<code class="details" id="moveVolume">moveVolume(shelf, volumeId, volumePosition, source=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	218	<pre>Moves a volume within a bookshelf.
				219
				220	Args:
				221	shelf: string, ID of bookshelf with the volume. (required)
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	222	volumeId: string, ID of volume to move. (required)
				223	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)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	224	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	225	x__xgafv: string, V1 error format.
				226	Allowed values
				227	1 - v1 error format
				228	2 - v2 error format
				229
				230	Returns:
				231	An object of the form:
				232
				233	{ # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
				234	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	235	</div>
				236
				237	<div class="method">
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	238	<code class="details" id="removeVolume">removeVolume(shelf, volumeId, reason=None, source=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	239	<pre>Removes a volume from a bookshelf.
				240
				241	Args:
				242	shelf: string, ID of bookshelf from which to remove a volume. (required)
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	243	volumeId: string, ID of volume to remove. (required)
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	244	reason: string, The reason for which the book is removed from the library.
				245	Allowed values
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	246	REASON_UNDEFINED -
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	247	ONBOARDING - Samples removed from the Onboarding flow.
Yoshi Automation Bot	0d561ef	2020-11-25 07:50:41 -0800	[diff] [blame]	248	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	249	x__xgafv: string, V1 error format.
				250	Allowed values
				251	1 - v1 error format
				252	2 - v2 error format
				253
				254	Returns:
				255	An object of the form:
				256
				257	{ # 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); } The JSON representation for `Empty` is empty JSON object `{}`.
				258	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	259	</div>
				260
				261	</body></html>