Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / mapsengine_v1.tables.html
blob: 17f75dcb916ab4f04362e8b991628c405a306f0e [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame^]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="mapsengine_v1.html">Google Maps Engine API</a> . <a href="mapsengine_v1.tables.html">tables</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="mapsengine_v1.tables.features.html">features()</a></code>
79</p>
80<p class="firstline">Returns the features Resource.</p>
81
82<p class="toc_element">
83 <code><a href="mapsengine_v1.tables.files.html">files()</a></code>
84</p>
85<p class="firstline">Returns the files Resource.</p>
86
87<p class="toc_element">
88 <code><a href="mapsengine_v1.tables.parents.html">parents()</a></code>
89</p>
90<p class="firstline">Returns the parents Resource.</p>
91
92<p class="toc_element">
93 <code><a href="#create">create(body)</a></code></p>
94<p class="firstline">Create a table asset.</p>
95<p class="toc_element">
96 <code><a href="#get">get(id, version=None)</a></code></p>
97<p class="firstline">Return metadata for a particular table, including the schema.</p>
98<p class="toc_element">
99 <code><a href="#list">list(modifiedAfter=None, createdAfter=None, pageToken=None, projectId=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</a></code></p>
100<p class="firstline">Return all tables readable by the current user.</p>
101<p class="toc_element">
102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
104<p class="toc_element">
105 <code><a href="#upload">upload(body)</a></code></p>
106<p class="firstline">Create a placeholder table asset to which table files can be uploaded.</p>
107<h3>Method Details</h3>
108<div class="method">
109 <code class="details" id="create">create(body)</code>
110 <pre>Create a table asset.
111
112Args:
113 body: object, The request body. (required)
114 The object takes the form of:
115
116{ # A collection of geographic features, and associated metadata.
117 "files": [ # The files associated with this table.
118 { # A single File, which is a component of an Asset.
119 "size": "A String", # The size of the file in bytes.
120 "uploadStatus": "A String", # The upload status of the file.
121 "filename": "A String", # The name of the file.
122 },
123 ],
124 "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table.
125 "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
126 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
127 "columns": [ # An array of column objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
128 {
129 "type": "A String", # The type of data stored in this column. Accepted values are:
130 #
131 # - integer
132 # - double
133 # - boolean
134 # - string
135 # - mixedGeometry
136 # - points
137 # - lineStrings
138 # - polygons
139 "name": "A String", # The column name.
140 },
141 ],
142 },
143 "description": "A String", # The description of this table, supplied by the author.
144 "processingStatus": "A String", # The processing status of this table. The supported processing status values are:
145 #
146 # - notReady: The table is not ready to be processed - some files have not been uploaded.
147 # - ready: The table is queued for processing.
148 # - processing: The table is currently processing.
149 # - complete: Processing has completed successfully.
150 # - failed: Processing failed to complete.
151 "draftAccessList": "A String", # The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Read About access lists in the Google Maps Engine help center for more information.
152 "projectId": "A String", # The ID of the project to which the table belongs.
153 "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
154 "A String",
155 ],
156 "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
157 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
158 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this table.
159 3.14,
160 ],
161 "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
162 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
163 "id": "A String", # A globally unique ID, used to refer to this table.
164 "name": "A String", # The name of this table, supplied by the author.
165 }
166
167
168Returns:
169 An object of the form:
170
171 { # A collection of geographic features, and associated metadata.
172 "files": [ # The files associated with this table.
173 { # A single File, which is a component of an Asset.
174 "size": "A String", # The size of the file in bytes.
175 "uploadStatus": "A String", # The upload status of the file.
176 "filename": "A String", # The name of the file.
177 },
178 ],
179 "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table.
180 "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
181 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
182 "columns": [ # An array of column objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
183 {
184 "type": "A String", # The type of data stored in this column. Accepted values are:
185 #
186 # - integer
187 # - double
188 # - boolean
189 # - string
190 # - mixedGeometry
191 # - points
192 # - lineStrings
193 # - polygons
194 "name": "A String", # The column name.
195 },
196 ],
197 },
198 "description": "A String", # The description of this table, supplied by the author.
199 "processingStatus": "A String", # The processing status of this table. The supported processing status values are:
200 #
201 # - notReady: The table is not ready to be processed - some files have not been uploaded.
202 # - ready: The table is queued for processing.
203 # - processing: The table is currently processing.
204 # - complete: Processing has completed successfully.
205 # - failed: Processing failed to complete.
206 "draftAccessList": "A String", # The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Read About access lists in the Google Maps Engine help center for more information.
207 "projectId": "A String", # The ID of the project to which the table belongs.
208 "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
209 "A String",
210 ],
211 "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
212 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
213 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this table.
214 3.14,
215 ],
216 "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
217 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
218 "id": "A String", # A globally unique ID, used to refer to this table.
219 "name": "A String", # The name of this table, supplied by the author.
220 }</pre>
221</div>
222
223<div class="method">
224 <code class="details" id="get">get(id, version=None)</code>
225 <pre>Return metadata for a particular table, including the schema.
226
227Args:
228 id: string, The ID of the table. (required)
229 version: string, A parameter
230 Allowed values
231 draft - The draft version.
232 published - The published version.
233
234Returns:
235 An object of the form:
236
237 { # A collection of geographic features, and associated metadata.
238 "files": [ # The files associated with this table.
239 { # A single File, which is a component of an Asset.
240 "size": "A String", # The size of the file in bytes.
241 "uploadStatus": "A String", # The upload status of the file.
242 "filename": "A String", # The name of the file.
243 },
244 ],
245 "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table.
246 "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
247 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
248 "columns": [ # An array of column objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
249 {
250 "type": "A String", # The type of data stored in this column. Accepted values are:
251 #
252 # - integer
253 # - double
254 # - boolean
255 # - string
256 # - mixedGeometry
257 # - points
258 # - lineStrings
259 # - polygons
260 "name": "A String", # The column name.
261 },
262 ],
263 },
264 "description": "A String", # The description of this table, supplied by the author.
265 "processingStatus": "A String", # The processing status of this table. The supported processing status values are:
266 #
267 # - notReady: The table is not ready to be processed - some files have not been uploaded.
268 # - ready: The table is queued for processing.
269 # - processing: The table is currently processing.
270 # - complete: Processing has completed successfully.
271 # - failed: Processing failed to complete.
272 "draftAccessList": "A String", # The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Read About access lists in the Google Maps Engine help center for more information.
273 "projectId": "A String", # The ID of the project to which the table belongs.
274 "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
275 "A String",
276 ],
277 "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
278 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
279 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this table.
280 3.14,
281 ],
282 "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
283 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
284 "id": "A String", # A globally unique ID, used to refer to this table.
285 "name": "A String", # The name of this table, supplied by the author.
286 }</pre>
287</div>
288
289<div class="method">
290 <code class="details" id="list">list(modifiedAfter=None, createdAfter=None, pageToken=None, projectId=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</code>
291 <pre>Return all tables readable by the current user.
292
293Args:
294 modifiedAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or after this time.
295 createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.
296 pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
297 projectId: string, The ID of a Maps Engine project, used to filter the response. To list all available projects with their IDs, send a Projects: list request. You can also find your project ID as the value of the DashboardPlace:cid URL parameter when signed in to mapsengine.google.com.
298 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
299 createdBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or before this time.
300 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
301 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
302 modifiedBefore: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been modified at or before this time.
303
304Returns:
305 An object of the form:
306
307 { # The response returned by a call to tables.List.
308 "nextPageToken": "A String", # Next page token.
309 "tables": [ # Resources returned.
310 { # A collection of geographic features, and associated metadata.
311 "files": [ # The files associated with this table.
312 { # A single File, which is a component of an Asset.
313 "size": "A String", # The size of the file in bytes.
314 "uploadStatus": "A String", # The upload status of the file.
315 "filename": "A String", # The name of the file.
316 },
317 ],
318 "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table.
319 "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
320 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
321 "columns": [ # An array of column objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
322 {
323 "type": "A String", # The type of data stored in this column. Accepted values are:
324 #
325 # - integer
326 # - double
327 # - boolean
328 # - string
329 # - mixedGeometry
330 # - points
331 # - lineStrings
332 # - polygons
333 "name": "A String", # The column name.
334 },
335 ],
336 },
337 "description": "A String", # The description of this table, supplied by the author.
338 "processingStatus": "A String", # The processing status of this table. The supported processing status values are:
339 #
340 # - notReady: The table is not ready to be processed - some files have not been uploaded.
341 # - ready: The table is queued for processing.
342 # - processing: The table is currently processing.
343 # - complete: Processing has completed successfully.
344 # - failed: Processing failed to complete.
345 "draftAccessList": "A String", # The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Read About access lists in the Google Maps Engine help center for more information.
346 "projectId": "A String", # The ID of the project to which the table belongs.
347 "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
348 "A String",
349 ],
350 "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
351 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
352 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this table.
353 3.14,
354 ],
355 "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
356 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
357 "id": "A String", # A globally unique ID, used to refer to this table.
358 "name": "A String", # The name of this table, supplied by the author.
359 },
360 ],
361 }</pre>
362</div>
363
364<div class="method">
365 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
366 <pre>Retrieves the next page of results.
367
368Args:
369 previous_request: The request for the previous page. (required)
370 previous_response: The response from the request for the previous page. (required)
371
372Returns:
373 A request object that you can call 'execute()' on to request the next
374 page. Returns None if there are no more items in the collection.
375 </pre>
376</div>
377
378<div class="method">
379 <code class="details" id="upload">upload(body)</code>
380 <pre>Create a placeholder table asset to which table files can be uploaded.
381Once the placeholder has been created, files are uploaded to the https://www.googleapis.com/upload/mapsengine/v1/tables/table_id/files endpoint.
382See Table Upload in the Developer's Guide or Table.files: insert in the reference documentation for more information.
383
384Args:
385 body: object, The request body. (required)
386 The object takes the form of:
387
388{ # A collection of geographic features, and associated metadata.
389 "files": [ # The files associated with this table.
390 { # A single File, which is a component of an Asset.
391 "size": "A String", # The size of the file in bytes.
392 "uploadStatus": "A String", # The upload status of the file.
393 "filename": "A String", # The name of the file.
394 },
395 ],
396 "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table.
397 "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
398 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
399 "columns": [ # An array of column objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
400 {
401 "type": "A String", # The type of data stored in this column. Accepted values are:
402 #
403 # - integer
404 # - double
405 # - boolean
406 # - string
407 # - mixedGeometry
408 # - points
409 # - lineStrings
410 # - polygons
411 "name": "A String", # The column name.
412 },
413 ],
414 },
415 "description": "A String", # The description of this table, supplied by the author.
416 "processingStatus": "A String", # The processing status of this table. The supported processing status values are:
417 #
418 # - notReady: The table is not ready to be processed - some files have not been uploaded.
419 # - ready: The table is queued for processing.
420 # - processing: The table is currently processing.
421 # - complete: Processing has completed successfully.
422 # - failed: Processing failed to complete.
423 "draftAccessList": "A String", # The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Read About access lists in the Google Maps Engine help center for more information.
424 "projectId": "A String", # The ID of the project to which the table belongs.
425 "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
426 "A String",
427 ],
428 "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
429 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
430 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this table.
431 3.14,
432 ],
433 "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
434 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
435 "id": "A String", # A globally unique ID, used to refer to this table.
436 "name": "A String", # The name of this table, supplied by the author.
437 }
438
439
440Returns:
441 An object of the form:
442
443 { # A collection of geographic features, and associated metadata.
444 "files": [ # The files associated with this table.
445 { # A single File, which is a component of an Asset.
446 "size": "A String", # The size of the file in bytes.
447 "uploadStatus": "A String", # The upload status of the file.
448 "filename": "A String", # The name of the file.
449 },
450 ],
451 "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The schema for this table.
452 "primaryGeometry": "A String", # The name of the column that contains a feature's geometry. This field can be omitted during table create; Google Maps Engine supports only a single geometry column, which must be named geometry and be the first object in the columns array.
453 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
454 "columns": [ # An array of column objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
455 {
456 "type": "A String", # The type of data stored in this column. Accepted values are:
457 #
458 # - integer
459 # - double
460 # - boolean
461 # - string
462 # - mixedGeometry
463 # - points
464 # - lineStrings
465 # - polygons
466 "name": "A String", # The column name.
467 },
468 ],
469 },
470 "description": "A String", # The description of this table, supplied by the author.
471 "processingStatus": "A String", # The processing status of this table. The supported processing status values are:
472 #
473 # - notReady: The table is not ready to be processed - some files have not been uploaded.
474 # - ready: The table is queued for processing.
475 # - processing: The table is currently processing.
476 # - complete: Processing has completed successfully.
477 # - failed: Processing failed to complete.
478 "draftAccessList": "A String", # The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Read About access lists in the Google Maps Engine help center for more information.
479 "projectId": "A String", # The ID of the project to which the table belongs.
480 "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
481 "A String",
482 ],
483 "creationTime": "A String", # The creation time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
484 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
485 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this table.
486 3.14,
487 ],
488 "lastModifiedTime": "A String", # The last modified time of this table. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
489 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
490 "id": "A String", # A globally unique ID, used to refer to this table.
491 "name": "A String", # The name of this table, supplied by the author.
492 }</pre>
493</div>
494
495</body></html>