Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 614db98bf45b9da1f29c35a9d942536111e99d41 / . / docs / dyn / mapsengine_v1.layers.html
blob: 15f8b266ec2f75168b73263dfaa7c16109ebc4a0 [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">
83 <code><a href="#create">create(body, process=None)</a></code></p>
84<p class="firstline">Create a layer asset.</p>
85<p class="toc_element">
86 <code><a href="#get">get(id, version=None)</a></code></p>
87<p class="firstline">Return metadata for a particular layer.</p>
88<p class="toc_element">
89 <code><a href="#list">list(modifiedAfter=None, createdAfter=None, pageToken=None, projectId=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</a></code></p>
90<p class="firstline">Return all layers readable by the current user.</p>
91<p class="toc_element">
92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<p class="toc_element">
95 <code><a href="#process">process(id)</a></code></p>
96<p class="firstline">Process a layer asset.</p>
97<p class="toc_element">
98 <code><a href="#publish">publish(id)</a></code></p>
99<p class="firstline">Publish a layer asset.</p>
100<h3>Method Details</h3>
101<div class="method">
102 <code class="details" id="create">create(body, process=None)</code>
103 <pre>Create a layer asset.
104
105Args:
106 body: object, The request body. (required)
107 The object takes the form of:
108
109{ # A Layer combines multiple datasources, with styling information, for presentation on a map.
110 "style": { # A vector style contains styling information for vector layer. # The Styling information for a vector layer.
111 "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.
112 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
113 },
114 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
115 "displayRules": [ # Display rules of the vector style. The first matched rule will apply to the features. If no display rule is provided, a default display rule will be generated according to Geometry type.
116 { # A display rule of the vector style.
117 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
118 "label": { # Text label style. # Label style for the point.
119 "opacity": 3.14, # Opacity of the text.
120 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
121 "outline": { # Basic color used in styling. # Outline color of the text.
122 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
123 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
124 },
125 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
126 "color": "A String", # Color of the text. If not provided, default to black.
127 "column": "A String", # The column value of the feature to be displayed.
128 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
129 },
130 "icon": { # Style for icon, this is part of point style. # Icon for the point; exactly one field in 'icon' must be set.
131 "id": "A String", # Custom icon id.
132 "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'.
133 },
134 },
135 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
136 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
137 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
138 "color": "A String", # Color of the border.
139 "opacity": 3.14, # Opacity of the border.
140 "width": 3.14, # Width of the border, in pixels.
141 },
142 "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.
143 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
144 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
145 },
146 },
147 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
148 "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.
149 3.14,
150 ],
151 "stroke": { # Stroke of the line.
152 "color": "A String", # Color of the line.
153 "opacity": 3.14, # Opacity of the line.
154 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
155 },
156 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
157 "color": "A String", # Color of the border.
158 "opacity": 3.14, # Opacity of the border.
159 "width": 3.14, # Width of the border, in pixels.
160 },
161 "label": { # Text label style. # Label style for the line.
162 "opacity": 3.14, # Opacity of the text.
163 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
164 "outline": { # Basic color used in styling. # Outline color of the text.
165 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
166 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
167 },
168 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
169 "color": "A String", # Color of the text. If not provided, default to black.
170 "column": "A String", # The column value of the feature to be displayed.
171 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
172 },
173 },
174 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
175 "max": 42, # Maximum zoom level.
176 "min": 42, # Minimum zoom level.
177 },
178 "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.
179 { # Conditions for filtering features.
180 "column": "A String", # The column name to filter on.
181 "operator": "A String", # Operation used to evaluate the filter.
182 "value": "", # Value to be evaluated against attribute.
183 },
184 ],
185 },
186 ],
187 },
188 "description": "A String", # The description of this Layer, supplied by the author.
189 "processingStatus": "A String", # The processing status of this layer.
190 "draftAccessList": "A String", # 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. Read About access lists in the Google Maps Engine help center for more information.
191 "datasourceType": "A String", # The type of the datasources used to build this Layer. One of either "table" or "image".
192 "tags": [ # Tags of this Layer.
193 "A String",
194 ],
195 "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).
196 "name": "A String", # The name of this Layer, supplied by the author.
197 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Layer. The numbers represent latitudes and longitudes in decimal degrees.
198 3.14,
199 ],
200 "projectId": "A String", # The ID of the project that this Layer is in.
201 "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).
202 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
203 "id": "A String", # A globally unique ID, used to refer to this Layer.
204 "datasources": [ # An array of datasources used to build this Layer. If datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If datasourceType is "table" then each element in this array is a reference to a Vector Table.
205 {
206 "id": "A String", # The ID of a datasource.
207 },
208 ],
209 }
210
211 process: boolean, Whether to queue the created layer for processing.
212
213Returns:
214 An object of the form:
215
216 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
217 "style": { # A vector style contains styling information for vector layer. # The Styling information for a vector layer.
218 "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.
219 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
220 },
221 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
222 "displayRules": [ # Display rules of the vector style. The first matched rule will apply to the features. If no display rule is provided, a default display rule will be generated according to Geometry type.
223 { # A display rule of the vector style.
224 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
225 "label": { # Text label style. # Label style for the point.
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 "icon": { # Style for icon, this is part of point style. # Icon for the point; exactly one field in 'icon' must be set.
238 "id": "A String", # Custom icon id.
239 "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'.
240 },
241 },
242 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
243 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
244 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
245 "color": "A String", # Color of the border.
246 "opacity": 3.14, # Opacity of the border.
247 "width": 3.14, # Width of the border, in pixels.
248 },
249 "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.
250 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
251 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
252 },
253 },
254 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
255 "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.
256 3.14,
257 ],
258 "stroke": { # Stroke of the line.
259 "color": "A String", # Color of the line.
260 "opacity": 3.14, # Opacity of the line.
261 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
262 },
263 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
264 "color": "A String", # Color of the border.
265 "opacity": 3.14, # Opacity of the border.
266 "width": 3.14, # Width of the border, in pixels.
267 },
268 "label": { # Text label style. # Label style for the line.
269 "opacity": 3.14, # Opacity of the text.
270 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
271 "outline": { # Basic color used in styling. # Outline color of the text.
272 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
273 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
274 },
275 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
276 "color": "A String", # Color of the text. If not provided, default to black.
277 "column": "A String", # The column value of the feature to be displayed.
278 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
279 },
280 },
281 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
282 "max": 42, # Maximum zoom level.
283 "min": 42, # Minimum zoom level.
284 },
285 "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.
286 { # Conditions for filtering features.
287 "column": "A String", # The column name to filter on.
288 "operator": "A String", # Operation used to evaluate the filter.
289 "value": "", # Value to be evaluated against attribute.
290 },
291 ],
292 },
293 ],
294 },
295 "description": "A String", # The description of this Layer, supplied by the author.
296 "processingStatus": "A String", # The processing status of this layer.
297 "draftAccessList": "A String", # 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. Read About access lists in the Google Maps Engine help center for more information.
298 "datasourceType": "A String", # The type of the datasources used to build this Layer. One of either "table" or "image".
299 "tags": [ # Tags of this Layer.
300 "A String",
301 ],
302 "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).
303 "name": "A String", # The name of this Layer, supplied by the author.
304 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Layer. The numbers represent latitudes and longitudes in decimal degrees.
305 3.14,
306 ],
307 "projectId": "A String", # The ID of the project that this Layer is in.
308 "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).
309 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
310 "id": "A String", # A globally unique ID, used to refer to this Layer.
311 "datasources": [ # An array of datasources used to build this Layer. If datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If datasourceType is "table" then each element in this array is a reference to a Vector Table.
312 {
313 "id": "A String", # The ID of a datasource.
314 },
315 ],
316 }</pre>
317</div>
318
319<div class="method">
320 <code class="details" id="get">get(id, version=None)</code>
321 <pre>Return metadata for a particular layer.
322
323Args:
324 id: string, The ID of the layer. (required)
325 version: string, A parameter
326 Allowed values
327 draft - The draft version.
328 published - The published version.
329
330Returns:
331 An object of the form:
332
333 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
334 "style": { # A vector style contains styling information for vector layer. # The Styling information for a vector layer.
335 "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.
336 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
337 },
338 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
339 "displayRules": [ # Display rules of the vector style. The first matched rule will apply to the features. If no display rule is provided, a default display rule will be generated according to Geometry type.
340 { # A display rule of the vector style.
341 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
342 "label": { # Text label style. # Label style for the point.
343 "opacity": 3.14, # Opacity of the text.
344 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
345 "outline": { # Basic color used in styling. # Outline color of the text.
346 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
347 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
348 },
349 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
350 "color": "A String", # Color of the text. If not provided, default to black.
351 "column": "A String", # The column value of the feature to be displayed.
352 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
353 },
354 "icon": { # Style for icon, this is part of point style. # Icon for the point; exactly one field in 'icon' must be set.
355 "id": "A String", # Custom icon id.
356 "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'.
357 },
358 },
359 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
360 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
361 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
362 "color": "A String", # Color of the border.
363 "opacity": 3.14, # Opacity of the border.
364 "width": 3.14, # Width of the border, in pixels.
365 },
366 "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.
367 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
368 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
369 },
370 },
371 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
372 "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.
373 3.14,
374 ],
375 "stroke": { # Stroke of the line.
376 "color": "A String", # Color of the line.
377 "opacity": 3.14, # Opacity of the line.
378 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
379 },
380 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
381 "color": "A String", # Color of the border.
382 "opacity": 3.14, # Opacity of the border.
383 "width": 3.14, # Width of the border, in pixels.
384 },
385 "label": { # Text label style. # Label style for the line.
386 "opacity": 3.14, # Opacity of the text.
387 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
388 "outline": { # Basic color used in styling. # Outline color of the text.
389 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
390 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
391 },
392 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
393 "color": "A String", # Color of the text. If not provided, default to black.
394 "column": "A String", # The column value of the feature to be displayed.
395 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
396 },
397 },
398 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
399 "max": 42, # Maximum zoom level.
400 "min": 42, # Minimum zoom level.
401 },
402 "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.
403 { # Conditions for filtering features.
404 "column": "A String", # The column name to filter on.
405 "operator": "A String", # Operation used to evaluate the filter.
406 "value": "", # Value to be evaluated against attribute.
407 },
408 ],
409 },
410 ],
411 },
412 "description": "A String", # The description of this Layer, supplied by the author.
413 "processingStatus": "A String", # The processing status of this layer.
414 "draftAccessList": "A String", # 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. Read About access lists in the Google Maps Engine help center for more information.
415 "datasourceType": "A String", # The type of the datasources used to build this Layer. One of either "table" or "image".
416 "tags": [ # Tags of this Layer.
417 "A String",
418 ],
419 "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).
420 "name": "A String", # The name of this Layer, supplied by the author.
421 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Layer. The numbers represent latitudes and longitudes in decimal degrees.
422 3.14,
423 ],
424 "projectId": "A String", # The ID of the project that this Layer is in.
425 "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).
426 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
427 "id": "A String", # A globally unique ID, used to refer to this Layer.
428 "datasources": [ # An array of datasources used to build this Layer. If datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If datasourceType is "table" then each element in this array is a reference to a Vector Table.
429 {
430 "id": "A String", # The ID of a datasource.
431 },
432 ],
433 }</pre>
434</div>
435
436<div class="method">
437 <code class="details" id="list">list(modifiedAfter=None, createdAfter=None, pageToken=None, projectId=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</code>
438 <pre>Return all layers readable by the current user.
439
440Args:
441 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.
442 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.
443 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.
444 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.
445 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
446 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.
447 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
448 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
449 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.
450
451Returns:
452 An object of the form:
453
454 { # The response returned by a call to layers.List.
455 "layers": [ # Resources returned.
456 { # A Layer combines multiple datasources, with styling information, for presentation on a map.
457 "style": { # A vector style contains styling information for vector layer. # The Styling information for a vector layer.
458 "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.
459 "content": "A String", # HTML template of the info window. If not provided, a default template with all attributes will be generated.
460 },
461 "type": "A String", # The type of the vector style. Currently, only displayRule is supported.
462 "displayRules": [ # Display rules of the vector style. The first matched rule will apply to the features. If no display rule is provided, a default display rule will be generated according to Geometry type.
463 { # A display rule of the vector style.
464 "pointOptions": { # Style for points. # Style applied to points. Required for Point Geometry.
465 "label": { # Text label style. # Label style for the point.
466 "opacity": 3.14, # Opacity of the text.
467 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
468 "outline": { # Basic color used in styling. # Outline color of the text.
469 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
470 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
471 },
472 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
473 "color": "A String", # Color of the text. If not provided, default to black.
474 "column": "A String", # The column value of the feature to be displayed.
475 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
476 },
477 "icon": { # Style for icon, this is part of point style. # Icon for the point; exactly one field in 'icon' must be set.
478 "id": "A String", # Custom icon id.
479 "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'.
480 },
481 },
482 "name": "A String", # Display rule name. Name is not unique and cannot be used for identification purpose.
483 "polygonOptions": { # Style for polygons. # Style applied to polygons. Required for Polygon Geometry.
484 "stroke": { # Border in line style. Both color and width are required. # Border of the polygon. 0 < border.width <= 10.
485 "color": "A String", # Color of the border.
486 "opacity": 3.14, # Opacity of the border.
487 "width": 3.14, # Width of the border, in pixels.
488 },
489 "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.
490 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
491 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
492 },
493 },
494 "lineOptions": { # Style for lines. # Style applied to lines. Required for LineString Geometry.
495 "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.
496 3.14,
497 ],
498 "stroke": { # Stroke of the line.
499 "color": "A String", # Color of the line.
500 "opacity": 3.14, # Opacity of the line.
501 "width": 3.14, # Width of the line, in pixels. 0 <= width <= 10. If width is set to 0, the line will be invisible.
502 },
503 "border": { # Border in line style. Both color and width are required. # Border of the line. 0 < border.width <= 5.
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 "label": { # Text label style. # Label style for the line.
509 "opacity": 3.14, # Opacity of the text.
510 "fontStyle": "A String", # Font style of the label, defaults to 'normal'.
511 "outline": { # Basic color used in styling. # Outline color of the text.
512 "color": "A String", # The CSS style color, can be in format of "red" or "#7733EE".
513 "opacity": 3.14, # Opacity ranges from 0 to 1, inclusive. If not provided, default to 1.
514 },
515 "fontWeight": "A String", # Font weight of the label, defaults to 'normal'.
516 "color": "A String", # Color of the text. If not provided, default to black.
517 "column": "A String", # The column value of the feature to be displayed.
518 "size": 3.14, # Font size of the label, in pixels. 8 <= size <= 15. If not provided, a default size will be provided.
519 },
520 },
521 "zoomLevels": { # Zoom level range. Zoom levels are restricted between 0 and 24, inclusive. # The zoom levels that this display rule apply.
522 "max": 42, # Maximum zoom level.
523 "min": 42, # Minimum zoom level.
524 },
525 "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.
526 { # Conditions for filtering features.
527 "column": "A String", # The column name to filter on.
528 "operator": "A String", # Operation used to evaluate the filter.
529 "value": "", # Value to be evaluated against attribute.
530 },
531 ],
532 },
533 ],
534 },
535 "description": "A String", # The description of this Layer, supplied by the author.
536 "processingStatus": "A String", # The processing status of this layer.
537 "draftAccessList": "A String", # 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. Read About access lists in the Google Maps Engine help center for more information.
538 "datasourceType": "A String", # The type of the datasources used to build this Layer. One of either "table" or "image".
539 "tags": [ # Tags of this Layer.
540 "A String",
541 ],
542 "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).
543 "name": "A String", # The name of this Layer, supplied by the author.
544 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Layer. The numbers represent latitudes and longitudes in decimal degrees.
545 3.14,
546 ],
547 "projectId": "A String", # The ID of the project that this Layer is in.
548 "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).
549 "publishedAccessList": "A String", # The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read About access lists in the Google Maps Engine help center for more information.
550 "id": "A String", # A globally unique ID, used to refer to this Layer.
551 "datasources": [ # An array of datasources used to build this Layer. If datasourceType is "image", then each element in this array is a reference to an Image or RasterCollection. If datasourceType is "table" then each element in this array is a reference to a Vector Table.
552 {
553 "id": "A String", # The ID of a datasource.
554 },
555 ],
556 },
557 ],
558 "nextPageToken": "A String", # Next page token.
559 }</pre>
560</div>
561
562<div class="method">
563 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
564 <pre>Retrieves the next page of results.
565
566Args:
567 previous_request: The request for the previous page. (required)
568 previous_response: The response from the request for the previous page. (required)
569
570Returns:
571 A request object that you can call 'execute()' on to request the next
572 page. Returns None if there are no more items in the collection.
573 </pre>
574</div>
575
576<div class="method">
577 <code class="details" id="process">process(id)</code>
578 <pre>Process a layer asset.
579
580Args:
581 id: string, The ID of the layer. (required)
582
583Returns:
584 An object of the form:
585
586 { # The response returned by a call to any asset's Process method.
587 }</pre>
588</div>
589
590<div class="method">
591 <code class="details" id="publish">publish(id)</code>
592 <pre>Publish a layer asset.
593
594Args:
595 id: string, The ID of the layer. (required)
596
597Returns:
598 An object of the form:
599
600 { # The response returned by a call to any asset's Publish method.
601 }</pre>
602</div>
603
604</body></html>