Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 63caac01ea7b9fbd8ae70bcbb4c6ecbec833ad3d / . / docs / dyn / mapsengine_v1.layers.html
blob: 6a27876e72bcb42fa48d18ed02431892a1b2a24d [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.layers.html">layers</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="mapsengine_v1.layers.parents.html">parents()</a></code>
79</p>
80<p class="firstline">Returns the parents Resource.</p>
81
82<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]83 <code><a href="#cancelProcessing">cancelProcessing(id)</a></code></p>
84<p class="firstline">Cancel processing on a layer asset.</p>
85<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86 <code><a href="#create">create(body, process=None)</a></code></p>
87<p class="firstline">Create a layer asset.</p>
88<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]89 <code><a href="#delete">delete(id)</a></code></p>
90<p class="firstline">Delete a layer.</p>
91<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92 <code><a href="#get">get(id, version=None)</a></code></p>
93<p class="firstline">Return metadata for a particular layer.</p>
94<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]95 <code><a href="#list">list(modifiedAfter=None, createdAfter=None, tags=None, projectId=None, maxResults=None, pageToken=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]96<p class="firstline">Return all layers readable by the current user.</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]101 <code><a href="#patch">patch(id, body)</a></code></p>
102<p class="firstline">Mutate a layer asset.</p>
103<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104 <code><a href="#process">process(id)</a></code></p>
105<p class="firstline">Process a layer asset.</p>
106<p class="toc_element">
107 <code><a href="#publish">publish(id)</a></code></p>
108<p class="firstline">Publish a layer asset.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]109<p class="toc_element">
110 <code><a href="#unpublish">unpublish(id)</a></code></p>
111<p class="firstline">Unpublish a layer asset.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]112<h3>Method Details</h3>
113<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]114 <code class="details" id="cancelProcessing">cancelProcessing(id)</code>
115 <pre>Cancel processing on a layer asset.
116
117Args:
118 id: string, The ID of the layer. (required)
119
120Returns:
121 An object of the form:
122
123 { # The response returned by a call to any asset's Process method.
124 }</pre>
125</div>
126
127<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 <code class="details" id="create">create(body, process=None)</code>
129 <pre>Create a layer asset.
130
131Args:
132 body: object, The request body. (required)
133 The object takes the form of:
134
135{ # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]136 "style": { # A vector style contains styling information for vector layer. # The Styling information for a vector layer.
137 "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
138 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
139 },
140 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
141 "displayRules": [
142 { # A display rule of the vector style.
143 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
144 "label": { # Text label style. # Label style for the point.
145 "opacity": 3.14, # Opacity of the text.
146 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
147 "outline": { # Basic color used in styling. # Outline color of the text.
148 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
149 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
150 },
151 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
152 "color": "A String", # Color of the text. If not provided, default to black.
153 "column": "A String", # The column value of the feature to be displayed.
154 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
155 },
156 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one field in 'icon' must be set.
157 "id": "A String", # Custom icon id.
158 "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
159 },
160 },
161 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
162 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
163 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
164 "color": "A String", # Color of the border.
165 "opacity": 3.14, # Opacity of the border.
166 "width": 3.14, # Width of the border, in pixels.
167 },
168 "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
169 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
170 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
171 },
172 },
173 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
174 "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
175 3.14,
176 ],
177 "stroke": { # Stroke of the line.
178 "color": "A String", # Color of the line.
179 "opacity": 3.14, # Opacity of the line.
180 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
181 },
182 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
183 "color": "A String", # Color of the border.
184 "opacity": 3.14, # Opacity of the border.
185 "width": 3.14, # Width of the border, in pixels.
186 },
187 "label": { # Text label style. # Label style for the line.
188 "opacity": 3.14, # Opacity of the text.
189 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
190 "outline": { # Basic color used in styling. # Outline color of the text.
191 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
192 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
193 },
194 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
195 "color": "A String", # Color of the text. If not provided, default to black.
196 "column": "A String", # The column value of the feature to be displayed.
197 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
198 },
199 },
200 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
201 "max": 42, # Maximum zoom level.
202 "min": 42, # Minimum zoom level.
203 },
204 "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
205 { # Conditions for filtering features.
206 "column": "A String", # The column name to filter on.
207 "operator": "A String", # Operation used to evaluate the filter.
208 "value": "", # Value to be evaluated against attribute.
209 },
210 ],
211 },
212 ],
213 },
214 "description": "A String", # The description of this Layer, supplied by the author.
215 "processingStatus": "A String", # The processing status of this layer.
216 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
217 "datasourceType": "A String", # The type of the datasources used to build this Layer.
218 "tags": [ # Tags of this Layer.
219 "A String",
220 ],
221 "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
222 "name": "A String", # The name of this Layer, supplied by the author.
223 "etag": "A String", # The ETag, used to refer to the current version of the asset.
224 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The numbers represent latitude and longitude in decimal degrees.
225 3.14,
226 ],
227 "projectId": "A String", # The ID of the project that this Layer is in.
228 "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
229 "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. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
230 "id": "A String", # A globally unique ID, used to refer to this Layer.
231 "datasources": [ # An array of datasources used to build this Layer. If datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If datasourceType is "table" then each element in this array is a reference to a Vector Table.
232 {
233 "id": "A String", # The ID of a datasource.
234 },
235 ],
236}
237
238 process: boolean, Whether to queue the created layer for processing.
239
240Returns:
241 An object of the form:
242
243 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]244 "style": { # A vector style contains styling information for vector layer. # The Styling information for a vector layer.
245 "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
246 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
247 },
248 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]249 "displayRules": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]250 { # A display rule of the vector style.
251 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
252 "label": { # Text label style. # Label style for the point.
253 "opacity": 3.14, # Opacity of the text.
254 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
255 "outline": { # Basic color used in styling. # Outline color of the text.
256 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
257 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
258 },
259 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
260 "color": "A String", # Color of the text. If not provided, default to black.
261 "column": "A String", # The column value of the feature to be displayed.
262 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
263 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]264 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one field in 'icon' must be set.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]265 "id": "A String", # Custom icon id.
266 "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
267 },
268 },
269 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
270 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
271 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
272 "color": "A String", # Color of the border.
273 "opacity": 3.14, # Opacity of the border.
274 "width": 3.14, # Width of the border, in pixels.
275 },
276 "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
277 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
278 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
279 },
280 },
281 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
282 "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
283 3.14,
284 ],
285 "stroke": { # Stroke of the line.
286 "color": "A String", # Color of the line.
287 "opacity": 3.14, # Opacity of the line.
288 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
289 },
290 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
291 "color": "A String", # Color of the border.
292 "opacity": 3.14, # Opacity of the border.
293 "width": 3.14, # Width of the border, in pixels.
294 },
295 "label": { # Text label style. # Label style for the line.
296 "opacity": 3.14, # Opacity of the text.
297 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
298 "outline": { # Basic color used in styling. # Outline color of the text.
299 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
300 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
301 },
302 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
303 "color": "A String", # Color of the text. If not provided, default to black.
304 "column": "A String", # The column value of the feature to be displayed.
305 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
306 },
307 },
308 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
309 "max": 42, # Maximum zoom level.
310 "min": 42, # Minimum zoom level.
311 },
312 "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
313 { # Conditions for filtering features.
314 "column": "A String", # The column name to filter on.
315 "operator": "A String", # Operation used to evaluate the filter.
316 "value": "", # Value to be evaluated against attribute.
317 },
318 ],
319 },
320 ],
321 },
322 "description": "A String", # The description of this Layer, supplied by the author.
323 "processingStatus": "A String", # The processing status of this layer.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]324 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
325 "datasourceType": "A String", # The type of the datasources used to build this Layer.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]326 "tags": [ # Tags of this Layer.
327 "A String",
328 ],
329 "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
330 "name": "A String", # The name of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]331 "etag": "A String", # The ETag, used to refer to the current version of the asset.
332 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]333 3.14,
334 ],
335 "projectId": "A String", # The ID of the project that this Layer is in.
336 "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]337 "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. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]338 "id": "A String", # A globally unique ID, used to refer to this Layer.
339 "datasources": [ # An array of datasources used to build this Layer. If datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If datasourceType is "table" then each element in this array is a reference to a Vector Table.
340 {
341 "id": "A String", # The ID of a datasource.
342 },
343 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]344 }</pre>
345</div>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]346
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]347<div class="method">
348 <code class="details" id="delete">delete(id)</code>
349 <pre>Delete a layer.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]350
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]351Args:
352 id: string, The ID of the layer. Only the layer creator or project owner are permitted to delete. If the layer is published, or included in a map, the request will fail. Unpublish the layer, and remove it from all maps prior to deleting. (required)
353</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]354</div>
355
356<div class="method">
357 <code class="details" id="get">get(id, version=None)</code>
358 <pre>Return metadata for a particular layer.
359
360Args:
361 id: string, The ID of the layer. (required)
362 version: string, A parameter
363 Allowed values
364 draft - The draft version.
365 published - The published version.
366
367Returns:
368 An object of the form:
369
370 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]371 "style": { # A vector style contains styling information for vector layer. # The Styling information for a vector layer.
372 "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
373 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
374 },
375 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
376 "displayRules": [
377 { # A display rule of the vector style.
378 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
379 "label": { # Text label style. # Label style for the point.
380 "opacity": 3.14, # Opacity of the text.
381 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
382 "outline": { # Basic color used in styling. # Outline color of the text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]383 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
384 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
385 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]386 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
387 "color": "A String", # Color of the text. If not provided, default to black.
388 "column": "A String", # The column value of the feature to be displayed.
389 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]390 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]391 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one field in 'icon' must be set.
392 "id": "A String", # Custom icon id.
393 "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]394 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]395 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]396 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
397 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
398 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
399 "color": "A String", # Color of the border.
400 "opacity": 3.14, # Opacity of the border.
401 "width": 3.14, # Width of the border, in pixels.
402 },
403 "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
404 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
405 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
406 },
407 },
408 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
409 "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
410 3.14,
411 ],
412 "stroke": { # Stroke of the line.
413 "color": "A String", # Color of the line.
414 "opacity": 3.14, # Opacity of the line.
415 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
416 },
417 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
418 "color": "A String", # Color of the border.
419 "opacity": 3.14, # Opacity of the border.
420 "width": 3.14, # Width of the border, in pixels.
421 },
422 "label": { # Text label style. # Label style for the line.
423 "opacity": 3.14, # Opacity of the text.
424 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
425 "outline": { # Basic color used in styling. # Outline color of the text.
426 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
427 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
428 },
429 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
430 "color": "A String", # Color of the text. If not provided, default to black.
431 "column": "A String", # The column value of the feature to be displayed.
432 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
433 },
434 },
435 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
436 "max": 42, # Maximum zoom level.
437 "min": 42, # Minimum zoom level.
438 },
439 "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
440 { # Conditions for filtering features.
441 "column": "A String", # The column name to filter on.
442 "operator": "A String", # Operation used to evaluate the filter.
443 "value": "", # Value to be evaluated against attribute.
444 },
445 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]446 },
447 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]448 },
449 "description": "A String", # The description of this Layer, supplied by the author.
450 "processingStatus": "A String", # The processing status of this layer.
451 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
452 "datasourceType": "A String", # The type of the datasources used to build this Layer.
453 "tags": [ # Tags of this Layer.
454 "A String",
455 ],
456 "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
457 "name": "A String", # The name of this Layer, supplied by the author.
458 "etag": "A String", # The ETag, used to refer to the current version of the asset.
459 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The numbers represent latitude and longitude in decimal degrees.
460 3.14,
461 ],
462 "projectId": "A String", # The ID of the project that this Layer is in.
463 "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
464 "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. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
465 "id": "A String", # A globally unique ID, used to refer to this Layer.
466 "datasources": [ # An array of datasources used to build this Layer. If datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If datasourceType is "table" then each element in this array is a reference to a Vector Table.
467 {
468 "id": "A String", # The ID of a datasource.
469 },
470 ],
471 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]472</div>
473
474<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]475 <code class="details" id="list">list(modifiedAfter=None, createdAfter=None, tags=None, projectId=None, maxResults=None, pageToken=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]476 <pre>Return all layers readable by the current user.
477
478Args:
479 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.
480 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]481 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]482 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.
483 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]484 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]485 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.
486 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
487 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
488 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.
489
490Returns:
491 An object of the form:
492
493 { # The response returned by a call to layers.List.
494 "layers": [ # Resources returned.
495 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]496 "style": { # A vector style contains styling information for vector layer. # The Styling information for a vector layer.
497 "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
498 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
499 },
500 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
501 "displayRules": [
502 { # A display rule of the vector style.
503 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
504 "label": { # Text label style. # Label style for the point.
505 "opacity": 3.14, # Opacity of the text.
506 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
507 "outline": { # Basic color used in styling. # Outline color of the text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]508 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
509 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
510 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]511 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
512 "color": "A String", # Color of the text. If not provided, default to black.
513 "column": "A String", # The column value of the feature to be displayed.
514 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]515 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]516 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one field in 'icon' must be set.
517 "id": "A String", # Custom icon id.
518 "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]519 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]520 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]521 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
522 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
523 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
524 "color": "A String", # Color of the border.
525 "opacity": 3.14, # Opacity of the border.
526 "width": 3.14, # Width of the border, in pixels.
527 },
528 "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
529 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
530 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
531 },
532 },
533 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
534 "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
535 3.14,
536 ],
537 "stroke": { # Stroke of the line.
538 "color": "A String", # Color of the line.
539 "opacity": 3.14, # Opacity of the line.
540 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
541 },
542 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
543 "color": "A String", # Color of the border.
544 "opacity": 3.14, # Opacity of the border.
545 "width": 3.14, # Width of the border, in pixels.
546 },
547 "label": { # Text label style. # Label style for the line.
548 "opacity": 3.14, # Opacity of the text.
549 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
550 "outline": { # Basic color used in styling. # Outline color of the text.
551 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
552 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
553 },
554 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
555 "color": "A String", # Color of the text. If not provided, default to black.
556 "column": "A String", # The column value of the feature to be displayed.
557 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
558 },
559 },
560 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
561 "max": 42, # Maximum zoom level.
562 "min": 42, # Minimum zoom level.
563 },
564 "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
565 { # Conditions for filtering features.
566 "column": "A String", # The column name to filter on.
567 "operator": "A String", # Operation used to evaluate the filter.
568 "value": "", # Value to be evaluated against attribute.
569 },
570 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]571 },
572 ],
573 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]574 "description": "A String", # The description of this Layer, supplied by the author.
575 "processingStatus": "A String", # The processing status of this layer.
576 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
577 "datasourceType": "A String", # The type of the datasources used to build this Layer.
578 "tags": [ # Tags of this Layer.
579 "A String",
580 ],
581 "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
582 "name": "A String", # The name of this Layer, supplied by the author.
583 "etag": "A String", # The ETag, used to refer to the current version of the asset.
584 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The numbers represent latitude and longitude in decimal degrees.
585 3.14,
586 ],
587 "projectId": "A String", # The ID of the project that this Layer is in.
588 "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
589 "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. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
590 "id": "A String", # A globally unique ID, used to refer to this Layer.
591 "datasources": [ # An array of datasources used to build this Layer. If datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If datasourceType is "table" then each element in this array is a reference to a Vector Table.
592 {
593 "id": "A String", # The ID of a datasource.
594 },
595 ],
596 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]597 ],
598 "nextPageToken": "A String", # Next page token.
599 }</pre>
600</div>
601
602<div class="method">
603 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
604 <pre>Retrieves the next page of results.
605
606Args:
607 previous_request: The request for the previous page. (required)
608 previous_response: The response from the request for the previous page. (required)
609
610Returns:
611 A request object that you can call 'execute()' on to request the next
612 page. Returns None if there are no more items in the collection.
613 </pre>
614</div>
615
616<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]617 <code class="details" id="patch">patch(id, body)</code>
618 <pre>Mutate a layer asset.
619
620Args:
621 id: string, The ID of the layer. (required)
622 body: object, The request body. (required)
623 The object takes the form of:
624
625{ # A Layer combines multiple datasources, with styling information, for presentation on a map.
626 "style": { # A vector style contains styling information for vector layer. # The Styling information for a vector layer.
627 "featureInfo": { # A feature info contains information about individual feature. # Individual feature info, this is called Info Window in Maps Engine UI. If not provided, a default template with all attributes will be generated.
628 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
629 },
630 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
631 "displayRules": [
632 { # A display rule of the vector style.
633 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
634 "label": { # Text label style. # Label style for the point.
635 "opacity": 3.14, # Opacity of the text.
636 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
637 "outline": { # Basic color used in styling. # Outline color of the text.
638 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
639 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
640 },
641 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
642 "color": "A String", # Color of the text. If not provided, default to black.
643 "column": "A String", # The column value of the feature to be displayed.
644 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
645 },
646 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one field in 'icon' must be set.
647 "id": "A String", # Custom icon id.
648 "name": "A String", # Stock icon name. To use a stock icon, prefix it with 'gx_'. See Stock icon names for valid icon names. For example, to specify small_red, set name to 'gx_small_red'.
649 },
650 },
651 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
652 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
653 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
654 "color": "A String", # Color of the border.
655 "opacity": 3.14, # Opacity of the border.
656 "width": 3.14, # Width of the border, in pixels.
657 },
658 "fill": { # Basic color used in styling. # Fill color of the polygon. If not provided, the polygon will be transparent and not visible if there is no border.
659 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
660 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
661 },
662 },
663 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
664 "dash": [ # Dash defines the pattern of the line, the values are pixel lengths of alternating dash and gap. If dash is not provided, then it means a solid line. Dash can contain up to 10 values and must contain even number of values.
665 3.14,
666 ],
667 "stroke": { # Stroke of the line.
668 "color": "A String", # Color of the line.
669 "opacity": 3.14, # Opacity of the line.
670 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
671 },
672 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
673 "color": "A String", # Color of the border.
674 "opacity": 3.14, # Opacity of the border.
675 "width": 3.14, # Width of the border, in pixels.
676 },
677 "label": { # Text label style. # Label style for the line.
678 "opacity": 3.14, # Opacity of the text.
679 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
680 "outline": { # Basic color used in styling. # Outline color of the text.
681 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
682 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
683 },
684 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
685 "color": "A String", # Color of the text. If not provided, default to black.
686 "column": "A String", # The column value of the feature to be displayed.
687 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
688 },
689 },
690 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
691 "max": 42, # Maximum zoom level.
692 "min": 42, # Minimum zoom level.
693 },
694 "filters": [ # This display rule will only be applied to features that match all of the filters here. If filters is empty, then the rule applies to all features.
695 { # Conditions for filtering features.
696 "column": "A String", # The column name to filter on.
697 "operator": "A String", # Operation used to evaluate the filter.
698 "value": "", # Value to be evaluated against attribute.
699 },
700 ],
701 },
702 ],
703 },
704 "description": "A String", # The description of this Layer, supplied by the author.
705 "processingStatus": "A String", # The processing status of this layer.
706 "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. 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. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
707 "datasourceType": "A String", # The type of the datasources used to build this Layer.
708 "tags": [ # Tags of this Layer.
709 "A String",
710 ],
711 "creationTime": "A String", # The creation time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
712 "name": "A String", # The name of this Layer, supplied by the author.
713 "etag": "A String", # The ETag, used to refer to the current version of the asset.
714 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The numbers represent latitude and longitude in decimal degrees.
715 3.14,
716 ],
717 "projectId": "A String", # The ID of the project that this Layer is in.
718 "lastModifiedTime": "A String", # The last modified time of this layer. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
719 "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. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
720 "id": "A String", # A globally unique ID, used to refer to this Layer.
721 "datasources": [ # An array of datasources used to build this Layer. If datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If datasourceType is "table" then each element in this array is a reference to a Vector Table.
722 {
723 "id": "A String", # The ID of a datasource.
724 },
725 ],
726}
727
728</pre>
729</div>
730
731<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]732 <code class="details" id="process">process(id)</code>
733 <pre>Process a layer asset.
734
735Args:
736 id: string, The ID of the layer. (required)
737
738Returns:
739 An object of the form:
740
741 { # The response returned by a call to any asset's Process method.
742 }</pre>
743</div>
744
745<div class="method">
746 <code class="details" id="publish">publish(id)</code>
747 <pre>Publish a layer asset.
748
749Args:
750 id: string, The ID of the layer. (required)
751
752Returns:
753 An object of the form:
754
755 { # The response returned by a call to any asset's Publish method.
756 }</pre>
757</div>
758
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]759<div class="method">
760 <code class="details" id="unpublish">unpublish(id)</code>
761 <pre>Unpublish a layer asset.
762
763Args:
764 id: string, The ID of the layer. (required)
765
766Returns:
767 An object of the form:
768
769 { # The response returned by a call to any asset's Publish method.
770 }</pre>
771</div>
772
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]773</body></html>