Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 63caac01ea7b9fbd8ae70bcbb4c6ecbec833ad3d / . / docs / dyn / mapsengine_v1.assets.html
blob: 4df1b5a1f1d6855be3635fa9bdbbf448968f4372 [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">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]86 <code><a href="#list">list(modifiedBefore=None, createdBefore=None, projectId=None, pageToken=None, type=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, creatorEmail=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]106 "description": "A String", # The asset's description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]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).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]112 "etag": "A String", # The ETag, used to refer to the current version of the asset.
113 "bbox": [ # A rectangular bounding box which contains all of the data in this asset. The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]114 3.14,
115 ],
116 "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).
117 "type": "A String", # The type of asset. One of raster, rasterCollection, table, map, or layer.
118 "id": "A String", # The asset's globally unique ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]119 "name": "A String", # The asset's name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]120 }</pre>
121</div>
122
123<div class="method">
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]124 <code class="details" id="list">list(modifiedBefore=None, createdBefore=None, projectId=None, pageToken=None, type=None, createdAfter=None, tags=None, maxResults=None, bbox=None, modifiedAfter=None, creatorEmail=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]125 <pre>Return all assets readable by the current user.
126
127Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]128 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.
129 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.
130 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.
131 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]132 type: string, An asset type restriction. If set, only resources of this type will be returned.
133 Allowed values
134 layer - Return layers.
135 map - Return maps.
136 rasterCollection - Return raster collections.
137 table - Return tables.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]138 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.
139 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]140 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]141 bbox: string, A bounding box, expressed as "west,south,east,north". If set, only assets which intersect this bounding box will be returned.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]142 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.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]143 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144
145Returns:
146 An object of the form:
147
148 { # The response returned by a call to resources.List.
149 "nextPageToken": "A String", # Next page token.
150 "assets": [ # Assets returned.
151 { # 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.
152 #
153 # More detailed information about an asset can be obtained by querying the asset's particular endpoint.
154 "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.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]155 "description": "A String", # The asset's description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]156 "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.
157 "A String",
158 ],
159 "projectId": "A String", # The ID of the project to which the asset belongs.
160 "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).
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]161 "etag": "A String", # The ETag, used to refer to the current version of the asset.
162 "bbox": [ # A rectangular bounding box which contains all of the data in this asset. The numbers represent latitude and longitude in decimal degrees.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]163 3.14,
164 ],
165 "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).
166 "type": "A String", # The type of asset. One of raster, rasterCollection, table, map, or layer.
167 "id": "A String", # The asset's globally unique ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]168 "name": "A String", # The asset's name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]169 },
170 ],
171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
176 <pre>Retrieves the next page of results.
177
178Args:
179 previous_request: The request for the previous page. (required)
180 previous_response: The response from the request for the previous page. (required)
181
182Returns:
183 A request object that you can call 'execute()' on to request the next
184 page. Returns None if there are no more items in the collection.
185 </pre>
186</div>
187
188</body></html>