Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 15744b1488c8e3a52899531aa0d04b93d572f683 / . / docs / dyn / mapsengine_v1.layers.html
blob: a41fe233747d054239d93d9a5ba092d08d71bb40 [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 Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]83 <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 -0700[diff] [blame]88 <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 -0400[diff] [blame]91 <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 -0700[diff] [blame]94 <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 -0400[diff] [blame]97 <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 -0700[diff] [blame]100 <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 -0400[diff] [blame]104<p class="firstline">Return all layers readable by the current user.</p>
105<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]106 <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 -0400[diff] [blame]112 <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 -0700[diff] [blame]115 <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 -0400[diff] [blame]118 <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 -0700[diff] [blame]121 <code><a href="#publish">publish(id, force=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]122<p class="firstline">Publish a layer asset.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]123<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 -0400[diff] [blame]126<h3>Method Details</h3>
127<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]128 <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 -0400[diff] [blame]142 <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 -0700[diff] [blame]150 "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 -0700[diff] [blame]151 "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 -0700[diff] [blame]170 "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 -0700[diff] [blame]183 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]184 "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 -0700[diff] [blame]196 "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 },
206 "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.
207 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
208 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
209 },
210 },
211 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
212 "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.
213 3.14,
214 ],
215 "stroke": { # Stroke of the line.
216 "color": "A String", # Color of the line.
217 "opacity": 3.14, # Opacity of the line.
218 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
219 },
220 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
221 "color": "A String", # Color of the border.
222 "opacity": 3.14, # Opacity of the border.
223 "width": 3.14, # Width of the border, in pixels.
224 },
225 "label": { # Text label style. # Label style for the line.
226 "opacity": 3.14, # Opacity of the text.
227 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
228 "outline": { # Basic color used in styling. # Outline color of the text.
229 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
230 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
231 },
232 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
233 "color": "A String", # Color of the text. If not provided, default to black.
234 "column": "A String", # The column value of the feature to be displayed.
235 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
236 },
237 },
238 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
239 "max": 42, # Maximum zoom level.
240 "min": 42, # Minimum zoom level.
241 },
242 "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.
243 { # Conditions for filtering features.
244 "column": "A String", # The column name to filter on.
245 "operator": "A String", # Operation used to evaluate the filter.
246 "value": "", # Value to be evaluated against attribute.
247 },
248 ],
249 },
250 ],
251 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]252 "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 -0700[diff] [blame]253 {
254 "id": "A String", # The ID of a datasource.
255 },
256 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]257 "processingStatus": "A String", # The processing status of this layer.
258 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. Instead, each asset has its own list of permissions. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. Note: This is an input field only. It is not returned in response to a list or get request.
259 "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.
260 "tags": [ # Tags of this Layer.
261 "A String",
262 ],
263 "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).
264 "publishingStatus": "A String", # The publishing status of this layer.
265 "name": "A String", # The name of this Layer, supplied by the author.
266 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
267 "etag": "A String", # The ETag, used to refer to the current version of the asset.
268 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
269 "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.
270 3.14,
271 ],
272 "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.
273 "projectId": "A String", # The ID of the project that this Layer is in.
274 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
275 "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).
276 "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.
277 "id": "A String", # A globally unique ID, used to refer to this Layer.
278 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]279}
280
281 process: boolean, Whether to queue the created layer for processing.
282
283Returns:
284 An object of the form:
285
286 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]287 "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 -0400[diff] [blame]288 "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.
289 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
290 },
291 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]292 "displayRules": [
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]293 { # A display rule of the vector style.
294 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
295 "label": { # Text label style. # Label style for the point.
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 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]307 "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.
308 "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
309 "column": "A String", # Name of the numeric column used to scale a shape.
310 "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.
311 "max": 3.14, # Maximum value.
312 "min": 3.14, # Minimum value.
313 },
314 "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.
315 "max": 3.14, # Maximum size, in pixels.
316 "min": 3.14, # Minimum size, in pixels.
317 },
318 "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
319 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]320 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]321 "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
322 "shape": "A String", # Name of the shape.
323 "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.
324 "color": "A String", # Color of the border.
325 "opacity": 3.14, # Opacity of the border.
326 "width": 3.14, # Width of the border, in pixels.
327 },
328 "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).
329 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
330 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
331 },
332 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]333 "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'.
334 },
335 },
336 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
337 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
338 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
339 "color": "A String", # Color of the border.
340 "opacity": 3.14, # Opacity of the border.
341 "width": 3.14, # Width of the border, in pixels.
342 },
343 "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.
344 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
345 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
346 },
347 },
348 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
349 "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.
350 3.14,
351 ],
352 "stroke": { # Stroke of the line.
353 "color": "A String", # Color of the line.
354 "opacity": 3.14, # Opacity of the line.
355 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
356 },
357 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
358 "color": "A String", # Color of the border.
359 "opacity": 3.14, # Opacity of the border.
360 "width": 3.14, # Width of the border, in pixels.
361 },
362 "label": { # Text label style. # Label style for the line.
363 "opacity": 3.14, # Opacity of the text.
364 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
365 "outline": { # Basic color used in styling. # Outline color of the text.
366 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
367 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
368 },
369 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
370 "color": "A String", # Color of the text. If not provided, default to black.
371 "column": "A String", # The column value of the feature to be displayed.
372 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
373 },
374 },
375 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
376 "max": 42, # Maximum zoom level.
377 "min": 42, # Minimum zoom level.
378 },
379 "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.
380 { # Conditions for filtering features.
381 "column": "A String", # The column name to filter on.
382 "operator": "A String", # Operation used to evaluate the filter.
383 "value": "", # Value to be evaluated against attribute.
384 },
385 ],
386 },
387 ],
388 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]389 "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 -0400[diff] [blame]390 {
391 "id": "A String", # The ID of a datasource.
392 },
393 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]394 "processingStatus": "A String", # The processing status of this layer.
395 "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.
396 "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.
397 "tags": [ # Tags of this Layer.
398 "A String",
399 ],
400 "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).
401 "publishingStatus": "A String", # The publishing status of this layer.
402 "name": "A String", # The name of this Layer, supplied by the author.
403 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
404 "etag": "A String", # The ETag, used to refer to the current version of the asset.
405 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
406 "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.
407 3.14,
408 ],
409 "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.
410 "projectId": "A String", # The ID of the project that this Layer is in.
411 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
412 "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).
413 "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.
414 "id": "A String", # A globally unique ID, used to refer to this Layer.
415 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]416 }</pre>
417</div>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]418
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]419<div class="method">
420 <code class="details" id="delete">delete(id)</code>
421 <pre>Delete a layer.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]422
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]423Args:
424 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)
425</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]426</div>
427
428<div class="method">
429 <code class="details" id="get">get(id, version=None)</code>
430 <pre>Return metadata for a particular layer.
431
432Args:
433 id: string, The ID of the layer. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]434 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 -0400[diff] [blame]435 Allowed values
436 draft - The draft version.
437 published - The published version.
438
439Returns:
440 An object of the form:
441
442 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]443 "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 -0700[diff] [blame]444 "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.
445 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
446 },
447 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
448 "displayRules": [
449 { # A display rule of the vector style.
450 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
451 "label": { # Text label style. # Label style for the point.
452 "opacity": 3.14, # Opacity of the text.
453 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
454 "outline": { # Basic color used in styling. # Outline color of the text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]455 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
456 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
457 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]458 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
459 "color": "A String", # Color of the text. If not provided, default to black.
460 "column": "A String", # The column value of the feature to be displayed.
461 "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]462 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]463 "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.
464 "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
465 "column": "A String", # Name of the numeric column used to scale a shape.
466 "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.
467 "max": 3.14, # Maximum value.
468 "min": 3.14, # Minimum value.
469 },
470 "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.
471 "max": 3.14, # Maximum size, in pixels.
472 "min": 3.14, # Minimum size, in pixels.
473 },
474 "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
475 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]476 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]477 "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
478 "shape": "A String", # Name of the shape.
479 "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.
480 "color": "A String", # Color of the border.
481 "opacity": 3.14, # Opacity of the border.
482 "width": 3.14, # Width of the border, in pixels.
483 },
484 "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).
485 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
486 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
487 },
488 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]489 "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]490 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]491 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]492 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
493 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
494 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
495 "color": "A String", # Color of the border.
496 "opacity": 3.14, # Opacity of the border.
497 "width": 3.14, # Width of the border, in pixels.
498 },
499 "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.
500 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
501 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
502 },
503 },
504 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
505 "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.
506 3.14,
507 ],
508 "stroke": { # Stroke of the line.
509 "color": "A String", # Color of the line.
510 "opacity": 3.14, # Opacity of the line.
511 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
512 },
513 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
514 "color": "A String", # Color of the border.
515 "opacity": 3.14, # Opacity of the border.
516 "width": 3.14, # Width of the border, in pixels.
517 },
518 "label": { # Text label style. # Label style for the line.
519 "opacity": 3.14, # Opacity of the text.
520 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
521 "outline": { # Basic color used in styling. # Outline color of the text.
522 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
523 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
524 },
525 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
526 "color": "A String", # Color of the text. If not provided, default to black.
527 "column": "A String", # The column value of the feature to be displayed.
528 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
529 },
530 },
531 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
532 "max": 42, # Maximum zoom level.
533 "min": 42, # Minimum zoom level.
534 },
535 "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.
536 { # Conditions for filtering features.
537 "column": "A String", # The column name to filter on.
538 "operator": "A String", # Operation used to evaluate the filter.
539 "value": "", # Value to be evaluated against attribute.
540 },
541 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]542 },
543 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]544 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]545 "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 -0700[diff] [blame]546 {
547 "id": "A String", # The ID of a datasource.
548 },
549 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]550 "processingStatus": "A String", # The processing status of this layer.
551 "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.
552 "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.
553 "tags": [ # Tags of this Layer.
554 "A String",
555 ],
556 "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).
557 "publishingStatus": "A String", # The publishing status of this layer.
558 "name": "A String", # The name of this Layer, supplied by the author.
559 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
560 "etag": "A String", # The ETag, used to refer to the current version of the asset.
561 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
562 "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.
563 3.14,
564 ],
565 "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.
566 "projectId": "A String", # The ID of the project that this Layer is in.
567 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
568 "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).
569 "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.
570 "id": "A String", # A globally unique ID, used to refer to this Layer.
571 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]572 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]573</div>
574
575<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]576 <code class="details" id="getPublished">getPublished(id)</code>
577 <pre>Return the published metadata for a particular layer.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]578
579Args:
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]580 id: string, The ID of the layer. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]581
582Returns:
583 An object of the form:
584
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]585 { # The published version of a layer.
586 "projectId": "A String", # The ID of the project that this Layer is in.
587 "name": "A String", # The name of this Layer, supplied by the author.
588 "description": "A String", # The description of this Layer, supplied by the author.
589 "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.
590 "id": "A String", # A globally unique ID, used to refer to this Layer.
591 }</pre>
592</div>
593
594<div class="method">
595 <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>
596 <pre>Return all layers readable by the current user.
597
598Args:
599 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.
600 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
601 processingStatus: string, A parameter
602 Allowed values
603 complete - The layer has completed processing.
604 failed - The layer has failed processing.
605 notReady - The layer is not ready for processing.
606 processing - The layer is processing.
607 ready - The layer is ready for processing.
608 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.
609 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.
610 role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
611 Allowed values
612 owner - The user can read, write and administer the asset.
613 reader - The user can read the asset.
614 writer - The user can read and write the asset.
615 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.
616 tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
617 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
618 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
619 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.
620 search: string, An unstructured search string used to filter the set of results based on asset metadata.
621 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.
622
623Returns:
624 An object of the form:
625
626 { # 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 -0400[diff] [blame]627 "layers": [ # Resources returned.
628 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]629 "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 -0700[diff] [blame]630 "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.
631 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
632 },
633 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
634 "displayRules": [
635 { # A display rule of the vector style.
636 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
637 "label": { # Text label style. # Label style for the point.
638 "opacity": 3.14, # Opacity of the text.
639 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
640 "outline": { # Basic color used in styling. # Outline color of the text.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]641 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
642 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
643 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]644 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
645 "color": "A String", # Color of the text. If not provided, default to black.
646 "column": "A String", # The column value of the feature to be displayed.
647 "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]648 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]649 "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.
650 "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
651 "column": "A String", # Name of the numeric column used to scale a shape.
652 "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.
653 "max": 3.14, # Maximum value.
654 "min": 3.14, # Minimum value.
655 },
656 "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.
657 "max": 3.14, # Maximum size, in pixels.
658 "min": 3.14, # Minimum size, in pixels.
659 },
660 "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
661 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]662 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]663 "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
664 "shape": "A String", # Name of the shape.
665 "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.
666 "color": "A String", # Color of the border.
667 "opacity": 3.14, # Opacity of the border.
668 "width": 3.14, # Width of the border, in pixels.
669 },
670 "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).
671 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
672 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
673 },
674 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]675 "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]676 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]677 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]678 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
679 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
680 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
681 "color": "A String", # Color of the border.
682 "opacity": 3.14, # Opacity of the border.
683 "width": 3.14, # Width of the border, in pixels.
684 },
685 "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.
686 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
687 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
688 },
689 },
690 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
691 "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.
692 3.14,
693 ],
694 "stroke": { # Stroke of the line.
695 "color": "A String", # Color of the line.
696 "opacity": 3.14, # Opacity of the line.
697 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
698 },
699 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
700 "color": "A String", # Color of the border.
701 "opacity": 3.14, # Opacity of the border.
702 "width": 3.14, # Width of the border, in pixels.
703 },
704 "label": { # Text label style. # Label style for the line.
705 "opacity": 3.14, # Opacity of the text.
706 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
707 "outline": { # Basic color used in styling. # Outline color of the text.
708 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
709 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
710 },
711 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
712 "color": "A String", # Color of the text. If not provided, default to black.
713 "column": "A String", # The column value of the feature to be displayed.
714 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
715 },
716 },
717 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
718 "max": 42, # Maximum zoom level.
719 "min": 42, # Minimum zoom level.
720 },
721 "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.
722 { # Conditions for filtering features.
723 "column": "A String", # The column name to filter on.
724 "operator": "A String", # Operation used to evaluate the filter.
725 "value": "", # Value to be evaluated against attribute.
726 },
727 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]728 },
729 ],
730 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]731 "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 -0700[diff] [blame]732 {
733 "id": "A String", # The ID of a datasource.
734 },
735 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]736 "processingStatus": "A String", # The processing status of this layer.
737 "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.
738 "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.
739 "tags": [ # Tags of this Layer.
740 "A String",
741 ],
742 "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).
743 "publishingStatus": "A String", # The publishing status of this layer.
744 "name": "A String", # The name of this Layer, supplied by the author.
745 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
746 "etag": "A String", # The ETag, used to refer to the current version of the asset.
747 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
748 "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.
749 3.14,
750 ],
751 "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.
752 "projectId": "A String", # The ID of the project that this Layer is in.
753 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
754 "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).
755 "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.
756 "id": "A String", # A globally unique ID, used to refer to this Layer.
757 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]758 },
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]759 ],
760 "nextPageToken": "A String", # Next page token.
761 }</pre>
762</div>
763
764<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]765 <code class="details" id="listPublished">listPublished(pageToken=None, maxResults=None, projectId=None)</code>
766 <pre>Return all published layers readable by the current user.
767
768Args:
769 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.
770 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
771 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.
772
773Returns:
774 An object of the form:
775
776 { # The response returned by a call to layers.List.published.
777 "layers": [ # Resources returned.
778 { # The published version of a layer.
779 "projectId": "A String", # The ID of the project that this Layer is in.
780 "name": "A String", # The name of this Layer, supplied by the author.
781 "description": "A String", # The description of this Layer, supplied by the author.
782 "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.
783 "id": "A String", # A globally unique ID, used to refer to this Layer.
784 },
785 ],
786 "nextPageToken": "A String", # Next page token.
787 }</pre>
788</div>
789
790<div class="method">
791 <code class="details" id="listPublished_next">listPublished_next(previous_request, previous_response)</code>
792 <pre>Retrieves the next page of results.
793
794Args:
795 previous_request: The request for the previous page. (required)
796 previous_response: The response from the request for the previous page. (required)
797
798Returns:
799 A request object that you can call 'execute()' on to request the next
800 page. Returns None if there are no more items in the collection.
801 </pre>
802</div>
803
804<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]805 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
806 <pre>Retrieves the next page of results.
807
808Args:
809 previous_request: The request for the previous page. (required)
810 previous_response: The response from the request for the previous page. (required)
811
812Returns:
813 A request object that you can call 'execute()' on to request the next
814 page. Returns None if there are no more items in the collection.
815 </pre>
816</div>
817
818<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]819 <code class="details" id="patch">patch(id, body)</code>
820 <pre>Mutate a layer asset.
821
822Args:
823 id: string, The ID of the layer. (required)
824 body: object, The request body. (required)
825 The object takes the form of:
826
827{ # A Layer combines multiple datasources, with styling information, for presentation on a map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]828 "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 -0700[diff] [blame]829 "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.
830 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
831 },
832 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
833 "displayRules": [
834 { # A display rule of the vector style.
835 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
836 "label": { # Text label style. # Label style for the point.
837 "opacity": 3.14, # Opacity of the text.
838 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
839 "outline": { # Basic color used in styling. # Outline color of the text.
840 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
841 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
842 },
843 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
844 "color": "A String", # Color of the text. If not provided, default to black.
845 "column": "A String", # The column value of the feature to be displayed.
846 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
847 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]848 "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.
849 "scalingFunction": { # Parameters for scaling scaled shapes. # The function used to scale shapes. Required when a scaledShape is specified.
850 "column": "A String", # Name of the numeric column used to scale a shape.
851 "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.
852 "max": 3.14, # Maximum value.
853 "min": 3.14, # Minimum value.
854 },
855 "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.
856 "max": 3.14, # Maximum size, in pixels.
857 "min": 3.14, # Minimum size, in pixels.
858 },
859 "scalingType": "A String", # The type of scaling function to use. Defaults to SQRT. Currently only linear and square root scaling are supported.
860 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]861 "id": "A String", # Custom icon id.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]862 "scaledShape": { # Parameters for styling points as scaled shapes. # A scalable shape.
863 "shape": "A String", # Name of the shape.
864 "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.
865 "color": "A String", # Color of the border.
866 "opacity": 3.14, # Opacity of the border.
867 "width": 3.14, # Width of the border, in pixels.
868 },
869 "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).
870 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
871 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
872 },
873 },
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]874 "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'.
875 },
876 },
877 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
878 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
879 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
880 "color": "A String", # Color of the border.
881 "opacity": 3.14, # Opacity of the border.
882 "width": 3.14, # Width of the border, in pixels.
883 },
884 "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.
885 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
886 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
887 },
888 },
889 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
890 "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.
891 3.14,
892 ],
893 "stroke": { # Stroke of the line.
894 "color": "A String", # Color of the line.
895 "opacity": 3.14, # Opacity of the line.
896 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
897 },
898 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
899 "color": "A String", # Color of the border.
900 "opacity": 3.14, # Opacity of the border.
901 "width": 3.14, # Width of the border, in pixels.
902 },
903 "label": { # Text label style. # Label style for the line.
904 "opacity": 3.14, # Opacity of the text.
905 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
906 "outline": { # Basic color used in styling. # Outline color of the text.
907 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
908 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
909 },
910 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
911 "color": "A String", # Color of the text. If not provided, default to black.
912 "column": "A String", # The column value of the feature to be displayed.
913 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
914 },
915 },
916 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
917 "max": 42, # Maximum zoom level.
918 "min": 42, # Minimum zoom level.
919 },
920 "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.
921 { # Conditions for filtering features.
922 "column": "A String", # The column name to filter on.
923 "operator": "A String", # Operation used to evaluate the filter.
924 "value": "", # Value to be evaluated against attribute.
925 },
926 ],
927 },
928 ],
929 },
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]930 "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 -0700[diff] [blame]931 {
932 "id": "A String", # The ID of a datasource.
933 },
934 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]935 "processingStatus": "A String", # The processing status of this layer.
936 "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.
937 "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.
938 "tags": [ # Tags of this Layer.
939 "A String",
940 ],
941 "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).
942 "publishingStatus": "A String", # The publishing status of this layer.
943 "name": "A String", # The name of this Layer, supplied by the author.
944 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
945 "etag": "A String", # The ETag, used to refer to the current version of the asset.
946 "creatorEmail": "A String", # The email address of the creator of this layer. This is only returned on GET requests and not LIST requests.
947 "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.
948 3.14,
949 ],
950 "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.
951 "projectId": "A String", # The ID of the project that this Layer is in.
952 "lastModifierEmail": "A String", # The email address of the last modifier of this layer. This is only returned on GET requests and not LIST requests.
953 "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).
954 "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.
955 "id": "A String", # A globally unique ID, used to refer to this Layer.
956 "description": "A String", # The description of this Layer, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]957}
958
959</pre>
960</div>
961
962<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]963 <code class="details" id="process">process(id)</code>
964 <pre>Process a layer asset.
965
966Args:
967 id: string, The ID of the layer. (required)
968
969Returns:
970 An object of the form:
971
972 { # The response returned by a call to any asset's Process method.
973 }</pre>
974</div>
975
976<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]977 <code class="details" id="publish">publish(id, force=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]978 <pre>Publish a layer asset.
979
980Args:
981 id: string, The ID of the layer. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]982 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 -0400[diff] [blame]983
984Returns:
985 An object of the form:
986
987 { # The response returned by a call to any asset's Publish method.
988 }</pre>
989</div>
990
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]991<div class="method">
992 <code class="details" id="unpublish">unpublish(id)</code>
993 <pre>Unpublish a layer asset.
994
995Args:
996 id: string, The ID of the layer. (required)
997
998Returns:
999 An object of the form:
1000
1001 { # The response returned by a call to any asset's Publish method.
1002 }</pre>
1003</div>
1004
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1005</body></html>