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

blob: bdb4e350dd000d79243c6669e8d348fe978328e0 [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">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	83	<code><a href="#addVolume">addVolume(shelf, source=None, reason=None, volumeId=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">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	89	<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]	90	<p class="firstline">Retrieves metadata for a specific bookshelf belonging to the authenticated user.</p>
				91	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	92	<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]	93	<p class="firstline">Retrieves a list of bookshelves 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="#moveVolume">moveVolume(shelf, volumePosition=None, volumeId=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	96	<p class="firstline">Moves a volume within a bookshelf.</p>
				97	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	98	<code><a href="#removeVolume">removeVolume(shelf, reason=None, source=None, volumeId=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	99	<p class="firstline">Removes a volume from a bookshelf.</p>
				100	<h3>Method Details</h3>
				101	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	102	<code class="details" id="addVolume">addVolume(shelf, source=None, reason=None, volumeId=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	103	<pre>Adds a volume to a bookshelf.
				104
				105	Args:
				106	shelf: string, ID of bookshelf to which to add a volume. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	107	source: string, String to identify the originator of this request.
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	108	reason: string, The reason for which the book is added to the library.
				109	Allowed values
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	110	REASON_UNDEFINED -
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	111	IOS_PREX - Volumes added from the PREX flow on iOS.
				112	IOS_SEARCH - Volumes added from the Search flow on iOS.
				113	ONBOARDING - Volumes added from the Onboarding flow.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	114	volumeId: string, ID of volume to add.
				115	x__xgafv: string, V1 error format.
				116	Allowed values
				117	1 - v1 error format
				118	2 - v2 error format
				119
				120	Returns:
				121	An object of the form:
				122
				123	{ # 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 `{}`.
				124	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	125	</div>
				126
				127	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	128	<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]	129	<pre>Clears all volumes from a bookshelf.
				130
				131	Args:
				132	shelf: string, ID of bookshelf from which to remove a volume. (required)
				133	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	134	x__xgafv: string, V1 error format.
				135	Allowed values
				136	1 - v1 error format
				137	2 - v2 error format
				138
				139	Returns:
				140	An object of the form:
				141
				142	{ # 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 `{}`.
				143	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	144	</div>
				145
				146	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	147	<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]	148	<pre>Retrieves metadata for a specific bookshelf belonging to the authenticated user.
				149
				150	Args:
				151	shelf: string, ID of bookshelf to retrieve. (required)
				152	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	153	x__xgafv: string, V1 error format.
				154	Allowed values
				155	1 - v1 error format
				156	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	157
				158	Returns:
				159	An object of the form:
				160
				161	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	162	"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	163	"selfLink": "A String", # URL to this resource.
				164	"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
				165	"title": "A String", # Title of this bookshelf.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	166	"volumeCount": 42, # Number of volumes in this bookshelf.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	167	"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
				168	"id": 42, # Id of this bookshelf, only unique by user.
				169	"kind": "A String", # Resource type for bookshelf metadata.
				170	"description": "A String", # Description of this bookshelf.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	171	"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	172	}</pre>
				173	</div>
				174
				175	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	176	<code class="details" id="list">list(source=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	177	<pre>Retrieves a list of bookshelves belonging to the authenticated user.
				178
				179	Args:
				180	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	181	x__xgafv: string, V1 error format.
				182	Allowed values
				183	1 - v1 error format
				184	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	185
				186	Returns:
				187	An object of the form:
				188
				189	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	190	"items": [ # A list of bookshelves.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	191	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	192	"updated": "A String", # Last modified time of this bookshelf (formatted UTC timestamp with millisecond resolution).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	193	"selfLink": "A String", # URL to this resource.
				194	"access": "A String", # Whether this bookshelf is PUBLIC or PRIVATE.
				195	"title": "A String", # Title of this bookshelf.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	196	"volumeCount": 42, # Number of volumes in this bookshelf.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	197	"created": "A String", # Created time for this bookshelf (formatted UTC timestamp with millisecond resolution).
				198	"id": 42, # Id of this bookshelf, only unique by user.
				199	"kind": "A String", # Resource type for bookshelf metadata.
				200	"description": "A String", # Description of this bookshelf.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	201	"volumesLastUpdated": "A String", # Last time a volume was added or removed from this bookshelf (formatted UTC timestamp with millisecond resolution).
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	202	},
				203	],
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	204	"kind": "A String", # Resource type.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	205	}</pre>
				206	</div>
				207
				208	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	209	<code class="details" id="moveVolume">moveVolume(shelf, volumePosition=None, volumeId=None, source=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	210	<pre>Moves a volume within a bookshelf.
				211
				212	Args:
				213	shelf: string, ID of bookshelf with the volume. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	214	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.)
				215	volumeId: string, ID of volume to move.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	216	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	217	x__xgafv: string, V1 error format.
				218	Allowed values
				219	1 - v1 error format
				220	2 - v2 error format
				221
				222	Returns:
				223	An object of the form:
				224
				225	{ # 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 `{}`.
				226	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	227	</div>
				228
				229	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	230	<code class="details" id="removeVolume">removeVolume(shelf, reason=None, source=None, volumeId=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	231	<pre>Removes a volume from a bookshelf.
				232
				233	Args:
				234	shelf: string, ID of bookshelf from which to remove a volume. (required)
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	235	reason: string, The reason for which the book is removed from the library.
				236	Allowed values
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	237	REASON_UNDEFINED -
Craig Citro	e633be1	2015-03-02 13:40:36 -0800	[diff] [blame]	238	ONBOARDING - Samples removed from the Onboarding flow.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	239	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	240	volumeId: string, ID of volume to remove.
				241	x__xgafv: string, V1 error format.
				242	Allowed values
				243	1 - v1 error format
				244	2 - v2 error format
				245
				246	Returns:
				247	An object of the form:
				248
				249	{ # 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 `{}`.
				250	}</pre>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	251	</div>
				252
				253	</body></html>