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

2020-10-06 16:46:05 -0700

[diff] [blame]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

81

<code><a href="#get">get(volumeId, layerId, annotationDataId, contentVersion, scale=None, source=None, w=None, allowWebDefinitions=None, locale=None, h=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.</p>

83

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

84

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

John Asmuth

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

[diff] [blame]

85

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

86

87

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

88

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

89

<h3>Method Details</h3>

90

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

91

<code class="details" id="close">close()</code>

92

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

96

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

John Asmuth

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

[diff] [blame]

97

<pre>Gets the annotation data.

98

99

Args:

100

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

101

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

102

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

103

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

104

scale: integer, The requested scale for the image.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

105

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

106

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

107

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

108

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

109

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

Bu Sun Kim

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

[diff] [blame]

110

x__xgafv: string, V1 error format.

111

Allowed values

112

1 - v1 error format

113

2 - v2 error format

John Asmuth

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

[diff] [blame]

114

115

Returns:

116

An object of the form:

117

118

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

119

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

120

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

Bu Sun Kim

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

[diff] [blame]

121

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

122

"kind": "A String",

Bu Sun Kim

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

[diff] [blame]

123

"common": {

124

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

125

},

Bu Sun Kim

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

[diff] [blame]

126

"dict": {

127

"words": [

128

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

129

"senses": [

Bu Sun Kim

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

[diff] [blame]

130

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

131

"partOfSpeech": "A String",

"definitions": [

{

"examples": [

{

"source": {

"url": "A String",

"attribution": "A String",

},

"text": "A String",

},

],

"definition": "A String",

144

},

145

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

146

"synonyms": [

147

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

148

"text": "A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

149

"source": {

150

"url": "A String",

151

"attribution": "A String",

152

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

153

},

154

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

155

"conjugations": [

156

{

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

157

"value": "A String",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

158

"type": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

159

},

160

],

161

"pronunciationUrl": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

162

"pronunciation": "A String",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

163

"syllabification": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

164

"source": {

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

165

"attribution": "A String",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

166

"url": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

167

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

168

},

169

],

170

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

171

"url": "A String",

172

"attribution": "A String",

},

"derivatives": [

{

"source": {

"attribution": "A String",

178

"url": "A String",

179

},

180

"text": "A String",

Bu Sun Kim

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

[diff] [blame]

},

],

"examples": [

{

Bu Sun Kim

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

[diff] [blame]

185

"text": "A String",

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

186

"source": {

187

"attribution": "A String",

188

"url": "A String",

189

},

Bu Sun Kim

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

[diff] [blame]

190

},

191

],

Bu Sun Kim

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

[diff] [blame]

192

},

193

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

194

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

195

"attribution": "A String",

196

"url": "A String",

197

},

Bu Sun Kim

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

[diff] [blame]

198

},

199

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

200

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

Bu Sun Kim

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

[diff] [blame]

201

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

202

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

203

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

204

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

205

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

210

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

John Asmuth

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

[diff] [blame]

211

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

212

213

Args:

214

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

215

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

216

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

217

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

218

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

219

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

220

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

221

maxResults: integer, Maximum number of results to return

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

222

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

223

scale: integer, The requested scale for the image.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

224

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

225

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

226

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

Bu Sun Kim

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

[diff] [blame]

227

x__xgafv: string, V1 error format.

228

Allowed values

229

1 - v1 error format

230

2 - v2 error format

John Asmuth

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

[diff] [blame]

231

232

Returns:

233

An object of the form:

234

235

{

Bu Sun Kim

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

[diff] [blame]

236

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

237

"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.

Bu Sun Kim

6502091

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

[diff] [blame]

238

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

John Asmuth

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

[diff] [blame]

239

{

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

240

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

Bu Sun Kim

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

[diff] [blame]

241

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

242

"common": {

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

243

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

244

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

245

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

246

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

247

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

248

},

Bu Sun Kim

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

[diff] [blame]

249

"geo": {

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

250

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

251

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

252

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

253

"A String",

254

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

255

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

256

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

257

"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

Bu Sun Kim

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

[diff] [blame]

258

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

"hi": {

"latitude": 3.14,

"longitude": 3.14,

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

263

"lo": {

Bu Sun Kim

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

[diff] [blame]

264

"latitude": 3.14,

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

265

"longitude": 3.14,

Bu Sun Kim

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

[diff] [blame]

266

},

Bu Sun Kim

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

[diff] [blame]

267

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

268

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

Bu Sun Kim

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

[diff] [blame]

269

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

270

"kind": "A String",

Bu Sun Kim

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

[diff] [blame]

271

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

272

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

273

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

274

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

275

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

276

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

277

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

278

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

John Asmuth

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

[diff] [blame]

279

},

280

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

281

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

John Asmuth

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

287

<pre>Retrieves the next page of results.

288

289

Args:

290

previous_request: The request for the previous page. (required)

291

previous_response: The response from the request for the previous page. (required)

292

293

Returns:

Bu Sun Kim

6502091

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

[diff] [blame]

294

A request object that you can call 'execute()' on to request the next

John Asmuth