Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / db5a0ed106aff656a031a99ad64780ffd88c8425 / . / docs / dyn / mapsengine_v1.tables.features.html
blob: 32eea5a5a8d39eeb34d023d454965fecb8e46fcb [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> . <a href="mapsengine_v1.tables.features.html">features</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#batchDelete">batchDelete(id, body)</a></code></p>
79<p class="firstline">Delete all features matching the given IDs.</p>
80<p class="toc_element">
81 <code><a href="#batchInsert">batchInsert(id, body)</a></code></p>
82<p class="firstline">Append features to an existing table.</p>
83<p class="toc_element">
84 <code><a href="#batchPatch">batchPatch(id, body)</a></code></p>
85<p class="firstline">Update the supplied features.</p>
86<p class="toc_element">
87 <code><a href="#get">get(tableId, id, version=None, select=None)</a></code></p>
88<p class="firstline">Return a single feature, given its ID.</p>
89<p class="toc_element">
90 <code><a href="#list">list(id, orderBy=None, intersects=None, pageToken=None, maxResults=None, version=None, limit=None, include=None, where=None, select=None)</a></code></p>
91<p class="firstline">Return all features readable by the current user.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<h3>Method Details</h3>
96<div class="method">
97 <code class="details" id="batchDelete">batchDelete(id, body)</code>
98 <pre>Delete all features matching the given IDs.
99
100Args:
101 id: string, The ID of the table that contains the features to be deleted. (required)
102 body: object, The request body. (required)
103 The object takes the form of:
104
105{ # The request sent to features.BatchDelete.
106 "gx_ids": [
107 "A String",
108 ],
109 "primaryKeys": [
110 "A String",
111 ],
112 }
113
114</pre>
115</div>
116
117<div class="method">
118 <code class="details" id="batchInsert">batchInsert(id, body)</code>
119 <pre>Append features to an existing table.
120
121A single batchInsert request can create:
122
123- Up to 50 features.
124- A combined total of 10 000 vertices.
125Feature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.
126
127For more information about inserting features, read Creating features in the Google Maps Engine developer's guide.
128
129Args:
130 id: string, The ID of the table to append the features to. (required)
131 body: object, The request body. (required)
132 The object takes the form of:
133
134{ # The request sent to features.Insert.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]135 "normalizeGeometries": true, # If true, the server will normalize feature geometries. It is assumed that the South Pole is exterior to any polygons given. See here for a list of normalizations. If false, all feature geometries must be given already normalized. The points in all LinearRings must be listed in counter-clockwise order, and LinearRings may not intersect.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]136 "features": [
137 { # A feature within a table.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]138 "geometry": { # The geometry member of this Feature.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]139 },
140 "type": "Feature", # Identifies this object as a feature.
141 "properties": { # The properties associated with a feature. # Key/value pairs of this Feature.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]142 "a_key": "", # An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143 },
144 },
145 ],
146 }
147
148</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="batchPatch">batchPatch(id, body)</code>
153 <pre>Update the supplied features.
154
155A single batchPatch request can update:
156
157- Up to 50 features.
158- A combined total of 10 000 vertices.
159Feature limits are documented in the Supported data formats and limits article of the Google Maps Engine help center. Note that free and paid accounts have different limits.
160
161Feature updates use HTTP PATCH semantics:
162
163- A supplied value replaces an existing value (if any) in that field.
164- Omitted fields remain unchanged.
165- Complex values in geometries and properties must be replaced as atomic units. For example, providing just the coordinates of a geometry is not allowed; the complete geometry, including type, must be supplied.
166- Setting a property's value to null deletes that property.
167For more information about updating features, read Updating features in the Google Maps Engine developer's guide.
168
169Args:
170 id: string, The ID of the table containing the features to be patched. (required)
171 body: object, The request body. (required)
172 The object takes the form of:
173
174{ # The request sent to features.BatchPatch.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]175 "normalizeGeometries": true, # If true, the server will normalize feature geometries. It is assumed that the South Pole is exterior to any polygons given. See here for a list of normalizations. If false, all feature geometries must be given already normalized. The points in all LinearRings must be listed in counter-clockwise order, and LinearRings may not intersect.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]176 "features": [
177 { # A feature within a table.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]178 "geometry": { # The geometry member of this Feature.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]179 },
180 "type": "Feature", # Identifies this object as a feature.
181 "properties": { # The properties associated with a feature. # Key/value pairs of this Feature.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]182 "a_key": "", # An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]183 },
184 },
185 ],
186 }
187
188</pre>
189</div>
190
191<div class="method">
192 <code class="details" id="get">get(tableId, id, version=None, select=None)</code>
193 <pre>Return a single feature, given its ID.
194
195Args:
196 tableId: string, The ID of the table. (required)
197 id: string, The ID of the feature to get. (required)
198 version: string, The table version to access. See Accessing Public Data for information.
199 Allowed values
200 draft - The draft version.
201 published - The published version.
202 select: string, A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.
203
204Returns:
205 An object of the form:
206
207 { # A feature within a table.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]208 "geometry": { # The geometry member of this Feature.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]209 },
210 "type": "Feature", # Identifies this object as a feature.
211 "properties": { # The properties associated with a feature. # Key/value pairs of this Feature.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]212 "a_key": "", # An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]213 },
214 }</pre>
215</div>
216
217<div class="method">
218 <code class="details" id="list">list(id, orderBy=None, intersects=None, pageToken=None, maxResults=None, version=None, limit=None, include=None, where=None, select=None)</code>
219 <pre>Return all features readable by the current user.
220
221Args:
222 id: string, The ID of the table to which these features belong. (required)
223 orderBy: string, An SQL-like order by clause used to sort results. If this parameter is not included, the order of features is undefined.
224 intersects: string, A geometry literal that specifies the spatial restriction of the query.
225 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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]226 maxResults: integer, The maximum number of items to include in the response, used for paging. The maximum supported value is 1000.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]227 version: string, The table version to access. See Accessing Public Data for information.
228 Allowed values
229 draft - The draft version.
230 published - The published version.
231 limit: integer, The total number of features to return from the query, irrespective of the number of pages.
232 include: string, A comma separated list of optional data to include. Optional data available: schema.
233 where: string, An SQL-like predicate used to filter results.
234 select: string, A SQL-like projection clause used to specify returned properties. If this parameter is not included, all properties are returned.
235
236Returns:
237 An object of the form:
238
239 { # The response returned by a call to features.List.
240 "nextPageToken": "A String", # Next page token.
241 "allowedQueriesPerSecond": 3.14, # An indicator of the maximum rate at which queries may be made, if all queries were as expensive as this query.
242 "type": "FeatureCollection",
243 "features": [ # Resources returned.
244 { # A feature within a table.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]245 "geometry": { # The geometry member of this Feature.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]246 },
247 "type": "Feature", # Identifies this object as a feature.
248 "properties": { # The properties associated with a feature. # Key/value pairs of this Feature.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]249 "a_key": "", # An arbitrary key-value pair. The key must be the name of a column in the table's schema, and the type of the value must correspond to the type specified in the schema.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 },
251 },
252 ],
253 "schema": { # A schema indicating the properties which may be associated with features within a Table, and the types of those properties. # The feature schema.
254 "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.
255 "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]256 "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]257 {
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]258 "type": "A String", # The type of data stored in this column.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]259 "name": "A String", # The column name.
260 },
261 ],
262 },
263 }</pre>
264</div>
265
266<div class="method">
267 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
268 <pre>Retrieves the next page of results.
269
270Args:
271 previous_request: The request for the previous page. (required)
272 previous_response: The response from the request for the previous page. (required)
273
274Returns:
275 A request object that you can call 'execute()' on to request the next
276 page. Returns None if there are no more items in the collection.
277 </pre>
278</div>
279
280</body></html>