Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b1cc515b93bef725389ac86401366b6f7a98b0c8 / . / docs / dyn / mapsengine_v1.assets.html
blob: 79dbb26e42429202197a1781c971708222b76797 [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.assets.html">assets</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="mapsengine_v1.assets.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="#get">get(id)</a></code></p>
84<p class="firstline">Return metadata for a particular asset.</p>
85<p class="toc_element">
86 <code><a href="#list">list(modifiedAfter=None, createdAfter=None, type=None, pageToken=None, projectId=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</a></code></p>
87<p class="firstline">Return all assets readable by the current user.</p>
88<p class="toc_element">
89 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
90<p class="firstline">Retrieves the next page of results.</p>
91<h3>Method Details</h3>
92<div class="method">
93 <code class="details" id="get">get(id)</code>
94 <pre>Return metadata for a particular asset.
95
96Args:
97 id: string, The ID of the asset. (required)
98
99Returns:
100 An object of the form:
101
102 { # An asset is any Google Maps Engine resource that has a globally unique ID. Assets include maps, layers, vector tables, raster collections, and rasters. Projects and features are not considered assets.
103 #
104 # More detailed information about an asset can be obtained by querying the asset's particular endpoint.
105 "resource": "A String", # The URL to query to retrieve the asset's complete object. The assets endpoint only returns high-level information about a resource.
106 "name": "A String", # The asset's name.
107 "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
108 "A String",
109 ],
110 "projectId": "A String", # The ID of the project to which the asset belongs.
111 "creationTime": "A String", # The creation time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).
112 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this asset. The numbers represent latitude and longitude in decimal degrees.
113 3.14,
114 ],
115 "lastModifiedTime": "A String", # The last modified time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).
116 "type": "A String", # The type of asset. One of raster, rasterCollection, table, map, or layer.
117 "id": "A String", # The asset's globally unique ID.
118 "description": "A String", # The asset's description.
119 }</pre>
120</div>
121
122<div class="method">
123 <code class="details" id="list">list(modifiedAfter=None, createdAfter=None, type=None, pageToken=None, projectId=None, maxResults=None, createdBefore=None, bbox=None, creatorEmail=None, modifiedBefore=None)</code>
124 <pre>Return all assets readable by the current user.
125
126Args:
127 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.
128 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.
129 type: string, An asset type restriction. If set, only resources of this type will be returned.
130 Allowed values
131 layer - Return layers.
132 map - Return maps.
133 rasterCollection - Return raster collections.
134 table - Return tables.
135 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.
136 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.
137 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 100.
138 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.
139 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
140 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
141 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.
142
143Returns:
144 An object of the form:
145
146 { # The response returned by a call to resources.List.
147 "nextPageToken": "A String", # Next page token.
148 "assets": [ # Assets returned.
149 { # An asset is any Google Maps Engine resource that has a globally unique ID. Assets include maps, layers, vector tables, raster collections, and rasters. Projects and features are not considered assets.
150 #
151 # More detailed information about an asset can be obtained by querying the asset's particular endpoint.
152 "resource": "A String", # The URL to query to retrieve the asset's complete object. The assets endpoint only returns high-level information about a resource.
153 "name": "A String", # The asset's name.
154 "tags": [ # An array of text strings, with each string representing a tag. More information about tags can be found in the Tagging data article of the Maps Engine help center.
155 "A String",
156 ],
157 "projectId": "A String", # The ID of the project to which the asset belongs.
158 "creationTime": "A String", # The creation time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).
159 "bbox": [ # An array of four numbers (west, south, east, north) which define the rectangular bounding box which contains all of the data in this asset. The numbers represent latitude and longitude in decimal degrees.
160 3.14,
161 ],
162 "lastModifiedTime": "A String", # The last modified time of this asset. The value is an RFC 3339-formatted date-time value (for example, 1970-01-01T00:00:00Z).
163 "type": "A String", # The type of asset. One of raster, rasterCollection, table, map, or layer.
164 "id": "A String", # The asset's globally unique ID.
165 "description": "A String", # The asset's description.
166 },
167 ],
168 }</pre>
169</div>
170
171<div class="method">
172 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
173 <pre>Retrieves the next page of results.
174
175Args:
176 previous_request: The request for the previous page. (required)
177 previous_response: The response from the request for the previous page. (required)
178
179Returns:
180 A request object that you can call 'execute()' on to request the next
181 page. Returns None if there are no more items in the collection.
182 </pre>
183</div>
184
185</body></html>