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

blob: cdfed78cfee75cbfdea30fe4b48190e59e9008e5 [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.layers.html">layers</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="books_v1.layers.annotationData.html">annotationData()</a></code>
				79	</p>
				80	<p class="firstline">Returns the annotationData Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="books_v1.layers.volumeAnnotations.html">volumeAnnotations()</a></code>
				84	</p>
				85	<p class="firstline">Returns the volumeAnnotations Resource.</p>
				86
				87	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	88	<code><a href="#get">get(volumeId, summaryId, contentVersion=None, source=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	89	<p class="firstline">Gets the layer summary for a volume.</p>
				90	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	91	<code><a href="#list">list(volumeId, pageToken=None, contentVersion=None, source=None, maxResults=None, x__xgafv=None)</a></code></p>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	92	<p class="firstline">List the layer summaries for a volume.</p>
				93	<h3>Method Details</h3>
				94	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	95	<code class="details" id="get">get(volumeId, summaryId, contentVersion=None, source=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	96	<pre>Gets the layer summary for a volume.
				97
				98	Args:
				99	volumeId: string, The volume to retrieve layers for. (required)
				100	summaryId: string, The ID for the layer to get the summary for. (required)
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	101	contentVersion: string, The content version for the requested volume.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	102	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	103	x__xgafv: string, V1 error format.
				104	Allowed values
				105	1 - v1 error format
				106	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	107
				108	Returns:
				109	An object of the form:
				110
				111	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	112	"id": "A String", # Unique id of this layer summary.
				113	"contentVersion": "A String", # The content version this resource is for.
				114	"annotationsDataLink": "A String", # Link to get data for this annotation.
				115	"kind": "A String", # Resource Type
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	116	"annotationTypes": [ # The list of annotation types contained for this layer.
				117	"A String",
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	118	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	119	"updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	120	"layerId": "A String", # The layer id for this summary.
				121	"dataCount": 42, # The number of data items for this layer.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	122	"volumeId": "A String", # The volume id this resource is for.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	123	"annotationCount": 42, # The number of annotations for this layer.
				124	"annotationsLink": "A String", # The link to get the annotations for this layer.
				125	"selfLink": "A String", # URL to this resource.
				126	"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	127	}</pre>
				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="list">list(volumeId, pageToken=None, contentVersion=None, source=None, maxResults=None, x__xgafv=None)</code>
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	132	<pre>List the layer summaries for a volume.
				133
				134	Args:
				135	volumeId: string, The volume to retrieve layers for. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	136	pageToken: string, The value of the nextToken from the previous page.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	137	contentVersion: string, The content version for the requested volume.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	138	source: string, String to identify the originator of this request.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	139	maxResults: integer, Maximum number of results to return
				140	x__xgafv: string, V1 error format.
				141	Allowed values
				142	1 - v1 error format
				143	2 - v2 error format
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	144
				145	Returns:
				146	An object of the form:
				147
				148	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	149	"kind": "A String", # Resource type.
				150	"totalItems": 42, # The total number of layer summaries found.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	151	"items": [ # A list of layer summary items.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	152	{
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	153	"id": "A String", # Unique id of this layer summary.
				154	"contentVersion": "A String", # The content version this resource is for.
				155	"annotationsDataLink": "A String", # Link to get data for this annotation.
				156	"kind": "A String", # Resource Type
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	157	"annotationTypes": [ # The list of annotation types contained for this layer.
				158	"A String",
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	159	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	"updated": "A String", # Timestamp for the last time an item in this layer was updated. (RFC 3339 UTC date-time format).
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	161	"layerId": "A String", # The layer id for this summary.
				162	"dataCount": 42, # The number of data items for this layer.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	163	"volumeId": "A String", # The volume id this resource is for.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	164	"annotationCount": 42, # The number of annotations for this layer.
				165	"annotationsLink": "A String", # The link to get the annotations for this layer.
				166	"selfLink": "A String", # URL to this resource.
				167	"volumeAnnotationsVersion": "A String", # The current version of this layer's volume annotations. Note that this version applies only to the data in the books.layers.volumeAnnotations.* responses. The actual annotation data is versioned separately.
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	168	},
				169	],
John Asmuth	614db98	2014-04-24 15:46:26 -0400	[diff] [blame]	170	}</pre>
				171	</div>
				172
				173	</body></html>