Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 63caac01ea7b9fbd8ae70bcbb4c6ecbec833ad3d / . / docs / dyn / mapsengine_v1.maps.html
blob: e972972a62fcafcae2e3bfe2212b233206dd8c7e [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.maps.html">maps</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]78 <code><a href="#create">create(body)</a></code></p>
79<p class="firstline">Create a map asset.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(id)</a></code></p>
82<p class="firstline">Delete a map.</p>
83<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]84 <code><a href="#get">get(id, version=None)</a></code></p>
85<p class="firstline">Return metadata for a particular map.</p>
86<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]87 <code><a href="#list">list(modifiedAfter=None, createdAfter=None, tags=None, projectId=None, maxResults=None, pageToken=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Return all maps readable by the current user.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#patch">patch(id, body)</a></code></p>
94<p class="firstline">Mutate a map asset.</p>
95<p class="toc_element">
96 <code><a href="#publish">publish(id)</a></code></p>
97<p class="firstline">Publish a map asset.</p>
98<p class="toc_element">
99 <code><a href="#unpublish">unpublish(id)</a></code></p>
100<p class="firstline">Unpublish a map asset.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]103 <code class="details" id="create">create(body)</code>
104 <pre>Create a map asset.
105
106Args:
107 body: object, The request body. (required)
108 The object takes the form of:
109
110{ # A Map is a collection of Layers, optionally contained within folders.
111 "description": "A String", # The description of this Map, supplied by the author.
112 "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
113 3.14,
114 ],
115 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
116 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
117 "projectId": "A String", # The ID of the project that this Map is in.
118 "tags": [ # Tags of this Map.
119 "A String",
120 ],
121 "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
122 "publishingStatus": "A String", # The publishing status of this map.
123 "etag": "A String", # The ETag, used to refer to the current version of the asset.
124 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The numbers represent latitude and longitude in decimal degrees.
125 3.14,
126 ],
127 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
128 "published",
129 ],
130 "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
131 "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
132 "id": "A String", # A globally unique ID, used to refer to this Map.
133 "contents": [ # The contents of this Map.
134 {
135 },
136 ],
137 "name": "A String", # The name of this Map, supplied by the author.
138}
139
140
141Returns:
142 An object of the form:
143
144 { # A Map is a collection of Layers, optionally contained within folders.
145 "description": "A String", # The description of this Map, supplied by the author.
146 "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
147 3.14,
148 ],
149 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
150 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
151 "projectId": "A String", # The ID of the project that this Map is in.
152 "tags": [ # Tags of this Map.
153 "A String",
154 ],
155 "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
156 "publishingStatus": "A String", # The publishing status of this map.
157 "etag": "A String", # The ETag, used to refer to the current version of the asset.
158 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The numbers represent latitude and longitude in decimal degrees.
159 3.14,
160 ],
161 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
162 "published",
163 ],
164 "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
165 "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
166 "id": "A String", # A globally unique ID, used to refer to this Map.
167 "contents": [ # The contents of this Map.
168 {
169 },
170 ],
171 "name": "A String", # The name of this Map, supplied by the author.
172 }</pre>
173</div>
174
175<div class="method">
176 <code class="details" id="delete">delete(id)</code>
177 <pre>Delete a map.
178
179Args:
180 id: string, The ID of the map. Only the map creator or project owner are permitted to delete. If the map is published the request will fail. Unpublish the map prior to deleting. (required)
181</pre>
182</div>
183
184<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]185 <code class="details" id="get">get(id, version=None)</code>
186 <pre>Return metadata for a particular map.
187
188Args:
189 id: string, The ID of the map. (required)
190 version: string, A parameter
191 Allowed values
192 draft - The draft version.
193 published - The published version.
194
195Returns:
196 An object of the form:
197
198 { # A Map is a collection of Layers, optionally contained within folders.
199 "description": "A String", # The description of this Map, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]200 "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]201 3.14,
202 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]203 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
204 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
205 "projectId": "A String", # The ID of the project that this Map is in.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]206 "tags": [ # Tags of this Map.
207 "A String",
208 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]209 "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]210 "publishingStatus": "A String", # The publishing status of this map.
211 "etag": "A String", # The ETag, used to refer to the current version of the asset.
212 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]213 3.14,
214 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]215 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
216 "published",
217 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]218 "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]219 "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]220 "id": "A String", # A globally unique ID, used to refer to this Map.
221 "contents": [ # The contents of this Map.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]222 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]223 },
224 ],
225 "name": "A String", # The name of this Map, supplied by the author.
226 }</pre>
227</div>
228
229<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]230 <code class="details" id="list">list(modifiedAfter=None, createdAfter=None, tags=None, projectId=None, maxResults=None, pageToken=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]231 <pre>Return all maps readable by the current user.
232
233Args:
234 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.
235 createdAfter: string, An RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z). Returned assets will have been created at or after this time.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]236 tags: string, A comma separated list of tags. Returned assets will contain all the tags from the list.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]237 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.
238 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]239 pageToken: string, The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]240 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.
241 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
242 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
243 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.
244
245Returns:
246 An object of the form:
247
248 { # The response returned by a call to maps.List.
249 "nextPageToken": "A String", # Next page token.
250 "maps": [ # Resources returned.
251 { # A Map is a collection of Layers, optionally contained within folders.
252 "description": "A String", # The description of this Map, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]253 "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]254 3.14,
255 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]256 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
257 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
258 "projectId": "A String", # The ID of the project that this Map is in.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]259 "tags": [ # Tags of this Map.
260 "A String",
261 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]262 "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]263 "publishingStatus": "A String", # The publishing status of this map.
264 "etag": "A String", # The ETag, used to refer to the current version of the asset.
265 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]266 3.14,
267 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]268 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
269 "published",
270 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]271 "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]272 "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]273 "id": "A String", # A globally unique ID, used to refer to this Map.
274 "contents": [ # The contents of this Map.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]275 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]276 },
277 ],
278 "name": "A String", # The name of this Map, supplied by the author.
279 },
280 ],
281 }</pre>
282</div>
283
284<div class="method">
285 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
286 <pre>Retrieves the next page of results.
287
288Args:
289 previous_request: The request for the previous page. (required)
290 previous_response: The response from the request for the previous page. (required)
291
292Returns:
293 A request object that you can call 'execute()' on to request the next
294 page. Returns None if there are no more items in the collection.
295 </pre>
296</div>
297
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]298<div class="method">
299 <code class="details" id="patch">patch(id, body)</code>
300 <pre>Mutate a map asset.
301
302Args:
303 id: string, The ID of the map. (required)
304 body: object, The request body. (required)
305 The object takes the form of:
306
307{ # A Map is a collection of Layers, optionally contained within folders.
308 "description": "A String", # The description of this Map, supplied by the author.
309 "defaultViewport": [ # A rectangular geographic bounds. # An array of four numbers (west, south, east, north) which defines the rectangular bounding box of the default viewport. The numbers represent latitude and longitude in decimal degrees.
310 3.14,
311 ],
312 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
313 "draftAccessList": "A String", # Deprecated: The name of an access list of the Map Editor type. The user on whose behalf the request is being sent must be an editor on that access list. Note: Google Maps Engine no longer uses access lists. For backward compatibility, the API still accepts access lists for projects that are already using access lists. If you created a GME account/project after July 14th, 2014, you will not be able to send API requests that include access lists. The API does not yet support the new permissions model. When you create a map via the API without specifying permissions, the account that created the map is the owner and has effective administrator access. Users can then use the Maps Engine user interface to adjust the permissions. This is a temporary workaround until the API supports the new permissions model. Read Add new users and groups in the Google Maps Engine help center for more information.
314 "projectId": "A String", # The ID of the project that this Map is in.
315 "tags": [ # Tags of this Map.
316 "A String",
317 ],
318 "creationTime": "A String", # The creation time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
319 "publishingStatus": "A String", # The publishing status of this map.
320 "etag": "A String", # The ETag, used to refer to the current version of the asset.
321 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The numbers represent latitude and longitude in decimal degrees.
322 3.14,
323 ],
324 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
325 "published",
326 ],
327 "lastModifiedTime": "A String", # The last modified time of this map. The value is an RFC 3339 formatted date-time value (e.g. 1970-01-01T00:00:00Z).
328 "publishedAccessList": "A String", # Deprecated: The access list to whom view permissions are granted. The value must be the name of a Maps Engine access list of the Map Viewer type, and the user must be a viewer on that list. Read Share data, layers, and maps in the Google Maps Engine help center for more information.
329 "id": "A String", # A globally unique ID, used to refer to this Map.
330 "contents": [ # The contents of this Map.
331 {
332 },
333 ],
334 "name": "A String", # The name of this Map, supplied by the author.
335}
336
337</pre>
338</div>
339
340<div class="method">
341 <code class="details" id="publish">publish(id)</code>
342 <pre>Publish a map asset.
343
344Args:
345 id: string, The ID of the map. (required)
346
347Returns:
348 An object of the form:
349
350 { # The response returned by a call to any asset's Publish method.
351 }</pre>
352</div>
353
354<div class="method">
355 <code class="details" id="unpublish">unpublish(id)</code>
356 <pre>Unpublish a map asset.
357
358Args:
359 id: string, The ID of the map. (required)
360
361Returns:
362 An object of the form:
363
364 { # The response returned by a call to any asset's Publish method.
365 }</pre>
366</div>
367
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]368</body></html>