Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c1f8beda2812f174908cf495687a15638482e309 / . / docs / dyn / mapsengine_v1.tables.html
blob: 7a2f7c27be9ee9bdd540e7264bcfc46fe1df10b4 [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">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]93 <code><a href="mapsengine_v1.tables.permissions.html">permissions()</a></code>
94</p>
95<p class="firstline">Returns the permissions Resource.</p>
96
97<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98 <code><a href="#create">create(body)</a></code></p>
99<p class="firstline">Create a table asset.</p>
100<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]101 <code><a href="#delete">delete(id)</a></code></p>
102<p class="firstline">Delete a table.</p>
103<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104 <code><a href="#get">get(id, version=None)</a></code></p>
105<p class="firstline">Return metadata for a particular table, including the schema.</p>
106<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]107 <code><a href="#list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]108<p class="firstline">Return all tables readable by the current user.</p>
109<p class="toc_element">
110 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
111<p class="firstline">Retrieves the next page of results.</p>
112<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]113 <code><a href="#patch">patch(id, body)</a></code></p>
114<p class="firstline">Mutate a table asset.</p>
115<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]116 <code><a href="#process">process(id)</a></code></p>
117<p class="firstline">Process a table asset.</p>
118<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119 <code><a href="#upload">upload(body)</a></code></p>
120<p class="firstline">Create a placeholder table asset to which table files can be uploaded.</p>
121<h3>Method Details</h3>
122<div class="method">
123 <code class="details" id="create">create(body)</code>
124 <pre>Create a table asset.
125
126Args:
127 body: object, The request body. (required)
128 The object takes the form of:
129
130{ # A collection of geographic features, and associated metadata.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]131 "files": [ # The files associated with this table.
132 { # A single File, which is a component of an Asset.
133 "size": "A String", # The size of the file in bytes.
134 "uploadStatus": "A String", # The upload status of the file.
135 "filename": "A String", # The name of the file.
136 },
137 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]138 "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. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]139 "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.
140 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
141 "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
142 {
143 "type": "A String", # The type of data stored in this column.
144 "name": "A String", # The column name.
145 },
146 ],
147 },
148 "description": "A String", # The description of this table, supplied by the author.
149 "processingStatus": "A String", # The processing status of this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]150 "draftAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]151 "projectId": "A String", # The ID of the project to which the table belongs.
152 "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.
153 "A String",
154 ],
155 "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).
156 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]157 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]158 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]159 "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
160 "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]161 3.14,
162 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]163 "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]164 "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).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]165 "publishedAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]166 "id": "A String", # A globally unique ID, used to refer to this table.
167 "name": "A String", # The name of this table, supplied by the author.
168}
169
170
171Returns:
172 An object of the form:
173
174 { # A collection of geographic features, and associated metadata.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]175 "files": [ # The files associated with this table.
176 { # A single File, which is a component of an Asset.
177 "size": "A String", # The size of the file in bytes.
178 "uploadStatus": "A String", # The upload status of the file.
179 "filename": "A String", # The name of the file.
180 },
181 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]182 "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. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]183 "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.
184 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]185 "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]186 {
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]187 "type": "A String", # The type of data stored in this column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]188 "name": "A String", # The column name.
189 },
190 ],
191 },
192 "description": "A String", # The description of this table, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]193 "processingStatus": "A String", # The processing status of this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]194 "draftAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]195 "projectId": "A String", # The ID of the project to which the table belongs.
196 "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.
197 "A String",
198 ],
199 "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).
200 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]201 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]202 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]203 "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
204 "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]205 3.14,
206 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]207 "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]208 "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).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]209 "publishedAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]210 "id": "A String", # A globally unique ID, used to refer to this table.
211 "name": "A String", # The name of this table, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]212 }</pre>
213</div>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]214
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]215<div class="method">
216 <code class="details" id="delete">delete(id)</code>
217 <pre>Delete a table.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]218
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]219Args:
220 id: string, The ID of the table. Only the table creator or project owner are permitted to delete. If the table is included in a layer, the request will fail. Remove it from all layers prior to deleting. (required)
221</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]222</div>
223
224<div class="method">
225 <code class="details" id="get">get(id, version=None)</code>
226 <pre>Return metadata for a particular table, including the schema.
227
228Args:
229 id: string, The ID of the table. (required)
230 version: string, A parameter
231 Allowed values
232 draft - The draft version.
233 published - The published version.
234
235Returns:
236 An object of the form:
237
238 { # A collection of geographic features, and associated metadata.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]239 "files": [ # The files associated with this table.
240 { # A single File, which is a component of an Asset.
241 "size": "A String", # The size of the file in bytes.
242 "uploadStatus": "A String", # The upload status of the file.
243 "filename": "A String", # The name of the file.
244 },
245 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]246 "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. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]247 "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.
248 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
249 "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
250 {
251 "type": "A String", # The type of data stored in this column.
252 "name": "A String", # The column name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]253 },
254 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]255 },
256 "description": "A String", # The description of this table, supplied by the author.
257 "processingStatus": "A String", # The processing status of this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]258 "draftAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]259 "projectId": "A String", # The ID of the project to which the table belongs.
260 "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.
261 "A String",
262 ],
263 "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).
264 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]265 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]266 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]267 "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
268 "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]269 3.14,
270 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]271 "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]272 "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).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]273 "publishedAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]274 "id": "A String", # A globally unique ID, used to refer to this table.
275 "name": "A String", # The name of this table, supplied by the author.
276 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277</div>
278
279<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]280 <code class="details" id="list">list(modifiedBefore=None, creatorEmail=None, processingStatus=None, projectId=None, pageToken=None, role=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, search=None, createdBefore=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]281 <pre>Return all tables readable by the current user.
282
283Args:
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]284 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.
285 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
286 processingStatus: string, A parameter
287 Allowed values
288 complete - The table has completed processing.
289 failed - The table has failed processing.
290 notReady - The table is not ready for processing.
291 processing - The table is processing.
292 ready - The table is ready for processing.
293 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.
294 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.
295 role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
296 Allowed values
297 owner - The user can read, write and administer the asset.
298 reader - The user can read the asset.
299 writer - The user can read and write the asset.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]300 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]301 tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]302 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]303 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]304 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.
305 search: string, An unstructured search string used to filter the set of results based on asset metadata.
306 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]307
308Returns:
309 An object of the form:
310
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]311 { # The response returned by a call to tables.List. Note: The list response does not include all the fields available in a table. Refer to the table resource description for details of the fields that are not included. You'll need to send a get request to retrieve the additional fields for each table.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]312 "nextPageToken": "A String", # Next page token.
313 "tables": [ # Resources returned.
314 { # A collection of geographic features, and associated metadata.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]315 "files": [ # The files associated with this table.
316 { # A single File, which is a component of an Asset.
317 "size": "A String", # The size of the file in bytes.
318 "uploadStatus": "A String", # The upload status of the file.
319 "filename": "A String", # The name of the file.
320 },
321 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]322 "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. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]323 "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.
324 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
325 "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
326 {
327 "type": "A String", # The type of data stored in this column.
328 "name": "A String", # The column name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]329 },
330 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]331 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]332 "description": "A String", # The description of this table, supplied by the author.
333 "processingStatus": "A String", # The processing status of this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]334 "draftAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]335 "projectId": "A String", # The ID of the project to which the table belongs.
336 "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.
337 "A String",
338 ],
339 "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).
340 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]341 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]342 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]343 "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
344 "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]345 3.14,
346 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]347 "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]348 "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).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]349 "publishedAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]350 "id": "A String", # A globally unique ID, used to refer to this table.
351 "name": "A String", # The name of this table, supplied by the author.
352 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]353 ],
354 }</pre>
355</div>
356
357<div class="method">
358 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
359 <pre>Retrieves the next page of results.
360
361Args:
362 previous_request: The request for the previous page. (required)
363 previous_response: The response from the request for the previous page. (required)
364
365Returns:
366 A request object that you can call 'execute()' on to request the next
367 page. Returns None if there are no more items in the collection.
368 </pre>
369</div>
370
371<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]372 <code class="details" id="patch">patch(id, body)</code>
373 <pre>Mutate a table asset.
374
375Args:
376 id: string, The ID of the table. (required)
377 body: object, The request body. (required)
378 The object takes the form of:
379
380{ # A collection of geographic features, and associated metadata.
381 "files": [ # The files associated with this table.
382 { # A single File, which is a component of an Asset.
383 "size": "A String", # The size of the file in bytes.
384 "uploadStatus": "A String", # The upload status of the file.
385 "filename": "A String", # The name of the file.
386 },
387 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]388 "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. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]389 "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.
390 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
391 "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
392 {
393 "type": "A String", # The type of data stored in this column.
394 "name": "A String", # The column name.
395 },
396 ],
397 },
398 "description": "A String", # The description of this table, supplied by the author.
399 "processingStatus": "A String", # The processing status of this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]400 "draftAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]401 "projectId": "A String", # The ID of the project to which the table belongs.
402 "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.
403 "A String",
404 ],
405 "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).
406 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]407 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]408 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]409 "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
410 "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]411 3.14,
412 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]413 "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]414 "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).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]415 "publishedAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]416 "id": "A String", # A globally unique ID, used to refer to this table.
417 "name": "A String", # The name of this table, supplied by the author.
418}
419
420</pre>
421</div>
422
423<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]424 <code class="details" id="process">process(id)</code>
425 <pre>Process a table asset.
426
427Args:
428 id: string, The ID of the table. (required)
429
430Returns:
431 An object of the form:
432
433 { # The response returned by a call to any asset's Process method.
434 }</pre>
435</div>
436
437<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]438 <code class="details" id="upload">upload(body)</code>
439 <pre>Create a placeholder table asset to which table files can be uploaded.
440Once the placeholder has been created, files are uploaded to the https://www.googleapis.com/upload/mapsengine/v1/tables/table_id/files endpoint.
441See Table Upload in the Developer's Guide or Table.files: insert in the reference documentation for more information.
442
443Args:
444 body: object, The request body. (required)
445 The object takes the form of:
446
447{ # A collection of geographic features, and associated metadata.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]448 "files": [ # The files associated with this table.
449 { # A single File, which is a component of an Asset.
450 "size": "A String", # The size of the file in bytes.
451 "uploadStatus": "A String", # The upload status of the file.
452 "filename": "A String", # The name of the file.
453 },
454 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]455 "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. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]456 "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.
457 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
458 "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
459 {
460 "type": "A String", # The type of data stored in this column.
461 "name": "A String", # The column name.
462 },
463 ],
464 },
465 "description": "A String", # The description of this table, supplied by the author.
466 "processingStatus": "A String", # The processing status of this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]467 "draftAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]468 "projectId": "A String", # The ID of the project to which the table belongs.
469 "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.
470 "A String",
471 ],
472 "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).
473 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]474 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]475 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]476 "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
477 "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]478 3.14,
479 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]480 "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]481 "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).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]482 "publishedAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]483 "id": "A String", # A globally unique ID, used to refer to this table.
484 "name": "A String", # The name of this table, supplied by the author.
485}
486
487
488Returns:
489 An object of the form:
490
491 { # A collection of geographic features, and associated metadata.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]492 "files": [ # The files associated with this table.
493 { # A single File, which is a component of an Asset.
494 "size": "A String", # The size of the file in bytes.
495 "uploadStatus": "A String", # The upload status of the file.
496 "filename": "A String", # The name of the file.
497 },
498 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]499 "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. Note: The schema is returned in response to a get request but not a list request. After requesting a list of tables, you'll need to send a get request to retrieve the schema for each table.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]500 "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.
501 "primaryKey": "A String", # The name of the column that contains the unique identifier of a Feature.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]502 "columns": [ # An array of TableColumn objects. The first object in the array must be named geometry and be of type points, lineStrings, polygons, or mixedGeometry.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]503 {
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]504 "type": "A String", # The type of data stored in this column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]505 "name": "A String", # The column name.
506 },
507 ],
508 },
509 "description": "A String", # The description of this table, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]510 "processingStatus": "A String", # The processing status of this table.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]511 "draftAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]512 "projectId": "A String", # The ID of the project to which the table belongs.
513 "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.
514 "A String",
515 ],
516 "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).
517 "sourceEncoding": "UTF-8", # Encoding of the uploaded files. Valid values include UTF-8, CP1251, ISO 8859-1, and Shift_JIS.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]518 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]519 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]520 "creatorEmail": "A String", # The email address of the creator of this table. This is only returned on GET requests and not LIST requests.
521 "bbox": [ # A rectangular bounding box which contains all of the data in this Table. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]522 3.14,
523 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]524 "lastModifierEmail": "A String", # The email address of the last modifier of this table. This is only returned on GET requests and not LIST requests.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]525 "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).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]526 "publishedAccessList": "A String", # Deprecated: 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. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]527 "id": "A String", # A globally unique ID, used to refer to this table.
528 "name": "A String", # The name of this table, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]529 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]530</div>
531
532</body></html>