blob: cc1403abbf3377fb02225166f19b9e24ceb56f76 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -04001<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 Citro0e5b9bf2014-10-15 10:26:14 -070083 <code><a href="mapsengine_v1.layers.permissions.html">permissions()</a></code>
84</p>
85<p class="firstline">Returns the permissions Resource.</p>
86
87<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -070088 <code><a href="#cancelProcessing">cancelProcessing(id)</a></code></p>
89<p class="firstline">Cancel processing on a layer asset.</p>
90<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -040091 <code><a href="#create">create(body, process=None)</a></code></p>
92<p class="firstline">Create a layer asset.</p>
93<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -070094 <code><a href="#delete">delete(id)</a></code></p>
95<p class="firstline">Delete a layer.</p>
96<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -040097 <code><a href="#get">get(id, version=None)</a></code></p>
98<p class="firstline">Return metadata for a particular layer.</p>
99<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700100 <code><a href="#getPublished">getPublished(id)</a></code></p>
101<p class="firstline">Return the published metadata for a particular layer.</p>
102<p class="toc_element">
103 <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 -0400104<p class="firstline">Return all layers readable by the current user.</p>
105<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700106 <code><a href="#listPublished">listPublished(pageToken=None, maxResults=None, projectId=None)</a></code></p>
107<p class="firstline">Return all published layers readable by the current user.</p>
108<p class="toc_element">
109 <code><a href="#listPublished_next">listPublished_next(previous_request, previous_response)</a></code></p>
110<p class="firstline">Retrieves the next page of results.</p>
111<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400112 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
113<p class="firstline">Retrieves the next page of results.</p>
114<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700115 <code><a href="#patch">patch(id, body)</a></code></p>
116<p class="firstline">Mutate a layer asset.</p>
117<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400118 <code><a href="#process">process(id)</a></code></p>
119<p class="firstline">Process a layer asset.</p>
120<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700121 <code><a href="#publish">publish(id, force=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400122<p class="firstline">Publish a layer asset.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700123<p class="toc_element">
124 <code><a href="#unpublish">unpublish(id)</a></code></p>
125<p class="firstline">Unpublish a layer asset.</p>
John Asmuth614db982014-04-24 15:46:26 -0400126<h3>Method Details</h3>
127<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700128 <code class="details" id="cancelProcessing">cancelProcessing(id)</code>
129 <pre>Cancel processing on a layer asset.
130
131Args:
132 id: string, The ID of the layer. (required)
133
134Returns:
135 An object of the form:
136
137 { # The response returned by a call to any asset's Process method.
138 }</pre>
139</div>
140
141<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400142 <code class="details" id="create">create(body, process=None)</code>
143 <pre>Create a layer asset.
144
145Args:
146 body: object, The request body. (required)
147 The object takes the form of:
148
149{ # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700150 "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
Craig Citro065b5302014-08-14 00:47:23 -0700151 "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.
152 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
153 },
154 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
155 "displayRules": [
156 { # A display rule of the vector style.
157 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
158 "label": { # Text label style. # Label style for the point.
159 "opacity": 3.14, # Opacity of the text.
160 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
161 "outline": { # Basic color used in styling. # Outline color of the text.
162 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
163 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
164 },
165 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
166 "color": "A String", # Color of the text. If not provided, default to black.
167 "column": "A String", # The column value of the feature to be displayed.
168 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
169 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700170 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
171 "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
172 "column": "A String", # Name of the numeric column used to scale a shape.
173 "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
174 "max": 3.14, # Maximum value.
175 "min": 3.14, # Minimum value.
176 },
177 "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
178 "max": 3.14, # Maximum size, in pixels.
179 "min": 3.14, # Minimum size, in pixels.
180 },
181 "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
182 },
Craig Citro065b5302014-08-14 00:47:23 -0700183 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700184 "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
185 "shape": "A String", # Name of the shape.
186 "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
187 "color": "A String", # Color of the border.
188 "opacity": 3.14, # Opacity of the border.
189 "width": 3.14, # Width of the border, in pixels.
190 },
191 "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
192 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
193 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
194 },
195 },
Craig Citro065b5302014-08-14 00:47:23 -0700196 "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'.
197 },
198 },
199 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
200 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
201 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
202 "color": "A String", # Color of the border.
203 "opacity": 3.14, # Opacity of the border.
204 "width": 3.14, # Width of the border, in pixels.
205 },
Craig Citroe633be12015-03-02 13:40:36 -0800206 "label": { # Text label style. # Label style for the polygon.
207 "opacity": 3.14, # Opacity of the text.
208 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
209 "outline": { # Basic color used in styling. # Outline color of the text.
210 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
211 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
212 },
213 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
214 "color": "A String", # Color of the text. If not provided, default to black.
215 "column": "A String", # The column value of the feature to be displayed.
216 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
217 },
Craig Citro065b5302014-08-14 00:47:23 -0700218 "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.
219 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
220 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
221 },
222 },
223 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
224 "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.
225 3.14,
226 ],
227 "stroke": { # Stroke of the line.
228 "color": "A String", # Color of the line.
229 "opacity": 3.14, # Opacity of the line.
230 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
231 },
232 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
233 "color": "A String", # Color of the border.
234 "opacity": 3.14, # Opacity of the border.
235 "width": 3.14, # Width of the border, in pixels.
236 },
237 "label": { # Text label style. # Label style for the line.
238 "opacity": 3.14, # Opacity of the text.
239 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
240 "outline": { # Basic color used in styling. # Outline color of the text.
241 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
242 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
243 },
244 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
245 "color": "A String", # Color of the text. If not provided, default to black.
246 "column": "A String", # The column value of the feature to be displayed.
247 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
248 },
249 },
250 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
251 "max": 42, # Maximum zoom level.
252 "min": 42, # Minimum zoom level.
253 },
254 "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.
255 { # Conditions for filtering features.
256 "column": "A String", # The column name to filter on.
257 "operator": "A String", # Operation used to evaluate the filter.
258 "value": "", # Value to be evaluated against attribute.
259 },
260 ],
261 },
262 ],
263 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700264 "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
Craig Citro065b5302014-08-14 00:47:23 -0700265 {
266 "id": "A String", # The ID of a datasource.
267 },
268 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700269 "processingStatus": "A String", # The processing status of this layer.
270 "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.
271 "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
272 "tags": [ # Tags of this Layer.
273 "A String",
274 ],
275 "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).
276 "publishingStatus": "A String", # The publishing status of this layer.
277 "name": "A String", # The name of this Layer, supplied by the author.
278 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
279 "etag": "A String", # The ETag, used to refer to the current version of the asset.
280 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
281 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
282 3.14,
283 ],
284 "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
285 "projectId": "A String", # The ID of the project that this Layer is in.
286 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
287 "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).
288 "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.
289 "id": "A String", # A globally unique ID, used to refer to this Layer.
290 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700291}
292
293 process: boolean, Whether to queue the created layer for processing.
294
295Returns:
296 An object of the form:
297
298 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700299 "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
John Asmuth614db982014-04-24 15:46:26 -0400300 "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.
301 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
302 },
303 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
Craig Citro065b5302014-08-14 00:47:23 -0700304 "displayRules": [
John Asmuth614db982014-04-24 15:46:26 -0400305 { # A display rule of the vector style.
306 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
307 "label": { # Text label style. # Label style for the point.
308 "opacity": 3.14, # Opacity of the text.
309 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
310 "outline": { # Basic color used in styling. # Outline color of the text.
311 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
312 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
313 },
314 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
315 "color": "A String", # Color of the text. If not provided, default to black.
316 "column": "A String", # The column value of the feature to be displayed.
317 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
318 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700319 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
320 "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
321 "column": "A String", # Name of the numeric column used to scale a shape.
322 "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
323 "max": 3.14, # Maximum value.
324 "min": 3.14, # Minimum value.
325 },
326 "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
327 "max": 3.14, # Maximum size, in pixels.
328 "min": 3.14, # Minimum size, in pixels.
329 },
330 "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
331 },
John Asmuth614db982014-04-24 15:46:26 -0400332 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700333 "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
334 "shape": "A String", # Name of the shape.
335 "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
336 "color": "A String", # Color of the border.
337 "opacity": 3.14, # Opacity of the border.
338 "width": 3.14, # Width of the border, in pixels.
339 },
340 "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
341 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
342 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
343 },
344 },
John Asmuth614db982014-04-24 15:46:26 -0400345 "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'.
346 },
347 },
348 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
349 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
350 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
351 "color": "A String", # Color of the border.
352 "opacity": 3.14, # Opacity of the border.
353 "width": 3.14, # Width of the border, in pixels.
354 },
Craig Citroe633be12015-03-02 13:40:36 -0800355 "label": { # Text label style. # Label style for the polygon.
356 "opacity": 3.14, # Opacity of the text.
357 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
358 "outline": { # Basic color used in styling. # Outline color of the text.
359 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
360 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
361 },
362 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
363 "color": "A String", # Color of the text. If not provided, default to black.
364 "column": "A String", # The column value of the feature to be displayed.
365 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
366 },
John Asmuth614db982014-04-24 15:46:26 -0400367 "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.
368 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
369 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
370 },
371 },
372 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
373 "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.
374 3.14,
375 ],
376 "stroke": { # Stroke of the line.
377 "color": "A String", # Color of the line.
378 "opacity": 3.14, # Opacity of the line.
379 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
380 },
381 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
382 "color": "A String", # Color of the border.
383 "opacity": 3.14, # Opacity of the border.
384 "width": 3.14, # Width of the border, in pixels.
385 },
386 "label": { # Text label style. # Label style for the line.
387 "opacity": 3.14, # Opacity of the text.
388 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
389 "outline": { # Basic color used in styling. # Outline color of the text.
390 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
391 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
392 },
393 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
394 "color": "A String", # Color of the text. If not provided, default to black.
395 "column": "A String", # The column value of the feature to be displayed.
396 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
397 },
398 },
399 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
400 "max": 42, # Maximum zoom level.
401 "min": 42, # Minimum zoom level.
402 },
403 "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.
404 { # Conditions for filtering features.
405 "column": "A String", # The column name to filter on.
406 "operator": "A String", # Operation used to evaluate the filter.
407 "value": "", # Value to be evaluated against attribute.
408 },
409 ],
410 },
411 ],
412 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700413 "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
John Asmuth614db982014-04-24 15:46:26 -0400414 {
415 "id": "A String", # The ID of a datasource.
416 },
417 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700418 "processingStatus": "A String", # The processing status of this layer.
419 "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.
420 "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
421 "tags": [ # Tags of this Layer.
422 "A String",
423 ],
424 "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).
425 "publishingStatus": "A String", # The publishing status of this layer.
426 "name": "A String", # The name of this Layer, supplied by the author.
427 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
428 "etag": "A String", # The ETag, used to refer to the current version of the asset.
429 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
430 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
431 3.14,
432 ],
433 "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
434 "projectId": "A String", # The ID of the project that this Layer is in.
435 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
436 "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).
437 "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.
438 "id": "A String", # A globally unique ID, used to refer to this Layer.
439 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700440 }</pre>
441</div>
John Asmuth614db982014-04-24 15:46:26 -0400442
Craig Citro065b5302014-08-14 00:47:23 -0700443<div class="method">
444 <code class="details" id="delete">delete(id)</code>
445 <pre>Delete a layer.
John Asmuth614db982014-04-24 15:46:26 -0400446
Craig Citro065b5302014-08-14 00:47:23 -0700447Args:
448 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)
449</pre>
John Asmuth614db982014-04-24 15:46:26 -0400450</div>
451
452<div class="method">
453 <code class="details" id="get">get(id, version=None)</code>
454 <pre>Return metadata for a particular layer.
455
456Args:
457 id: string, The ID of the layer. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700458 version: string, Deprecated: The version parameter indicates which version of the layer should be returned. When version is set to published, the published version of the layer will be returned. Please use the layers.getPublished endpoint instead.
John Asmuth614db982014-04-24 15:46:26 -0400459 Allowed values
460 draft - The draft version.
461 published - The published version.
462
463Returns:
464 An object of the form:
465
466 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700467 "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
Craig Citro065b5302014-08-14 00:47:23 -0700468 "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.
469 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
470 },
471 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
472 "displayRules": [
473 { # A display rule of the vector style.
474 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
475 "label": { # Text label style. # Label style for the point.
476 "opacity": 3.14, # Opacity of the text.
477 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
478 "outline": { # Basic color used in styling. # Outline color of the text.
John Asmuth614db982014-04-24 15:46:26 -0400479 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
480 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
481 },
Craig Citro065b5302014-08-14 00:47:23 -0700482 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
483 "color": "A String", # Color of the text. If not provided, default to black.
484 "column": "A String", # The column value of the feature to be displayed.
485 "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 -0400486 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700487 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
488 "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
489 "column": "A String", # Name of the numeric column used to scale a shape.
490 "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
491 "max": 3.14, # Maximum value.
492 "min": 3.14, # Minimum value.
493 },
494 "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
495 "max": 3.14, # Maximum size, in pixels.
496 "min": 3.14, # Minimum size, in pixels.
497 },
498 "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
499 },
Craig Citro065b5302014-08-14 00:47:23 -0700500 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700501 "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
502 "shape": "A String", # Name of the shape.
503 "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
504 "color": "A String", # Color of the border.
505 "opacity": 3.14, # Opacity of the border.
506 "width": 3.14, # Width of the border, in pixels.
507 },
508 "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
509 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
510 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
511 },
512 },
Craig Citro065b5302014-08-14 00:47:23 -0700513 "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 -0400514 },
John Asmuth614db982014-04-24 15:46:26 -0400515 },
Craig Citro065b5302014-08-14 00:47:23 -0700516 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
517 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
518 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
519 "color": "A String", # Color of the border.
520 "opacity": 3.14, # Opacity of the border.
521 "width": 3.14, # Width of the border, in pixels.
522 },
Craig Citroe633be12015-03-02 13:40:36 -0800523 "label": { # Text label style. # Label style for the polygon.
524 "opacity": 3.14, # Opacity of the text.
525 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
526 "outline": { # Basic color used in styling. # Outline color of the text.
527 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
528 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
529 },
530 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
531 "color": "A String", # Color of the text. If not provided, default to black.
532 "column": "A String", # The column value of the feature to be displayed.
533 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
534 },
Craig Citro065b5302014-08-14 00:47:23 -0700535 "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.
536 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
537 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
538 },
539 },
540 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
541 "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.
542 3.14,
543 ],
544 "stroke": { # Stroke of the line.
545 "color": "A String", # Color of the line.
546 "opacity": 3.14, # Opacity of the line.
547 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
548 },
549 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
550 "color": "A String", # Color of the border.
551 "opacity": 3.14, # Opacity of the border.
552 "width": 3.14, # Width of the border, in pixels.
553 },
554 "label": { # Text label style. # Label style for the line.
555 "opacity": 3.14, # Opacity of the text.
556 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
557 "outline": { # Basic color used in styling. # Outline color of the text.
558 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
559 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
560 },
561 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
562 "color": "A String", # Color of the text. If not provided, default to black.
563 "column": "A String", # The column value of the feature to be displayed.
564 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
565 },
566 },
567 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
568 "max": 42, # Maximum zoom level.
569 "min": 42, # Minimum zoom level.
570 },
571 "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.
572 { # Conditions for filtering features.
573 "column": "A String", # The column name to filter on.
574 "operator": "A String", # Operation used to evaluate the filter.
575 "value": "", # Value to be evaluated against attribute.
576 },
577 ],
John Asmuth614db982014-04-24 15:46:26 -0400578 },
579 ],
Craig Citro065b5302014-08-14 00:47:23 -0700580 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700581 "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
Craig Citro065b5302014-08-14 00:47:23 -0700582 {
583 "id": "A String", # The ID of a datasource.
584 },
585 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700586 "processingStatus": "A String", # The processing status of this layer.
587 "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.
588 "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
589 "tags": [ # Tags of this Layer.
590 "A String",
591 ],
592 "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).
593 "publishingStatus": "A String", # The publishing status of this layer.
594 "name": "A String", # The name of this Layer, supplied by the author.
595 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
596 "etag": "A String", # The ETag, used to refer to the current version of the asset.
597 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
598 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
599 3.14,
600 ],
601 "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
602 "projectId": "A String", # The ID of the project that this Layer is in.
603 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
604 "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).
605 "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.
606 "id": "A String", # A globally unique ID, used to refer to this Layer.
607 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700608 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400609</div>
610
611<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700612 <code class="details" id="getPublished">getPublished(id)</code>
613 <pre>Return the published metadata for a particular layer.
John Asmuth614db982014-04-24 15:46:26 -0400614
615Args:
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700616 id: string, The ID of the layer. (required)
John Asmuth614db982014-04-24 15:46:26 -0400617
618Returns:
619 An object of the form:
620
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700621 { # The published version of a layer.
622 "projectId": "A String", # The ID of the project that this Layer is in.
623 "name": "A String", # The name of this Layer, supplied by the author.
624 "description": "A String", # The description of this Layer, supplied by the author.
625 "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
626 "id": "A String", # A globally unique ID, used to refer to this Layer.
627 }</pre>
628</div>
629
630<div class="method">
631 <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>
632 <pre>Return all layers readable by the current user.
633
634Args:
635 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.
636 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
637 processingStatus: string, A parameter
638 Allowed values
639 complete - The layer has completed processing.
640 failed - The layer has failed processing.
641 notReady - The layer is not ready for processing.
642 processing - The layer is processing.
643 ready - The layer is ready for processing.
644 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.
645 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.
646 role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
647 Allowed values
648 owner - The user can read, write and administer the asset.
649 reader - The user can read the asset.
650 writer - The user can read and write the asset.
651 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.
652 tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
653 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
654 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
655 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.
656 search: string, An unstructured search string used to filter the set of results based on asset metadata.
657 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.
658
659Returns:
660 An object of the form:
661
662 { # The response returned by a call to layers.List. Note: The list response does not include all the fields available in a layer. Refer to the layer 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 layer.
John Asmuth614db982014-04-24 15:46:26 -0400663 "layers": [ # Resources returned.
664 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700665 "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
Craig Citro065b5302014-08-14 00:47:23 -0700666 "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.
667 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
668 },
669 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
670 "displayRules": [
671 { # A display rule of the vector style.
672 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
673 "label": { # Text label style. # Label style for the point.
674 "opacity": 3.14, # Opacity of the text.
675 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
676 "outline": { # Basic color used in styling. # Outline color of the text.
John Asmuth614db982014-04-24 15:46:26 -0400677 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
678 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
679 },
Craig Citro065b5302014-08-14 00:47:23 -0700680 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
681 "color": "A String", # Color of the text. If not provided, default to black.
682 "column": "A String", # The column value of the feature to be displayed.
683 "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 -0400684 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700685 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
686 "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
687 "column": "A String", # Name of the numeric column used to scale a shape.
688 "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
689 "max": 3.14, # Maximum value.
690 "min": 3.14, # Minimum value.
691 },
692 "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
693 "max": 3.14, # Maximum size, in pixels.
694 "min": 3.14, # Minimum size, in pixels.
695 },
696 "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
697 },
Craig Citro065b5302014-08-14 00:47:23 -0700698 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700699 "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
700 "shape": "A String", # Name of the shape.
701 "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
702 "color": "A String", # Color of the border.
703 "opacity": 3.14, # Opacity of the border.
704 "width": 3.14, # Width of the border, in pixels.
705 },
706 "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
707 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
708 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
709 },
710 },
Craig Citro065b5302014-08-14 00:47:23 -0700711 "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 -0400712 },
John Asmuth614db982014-04-24 15:46:26 -0400713 },
Craig Citro065b5302014-08-14 00:47:23 -0700714 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
715 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
716 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
717 "color": "A String", # Color of the border.
718 "opacity": 3.14, # Opacity of the border.
719 "width": 3.14, # Width of the border, in pixels.
720 },
Craig Citroe633be12015-03-02 13:40:36 -0800721 "label": { # Text label style. # Label style for the polygon.
722 "opacity": 3.14, # Opacity of the text.
723 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
724 "outline": { # Basic color used in styling. # Outline color of the text.
725 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
726 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
727 },
728 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
729 "color": "A String", # Color of the text. If not provided, default to black.
730 "column": "A String", # The column value of the feature to be displayed.
731 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
732 },
Craig Citro065b5302014-08-14 00:47:23 -0700733 "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.
734 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
735 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
736 },
737 },
738 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
739 "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.
740 3.14,
741 ],
742 "stroke": { # Stroke of the line.
743 "color": "A String", # Color of the line.
744 "opacity": 3.14, # Opacity of the line.
745 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
746 },
747 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
748 "color": "A String", # Color of the border.
749 "opacity": 3.14, # Opacity of the border.
750 "width": 3.14, # Width of the border, in pixels.
751 },
752 "label": { # Text label style. # Label style for the line.
753 "opacity": 3.14, # Opacity of the text.
754 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
755 "outline": { # Basic color used in styling. # Outline color of the text.
756 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
757 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
758 },
759 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
760 "color": "A String", # Color of the text. If not provided, default to black.
761 "column": "A String", # The column value of the feature to be displayed.
762 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
763 },
764 },
765 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
766 "max": 42, # Maximum zoom level.
767 "min": 42, # Minimum zoom level.
768 },
769 "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.
770 { # Conditions for filtering features.
771 "column": "A String", # The column name to filter on.
772 "operator": "A String", # Operation used to evaluate the filter.
773 "value": "", # Value to be evaluated against attribute.
774 },
775 ],
John Asmuth614db982014-04-24 15:46:26 -0400776 },
777 ],
778 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700779 "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
Craig Citro065b5302014-08-14 00:47:23 -0700780 {
781 "id": "A String", # The ID of a datasource.
782 },
783 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700784 "processingStatus": "A String", # The processing status of this layer.
785 "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.
786 "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
787 "tags": [ # Tags of this Layer.
788 "A String",
789 ],
790 "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).
791 "publishingStatus": "A String", # The publishing status of this layer.
792 "name": "A String", # The name of this Layer, supplied by the author.
793 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
794 "etag": "A String", # The ETag, used to refer to the current version of the asset.
795 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
796 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
797 3.14,
798 ],
799 "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
800 "projectId": "A String", # The ID of the project that this Layer is in.
801 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
802 "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).
803 "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.
804 "id": "A String", # A globally unique ID, used to refer to this Layer.
805 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700806 },
John Asmuth614db982014-04-24 15:46:26 -0400807 ],
808 "nextPageToken": "A String", # Next page token.
809 }</pre>
810</div>
811
812<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700813 <code class="details" id="listPublished">listPublished(pageToken=None, maxResults=None, projectId=None)</code>
814 <pre>Return all published layers readable by the current user.
815
816Args:
817 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.
818 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
819 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.
820
821Returns:
822 An object of the form:
823
824 { # The response returned by a call to layers.List.published.
825 "layers": [ # Resources returned.
826 { # The published version of a layer.
827 "projectId": "A String", # The ID of the project that this Layer is in.
828 "name": "A String", # The name of this Layer, supplied by the author.
829 "description": "A String", # The description of this Layer, supplied by the author.
830 "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
831 "id": "A String", # A globally unique ID, used to refer to this Layer.
832 },
833 ],
834 "nextPageToken": "A String", # Next page token.
835 }</pre>
836</div>
837
838<div class="method">
839 <code class="details" id="listPublished_next">listPublished_next(previous_request, previous_response)</code>
840 <pre>Retrieves the next page of results.
841
842Args:
843 previous_request: The request for the previous page. (required)
844 previous_response: The response from the request for the previous page. (required)
845
846Returns:
847 A request object that you can call 'execute()' on to request the next
848 page. Returns None if there are no more items in the collection.
849 </pre>
850</div>
851
852<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400853 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
854 <pre>Retrieves the next page of results.
855
856Args:
857 previous_request: The request for the previous page. (required)
858 previous_response: The response from the request for the previous page. (required)
859
860Returns:
861 A request object that you can call 'execute()' on to request the next
862 page. Returns None if there are no more items in the collection.
863 </pre>
864</div>
865
866<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700867 <code class="details" id="patch">patch(id, body)</code>
868 <pre>Mutate a layer asset.
869
870Args:
871 id: string, The ID of the layer. (required)
872 body: object, The request body. (required)
873 The object takes the form of:
874
875{ # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700876 "style": { # A vector style contains styling information for vector layer. # The styling information for a vector layer. Note: Style information is returned in response to a get request but not a list request. After requesting a list of layers, you'll need to send a get request to retrieve the VectorStyles for each layer.
Craig Citro065b5302014-08-14 00:47:23 -0700877 "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.
878 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
879 },
880 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
881 "displayRules": [
882 { # A display rule of the vector style.
883 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
884 "label": { # Text label style. # Label style for the point.
885 "opacity": 3.14, # Opacity of the text.
886 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
887 "outline": { # Basic color used in styling. # Outline color of the text.
888 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
889 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
890 },
891 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
892 "color": "A String", # Color of the text. If not provided, default to black.
893 "column": "A String", # The column value of the feature to be displayed.
894 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
895 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700896 "icon": { # Style for icon, this is part of point style. # Icon for the point; if it isn't null, exactly one of 'name', 'id' or 'scaledShape' must be set.
897 "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
898 "column": "A String", # Name of the numeric column used to scale a shape.
899 "valueRange": { # Range of values used for scaling shapes. The min/max values will be drawn as shapes with the min/max size. # The range of values to display across the size range.
900 "max": 3.14, # Maximum value.
901 "min": 3.14, # Minimum value.
902 },
903 "sizeRange": { # Scaled shape size range in pixels. For circles, size corresponds to diameter. # The range of shape sizes, in pixels. For circles, the size corresponds to the diameter.
904 "max": 3.14, # Maximum size, in pixels.
905 "min": 3.14, # Minimum size, in pixels.
906 },
907 "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
908 },
Craig Citro065b5302014-08-14 00:47:23 -0700909 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700910 "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
911 "shape": "A String", # Name of the shape.
912 "border": { # Border in line style. Both color and width are required. # Border color/width of the shape. If not specified the shape won't have a border.
913 "color": "A String", # Color of the border.
914 "opacity": 3.14, # Opacity of the border.
915 "width": 3.14, # Width of the border, in pixels.
916 },
917 "fill": { # Basic color used in styling. # The fill color of the shape. If not specified the shape will be transparent (although the borders may not be).
918 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
919 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
920 },
921 },
Craig Citro065b5302014-08-14 00:47:23 -0700922 "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'.
923 },
924 },
925 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
926 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
927 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
928 "color": "A String", # Color of the border.
929 "opacity": 3.14, # Opacity of the border.
930 "width": 3.14, # Width of the border, in pixels.
931 },
Craig Citroe633be12015-03-02 13:40:36 -0800932 "label": { # Text label style. # Label style for the polygon.
933 "opacity": 3.14, # Opacity of the text.
934 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
935 "outline": { # Basic color used in styling. # Outline color of the text.
936 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
937 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
938 },
939 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
940 "color": "A String", # Color of the text. If not provided, default to black.
941 "column": "A String", # The column value of the feature to be displayed.
942 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
943 },
Craig Citro065b5302014-08-14 00:47:23 -0700944 "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.
945 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
946 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
947 },
948 },
949 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
950 "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.
951 3.14,
952 ],
953 "stroke": { # Stroke of the line.
954 "color": "A String", # Color of the line.
955 "opacity": 3.14, # Opacity of the line.
956 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
957 },
958 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
959 "color": "A String", # Color of the border.
960 "opacity": 3.14, # Opacity of the border.
961 "width": 3.14, # Width of the border, in pixels.
962 },
963 "label": { # Text label style. # Label style for the line.
964 "opacity": 3.14, # Opacity of the text.
965 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
966 "outline": { # Basic color used in styling. # Outline color of the text.
967 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
968 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
969 },
970 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
971 "color": "A String", # Color of the text. If not provided, default to black.
972 "column": "A String", # The column value of the feature to be displayed.
973 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
974 },
975 },
976 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
977 "max": 42, # Maximum zoom level.
978 "min": 42, # Minimum zoom level.
979 },
980 "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.
981 { # Conditions for filtering features.
982 "column": "A String", # The column name to filter on.
983 "operator": "A String", # Operation used to evaluate the filter.
984 "value": "", # Value to be evaluated against attribute.
985 },
986 ],
987 },
988 ],
989 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700990 "datasources": [ # An array of datasources used to build this layer. If layerType is "image", or layerType is not specified and datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If layerType is "vector", or layerType is not specified and datasourceType is "table" then each element in this array is a reference to a Vector Table.
Craig Citro065b5302014-08-14 00:47:23 -0700991 {
992 "id": "A String", # The ID of a datasource.
993 },
994 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700995 "processingStatus": "A String", # The processing status of this layer.
996 "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.
997 "datasourceType": "A String", # Deprecated: The type of the datasources used to build this Layer. Note: This has been replaced by layerType, but is still available for now to maintain backward compatibility.
998 "tags": [ # Tags of this Layer.
999 "A String",
1000 ],
1001 "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).
1002 "publishingStatus": "A String", # The publishing status of this layer.
1003 "name": "A String", # The name of this Layer, supplied by the author.
1004 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
1005 "etag": "A String", # The ETag, used to refer to the current version of the asset.
1006 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
1007 "bbox": [ # A rectangular bounding box which contains all of the data in this Layer. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
1008 3.14,
1009 ],
1010 "layerType": "A String", # The type of the datasources used to build this Layer. This should be used instead of datasourceType. At least one of layerType and datasourceType and must be specified, but layerType takes precedence.
1011 "projectId": "A String", # The ID of the project that this Layer is in.
1012 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
1013 "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).
1014 "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.
1015 "id": "A String", # A globally unique ID, used to refer to this Layer.
1016 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -07001017}
1018
1019</pre>
1020</div>
1021
1022<div class="method">
John Asmuth614db982014-04-24 15:46:26 -04001023 <code class="details" id="process">process(id)</code>
1024 <pre>Process a layer asset.
1025
1026Args:
1027 id: string, The ID of the layer. (required)
1028
1029Returns:
1030 An object of the form:
1031
1032 { # The response returned by a call to any asset's Process method.
1033 }</pre>
1034</div>
1035
1036<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001037 <code class="details" id="publish">publish(id, force=None)</code>
John Asmuth614db982014-04-24 15:46:26 -04001038 <pre>Publish a layer asset.
1039
1040Args:
1041 id: string, The ID of the layer. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -07001042 force: boolean, If set to true, the API will allow publication of the layer even if it's out of date. If not true, you'll need to reprocess any out-of-date layer before publishing.
John Asmuth614db982014-04-24 15:46:26 -04001043
1044Returns:
1045 An object of the form:
1046
1047 { # The response returned by a call to any asset's Publish method.
1048 }</pre>
1049</div>
1050
Craig Citro065b5302014-08-14 00:47:23 -07001051<div class="method">
1052 <code class="details" id="unpublish">unpublish(id)</code>
1053 <pre>Unpublish a layer asset.
1054
1055Args:
1056 id: string, The ID of the layer. (required)
1057
1058Returns:
1059 An object of the form:
1060
1061 { # The response returned by a call to any asset's Publish method.
1062 }</pre>
1063</div>
1064
John Asmuth614db982014-04-24 15:46:26 -04001065</body></html>