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

2020-07-22 17:02:09 -0700

[diff] [blame]

78

<code><a href="#get">get(volumeId, layerId, annotationDataId, w=None, scale=None, source=None, allowWebDefinitions=None, locale=None, h=None, contentVersion=None, x__xgafv=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

79

<p class="firstline">Gets the annotation data.</p>

80

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

81

<code><a href="#list">list(volumeId, layerId, updatedMax=None, w=None, h=None, contentVersion=None, annotationDataId=None, locale=None, source=None, pageToken=None, updatedMin=None, maxResults=None, scale=None, x__xgafv=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

82

<p class="firstline">Gets the annotation data for a volume and layer.</p>

83

84

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

85

<p class="firstline">Retrieves the next page of results.</p>

86

<h3>Method Details</h3>

87

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

88

<code class="details" id="get">get(volumeId, layerId, annotationDataId, w=None, scale=None, source=None, allowWebDefinitions=None, locale=None, h=None, contentVersion=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

89

<pre>Gets the annotation data.

90

91

Args:

92

volumeId: string, The volume to retrieve annotations for. (required)

93

layerId: string, The ID for the layer to get the annotations. (required)

94

annotationDataId: string, The ID of the annotation data to retrieve. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

95

w: integer, The requested pixel width for any images. If width is provided height must also be provided.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

96

scale: integer, The requested scale for the image.

97

source: string, String to identify the originator of this request.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

98

allowWebDefinitions: boolean, For the dictionary layer. Whether or not to allow web definitions.

99

locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

100

h: integer, The requested pixel height for any images. If height is provided width must also be provided.

101

contentVersion: string, The content version for the volume you are trying to retrieve.

102

x__xgafv: string, V1 error format.

103

Allowed values

104

1 - v1 error format

105

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

106

107

Returns:

108

An object of the form:

109

110

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

111

"data": { # JSON encoded data for this dictionary annotation data. Emitted with name 'data' in JSON output. Either this or geo_data will be populated.

112

"common": {

113

"title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search.

},

"kind": "A String",

"dict": {

"words": [

{

"derivatives": [

{

"source": {

"url": "A String",

"attribution": "A String",

},

"text": "A String",

},

],

"examples": [

{

"source": {

"url": "A String",

"attribution": "A String",

},

"text": "A String",

},

],

"source": { # The words with different meanings but not related words, e.g. "go" (game) and "go" (verb).

138

"attribution": "A String",

"url": "A String",

},

"senses": [

{

"definitions": [

{

"examples": [

{

"source": {

"url": "A String",

"attribution": "A String",

},

"text": "A String",

},

],

"definition": "A String",

155

},

156

],

157

"syllabification": "A String",

158

"source": {

159

"url": "A String",

160

"attribution": "A String",

},

"conjugations": [

{

"value": "A String",

"type": "A String",

},

],

"synonyms": [

{

"text": "A String",

"source": {

"url": "A String",

"attribution": "A String",

},

},

],

"pronunciationUrl": "A String",

178

"partOfSpeech": "A String",

179

"pronunciation": "A String",

},

],

},

],

"source": { # The source, url and attribution for this dictionary data.

185

"attribution": "A String",

"url": "A String",

},

},

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

190

"selfLink": "A String", # URL for this resource. *

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

191

"layerId": "A String", # The Layer id for this data. *

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

192

"volumeId": "A String", # The volume id for this data. *

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

193

"id": "A String", # Unique id for this annotation data.

194

"updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).

195

"kind": "A String", # Resource Type

196

"encodedData": "A String", # Base64 encoded data for this annotation data.

197

"annotationType": "A String", # The type of annotation this data is for.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

202

<code class="details" id="list">list(volumeId, layerId, updatedMax=None, w=None, h=None, contentVersion=None, annotationDataId=None, locale=None, source=None, pageToken=None, updatedMin=None, maxResults=None, scale=None, x__xgafv=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

203

<pre>Gets the annotation data for a volume and layer.

204

205

Args:

206

volumeId: string, The volume to retrieve annotation data for. (required)

207

layerId: string, The ID for the layer to get the annotation data. (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

208

updatedMax: string, RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

209

w: integer, The requested pixel width for any images. If width is provided height must also be provided.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

210

h: integer, The requested pixel height for any images. If height is provided width must also be provided.

211

contentVersion: string, The content version for the requested volume.

212

annotationDataId: string, The list of Annotation Data Ids to retrieve. Pagination is ignored if this is set. (repeated)

213

locale: string, The locale information for the data. ISO-639-1 language and ISO-3166-1 country code. Ex: 'en_US'.

214

source: string, String to identify the originator of this request.

215

pageToken: string, The value of the nextToken from the previous page.

216

updatedMin: string, RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

217

maxResults: integer, Maximum number of results to return

218

scale: integer, The requested scale for the image.

219

x__xgafv: string, V1 error format.

220

Allowed values

221

1 - v1 error format

222

2 - v2 error format

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

223

224

Returns:

225

An object of the form:

226

227

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

228

"kind": "A String", # Resource type

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

229

"items": [ # A list of Annotation Data.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

230

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

231

"volumeId": "A String", # The volume id for this data. *

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

232

"updated": "A String", # Timestamp for the last time this data was updated. (RFC 3339 UTC date-time format).

233

"encodedData": "A String", # Base64 encoded data for this annotation data.

234

"layerId": "A String", # The Layer id for this data. *

235

"id": "A String", # Unique id for this annotation data.

236

"kind": "A String", # Resource Type

237

"annotationType": "A String", # The type of annotation this data is for.

238

"data": { # JSON encoded data for this geo annotation data. Emitted with name 'data' in JSON output. Either this or dict_data will be populated.

239

"geo": {

240

"cachePolicy": "A String", # The cache policy active for this data. EX: UNRESTRICTED, RESTRICTED, NEVER

241

"mapType": "A String", # The type of map that should be used for this location. EX: HYBRID, ROADMAP, SATELLITE, TERRAIN

242

"latitude": 3.14, # The latitude of the location.

243

"countryCode": "A String", # The country code of the location.

244

"boundary": [ # The boundary of the location as a set of loops containing pairs of latitude, longitude coordinates.

245

"A String",

246

],

247

"zoom": 42, # The Zoom level to use for the map. Zoom levels between 0 (the lowest zoom level, in which the entire world can be seen on one map) to 21+ (down to individual buildings). See: https: //developers.google.com/maps/documentation/staticmaps/#Zoomlevels

248

"longitude": 3.14, # The longitude of the location.

249

"viewport": { # The viewport for showing this location. This is a latitude, longitude rectangle.

"hi": {

"longitude": 3.14,

"latitude": 3.14,

},

"lo": {

"longitude": 3.14,

"latitude": 3.14,

},

},

},

"common": {

"snippetUrl": "A String", # The URL for information for this location. Ex: wikipedia link.

262

"snippet": "A String", # The description for this location.

263

"lang": "A String", # The language of the information url and description.

264

"title": "A String", # The display title and localized canonical name to use when searching for this entity on Google search.

265

"previewImageUrl": "A String", # The URL for the preview image information.

},

"kind": "A String",

},

"selfLink": "A String", # URL for this resource. *

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

270

},

271

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

272

"totalItems": 42, # The total number of volume annotations found.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

273

"nextPageToken": "A String", # Token to pass in for pagination for the next page. This will not be present if this request does not have more results.

John Asmuth