Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b1cc515b93bef725389ac86401366b6f7a98b0c8 / . / docs / dyn / mapsengine_v1.maps.html
blob: 63f23473e6d460a8967199adfb8c2d58379d3590 [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">
78 <code><a href="#get">get(id, version=None)</a></code></p>
79<p class="firstline">Return metadata for a particular map.</p>
80<p class="toc_element">
81 <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>
82<p class="firstline">Return all maps readable by the current user.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(id, version=None)</code>
89 <pre>Return metadata for a particular map.
90
91Args:
92 id: string, The ID of the map. (required)
93 version: string, A parameter
94 Allowed values
95 draft - The draft version.
96 published - The published version.
97
98Returns:
99 An object of the form:
100
101 { # A Map is a collection of Layers, optionally contained within folders.
102 "description": "A String", # The description of this Map, supplied by the author.
103 "defaultViewport": [ # 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.
104 3.14,
105 ],
106 "tags": [ # Tags of this Map.
107 "A String",
108 ],
109 "projectId": "A String", # The ID of the project that this Map is in.
110 "versions": [ # An array containing the available versions of this Map. Currently may only contain "published".
111 "A String",
112 ],
113 "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).
114 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Map. The numbers represent latitude and longitude in decimal degrees.
115 3.14,
116 ],
117 "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).
118 "id": "A String", # A globally unique ID, used to refer to this Map.
119 "contents": [ # The contents of this Map.
120 { # A map item.
121 },
122 ],
123 "name": "A String", # The name of this Map, supplied by the author.
124 }</pre>
125</div>
126
127<div class="method">
128 <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>
129 <pre>Return all maps readable by the current user.
130
131Args:
132 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.
133 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.
134 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.
135 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.
136 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
137 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.
138 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
139 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
140 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.
141
142Returns:
143 An object of the form:
144
145 { # The response returned by a call to maps.List.
146 "nextPageToken": "A String", # Next page token.
147 "maps": [ # Resources returned.
148 { # A Map is a collection of Layers, optionally contained within folders.
149 "description": "A String", # The description of this Map, supplied by the author.
150 "defaultViewport": [ # 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.
151 3.14,
152 ],
153 "tags": [ # Tags of this Map.
154 "A String",
155 ],
156 "projectId": "A String", # The ID of the project that this Map is in.
157 "versions": [ # An array containing the available versions of this Map. Currently may only contain "published".
158 "A String",
159 ],
160 "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).
161 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this Map. The numbers represent latitude and longitude in decimal degrees.
162 3.14,
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 "id": "A String", # A globally unique ID, used to refer to this Map.
166 "contents": [ # The contents of this Map.
167 { # A map item.
168 },
169 ],
170 "name": "A String", # The name of this Map, supplied by the author.
171 },
172 ],
173 }</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
178 <pre>Retrieves the next page of results.
179
180Args:
181 previous_request: The request for the previous page. (required)
182 previous_response: The response from the request for the previous page. (required)
183
184Returns:
185 A request object that you can call 'execute()' on to request the next
186 page. Returns None if there are no more items in the collection.
187 </pre>
188</div>
189
190</body></html>