Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e52ea21dea8ae127d4e4fbfa54a1056c45cf69b5 / . / docs / dyn / mapsengine_v1.maps.html
blob: 264cb07fd335be7d0710389400cc7594c2276c22 [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 Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]78 <code><a href="mapsengine_v1.maps.permissions.html">permissions()</a></code>
79</p>
80<p class="firstline">Returns the permissions Resource.</p>
81
82<p class="toc_element">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]83 <code><a href="#create">create(body)</a></code></p>
84<p class="firstline">Create a map asset.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(id)</a></code></p>
87<p class="firstline">Delete a map.</p>
88<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]89 <code><a href="#get">get(id, version=None)</a></code></p>
90<p class="firstline">Return metadata for a particular map.</p>
91<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]92 <code><a href="#getPublished">getPublished(id)</a></code></p>
93<p class="firstline">Return the published metadata for a particular map.</p>
94<p class="toc_element">
95 <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]96<p class="firstline">Return all maps readable by the current user.</p>
97<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]98 <code><a href="#listPublished">listPublished(pageToken=None, maxResults=None, projectId=None)</a></code></p>
99<p class="firstline">Return all published maps readable by the current user.</p>
100<p class="toc_element">
101 <code><a href="#listPublished_next">listPublished_next(previous_request, previous_response)</a></code></p>
102<p class="firstline">Retrieves the next page of results.</p>
103<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]104 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
105<p class="firstline">Retrieves the next page of results.</p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]106<p class="toc_element">
107 <code><a href="#patch">patch(id, body)</a></code></p>
108<p class="firstline">Mutate a map asset.</p>
109<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]110 <code><a href="#publish">publish(id, force=None)</a></code></p>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]111<p class="firstline">Publish a map asset.</p>
112<p class="toc_element">
113 <code><a href="#unpublish">unpublish(id)</a></code></p>
114<p class="firstline">Unpublish a map asset.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]115<h3>Method Details</h3>
116<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]117 <code class="details" id="create">create(body)</code>
118 <pre>Create a map asset.
119
120Args:
121 body: object, The request body. (required)
122 The object takes the form of:
123
124{ # A Map is a collection of Layers, optionally contained within folders.
125 "description": "A String", # The description of this Map, supplied by the author.
126 "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.
127 3.14,
128 ],
129 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]130 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]131 "projectId": "A String", # The ID of the project that this Map is in.
132 "tags": [ # Tags of this Map.
133 "A String",
134 ],
135 "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).
136 "publishingStatus": "A String", # The publishing status of this map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]137 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]138 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]139 "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
140 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]141 3.14,
142 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]143 "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]144 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
145 "published",
146 ],
147 "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 Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]148 "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. This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]149 "id": "A String", # A globally unique ID, used to refer to this Map.
150 "contents": [ # The contents of this Map.
151 {
152 },
153 ],
154 "name": "A String", # The name of this Map, supplied by the author.
155}
156
157
158Returns:
159 An object of the form:
160
161 { # A Map is a collection of Layers, optionally contained within folders.
162 "description": "A String", # The description of this Map, supplied by the author.
163 "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.
164 3.14,
165 ],
166 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]167 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]168 "projectId": "A String", # The ID of the project that this Map is in.
169 "tags": [ # Tags of this Map.
170 "A String",
171 ],
172 "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).
173 "publishingStatus": "A String", # The publishing status of this map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]174 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]175 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]176 "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
177 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]178 3.14,
179 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]180 "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]181 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
182 "published",
183 ],
184 "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 Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]185 "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. This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]186 "id": "A String", # A globally unique ID, used to refer to this Map.
187 "contents": [ # The contents of this Map.
188 {
189 },
190 ],
191 "name": "A String", # The name of this Map, supplied by the author.
192 }</pre>
193</div>
194
195<div class="method">
196 <code class="details" id="delete">delete(id)</code>
197 <pre>Delete a map.
198
199Args:
200 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)
201</pre>
202</div>
203
204<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]205 <code class="details" id="get">get(id, version=None)</code>
206 <pre>Return metadata for a particular map.
207
208Args:
209 id: string, The ID of the map. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]210 version: string, Deprecated: The version parameter indicates which version of the map should be returned. When version is set to published, the published version of the map will be returned. Please use the maps.getPublished endpoint instead.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]211 Allowed values
212 draft - The draft version.
213 published - The published version.
214
215Returns:
216 An object of the form:
217
218 { # A Map is a collection of Layers, optionally contained within folders.
219 "description": "A String", # The description of this Map, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]220 "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]221 3.14,
222 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]223 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]224 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]225 "projectId": "A String", # The ID of the project that this Map is in.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]226 "tags": [ # Tags of this Map.
227 "A String",
228 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]229 "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]230 "publishingStatus": "A String", # The publishing status of this map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]231 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]232 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]233 "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
234 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]235 3.14,
236 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]237 "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]238 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
239 "published",
240 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]241 "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 Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]242 "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. This is an input field only. It is not returned in response to a list or get request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]243 "id": "A String", # A globally unique ID, used to refer to this Map.
244 "contents": [ # The contents of this Map.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]245 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]246 },
247 ],
248 "name": "A String", # The name of this Map, supplied by the author.
249 }</pre>
250</div>
251
252<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]253 <code class="details" id="getPublished">getPublished(id)</code>
254 <pre>Return the published metadata for a particular map.
255
256Args:
257 id: string, The ID of the map. (required)
258
259Returns:
260 An object of the form:
261
262 { # The published version of a map asset.
263 "name": "A String", # The name of this Map, supplied by the author.
264 "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.
265 3.14,
266 ],
267 "projectId": "A String", # The ID of the project that this Map is in.
268 "id": "A String", # A globally unique ID, used to refer to this Map.
269 "contents": [ # The contents of this Map.
270 {
271 },
272 ],
273 "description": "A String", # The description of this Map, supplied by the author.
274 }</pre>
275</div>
276
277<div class="method">
278 <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>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]279 <pre>Return all maps readable by the current user.
280
281Args:
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]282 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.
283 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
284 processingStatus: string, A parameter
285 Allowed values
286 complete - The map has completed processing.
287 failed - The map has failed processing.
288 notReady - The map is not ready for processing.
289 processing - The map is processing.
290 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.
291 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.
292 role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
293 Allowed values
294 owner - The user can read, write and administer the asset.
295 reader - The user can read the asset.
296 writer - The user can read and write the asset.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]297 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]298 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]299 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]300 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]301 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.
302 search: string, An unstructured search string used to filter the set of results based on asset metadata.
303 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]304
305Returns:
306 An object of the form:
307
308 { # The response returned by a call to maps.List.
309 "nextPageToken": "A String", # Next page token.
310 "maps": [ # Resources returned.
311 { # A Map is a collection of Layers, optionally contained within folders.
312 "description": "A String", # The description of this Map, supplied by the author.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]313 "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]314 3.14,
315 ],
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]316 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]317 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]318 "projectId": "A String", # The ID of the project that this Map is in.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]319 "tags": [ # Tags of this Map.
320 "A String",
321 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]322 "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]323 "publishingStatus": "A String", # The publishing status of this map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]324 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]325 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]326 "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
327 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]328 3.14,
329 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]330 "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]331 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
332 "published",
333 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]334 "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 Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]335 "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. This is an input field only. It is not returned in response to a list or get request.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]336 "id": "A String", # A globally unique ID, used to refer to this Map.
337 "contents": [ # The contents of this Map.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]338 {
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]339 },
340 ],
341 "name": "A String", # The name of this Map, supplied by the author.
342 },
343 ],
344 }</pre>
345</div>
346
347<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]348 <code class="details" id="listPublished">listPublished(pageToken=None, maxResults=None, projectId=None)</code>
349 <pre>Return all published maps readable by the current user.
350
351Args:
352 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.
353 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
354 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.
355
356Returns:
357 An object of the form:
358
359 { # The response returned by a call to maps.List.published.
360 "nextPageToken": "A String", # Next page token.
361 "maps": [ # Resources returned.
362 { # The published version of a map asset.
363 "name": "A String", # The name of this Map, supplied by the author.
364 "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.
365 3.14,
366 ],
367 "projectId": "A String", # The ID of the project that this Map is in.
368 "id": "A String", # A globally unique ID, used to refer to this Map.
369 "contents": [ # The contents of this Map.
370 {
371 },
372 ],
373 "description": "A String", # The description of this Map, supplied by the author.
374 },
375 ],
376 }</pre>
377</div>
378
379<div class="method">
380 <code class="details" id="listPublished_next">listPublished_next(previous_request, previous_response)</code>
381 <pre>Retrieves the next page of results.
382
383Args:
384 previous_request: The request for the previous page. (required)
385 previous_response: The response from the request for the previous page. (required)
386
387Returns:
388 A request object that you can call 'execute()' on to request the next
389 page. Returns None if there are no more items in the collection.
390 </pre>
391</div>
392
393<div class="method">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]394 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
395 <pre>Retrieves the next page of results.
396
397Args:
398 previous_request: The request for the previous page. (required)
399 previous_response: The response from the request for the previous page. (required)
400
401Returns:
402 A request object that you can call 'execute()' on to request the next
403 page. Returns None if there are no more items in the collection.
404 </pre>
405</div>
406
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]407<div class="method">
408 <code class="details" id="patch">patch(id, body)</code>
409 <pre>Mutate a map asset.
410
411Args:
412 id: string, The ID of the map. (required)
413 body: object, The request body. (required)
414 The object takes the form of:
415
416{ # A Map is a collection of Layers, optionally contained within folders.
417 "description": "A String", # The description of this Map, supplied by the author.
418 "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.
419 3.14,
420 ],
421 "processingStatus": "A String", # The processing status of this map. Map processing is automatically started once a map becomes ready for processing.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]422 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]423 "projectId": "A String", # The ID of the project that this Map is in.
424 "tags": [ # Tags of this Map.
425 "A String",
426 ],
427 "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).
428 "publishingStatus": "A String", # The publishing status of this map.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]429 "writersCanEditPermissions": True or False, # If true, WRITERs of the asset are able to edit the asset permissions.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]430 "etag": "A String", # The ETag, used to refer to the current version of the asset.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]431 "creatorEmail": "A String", # The email address of the creator of this map. This is only returned on GET requests and not LIST requests.
432 "bbox": [ # A rectangular bounding box which contains all of the data in this Map. The box is expressed as \"west, south, east, north\". The numbers represent latitude and longitude in decimal degrees.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]433 3.14,
434 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]435 "lastModifierEmail": "A String", # The email address of the last modifier of this map. This is only returned on GET requests and not LIST requests.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]436 "versions": [ # Deprecated: An array containing the available versions of this Map. Currently may only contain "published". The publishingStatus field should be used instead.
437 "published",
438 ],
439 "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 Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]440 "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. This is an input field only. It is not returned in response to a list or get request.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]441 "id": "A String", # A globally unique ID, used to refer to this Map.
442 "contents": [ # The contents of this Map.
443 {
444 },
445 ],
446 "name": "A String", # The name of this Map, supplied by the author.
447}
448
449</pre>
450</div>
451
452<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]453 <code class="details" id="publish">publish(id, force=None)</code>
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]454 <pre>Publish a map asset.
455
456Args:
457 id: string, The ID of the map. (required)
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]458 force: boolean, If set to true, the API will allow publication of the map even if it's out of date. If false, the map must have a processingStatus of complete before publishing.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]459
460Returns:
461 An object of the form:
462
463 { # The response returned by a call to any asset's Publish method.
464 }</pre>
465</div>
466
467<div class="method">
468 <code class="details" id="unpublish">unpublish(id)</code>
469 <pre>Unpublish a map asset.
470
471Args:
472 id: string, The ID of the map. (required)
473
474Returns:
475 An object of the form:
476
477 { # The response returned by a call to any asset's Publish method.
478 }</pre>
479</div>
480
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]481</body></html>