Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 1a91f7f69de6713cea06ed574283442fc08410fc / . / docs / dyn / mapsengine_v1.assets.html
blob: 3e32482a1a90a540d1ad83423322dc36af56eb5e [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">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]83 <code><a href="mapsengine_v1.assets.permissions.html">permissions()</a></code>
84</p>
85<p class="firstline">Returns the permissions Resource.</p>
86
87<p class="toc_element">
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88 <code><a href="#get">get(id)</a></code></p>
89<p class="firstline">Return metadata for a particular asset.</p>
90<p class="toc_element">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]91 <code><a href="#list">list(modifiedBefore=None, creatorEmail=None, projectId=None, pageToken=None, role=None, type=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]92<p class="firstline">Return all assets readable by the current user.</p>
93<p class="toc_element">
94 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
95<p class="firstline">Retrieves the next page of results.</p>
96<h3>Method Details</h3>
97<div class="method">
98 <code class="details" id="get">get(id)</code>
99 <pre>Return metadata for a particular asset.
100
101Args:
102 id: string, The ID of the asset. (required)
103
104Returns:
105 An object of the form:
106
107 { # 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.
108 #
109 # More detailed information about an asset can be obtained by querying the asset's particular endpoint.
110 "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]111 "description": "A String", # The asset's description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]112 "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.
113 "A String",
114 ],
115 "projectId": "A String", # The ID of the project to which the asset belongs.
116 "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 Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]117 "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]118 "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]119 "creatorEmail": "A String", # The email address of the creator of this asset. This is only returned on GET requests and not LIST requests.
120 "bbox": [ # A rectangular bounding box which contains all of the data in this asset. 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]121 3.14,
122 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]123 "lastModifierEmail": "A String", # The email address of the last modifier of this asset. This is only returned on GET requests and not LIST requests.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]124 "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).
125 "type": "A String", # The type of asset. One of raster, rasterCollection, table, map, or layer.
126 "id": "A String", # The asset's globally unique ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]127 "name": "A String", # The asset's name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]128 }</pre>
129</div>
130
131<div class="method">
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]132 <code class="details" id="list">list(modifiedBefore=None, creatorEmail=None, projectId=None, pageToken=None, role=None, type=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]133 <pre>Return all assets readable by the current user.
134
135Args:
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]136 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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]137 creatorEmail: string, An email address representing a user. Returned assets that have been created by the user associated with the provided email address.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]138 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.
139 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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]140 role: string, The role parameter indicates that the response should only contain assets where the current user has the specified level of access.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]141 Allowed values
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]142 owner - The user can read, write and administer the asset.
143 reader - The user can read the asset.
144 writer - The user can read and write the asset.
145 type: string, A comma separated list of asset types. Returned assets will have one of the types from the provided list. Supported values are 'map', 'layer', 'rasterCollection' and 'table'.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]146 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.
147 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]148 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]149 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]150 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.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]151 search: string, An unstructured search string used to filter the set of results based on asset metadata.
152 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]153
154Returns:
155 An object of the form:
156
157 { # The response returned by a call to resources.List.
158 "nextPageToken": "A String", # Next page token.
159 "assets": [ # Assets returned.
160 { # 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.
161 #
162 # More detailed information about an asset can be obtained by querying the asset's particular endpoint.
163 "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]164 "description": "A String", # The asset's description.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]165 "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.
166 "A String",
167 ],
168 "projectId": "A String", # The ID of the project to which the asset belongs.
169 "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 Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]170 "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]171 "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]172 "creatorEmail": "A String", # The email address of the creator of this asset. This is only returned on GET requests and not LIST requests.
173 "bbox": [ # A rectangular bounding box which contains all of the data in this asset. 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]174 3.14,
175 ],
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]176 "lastModifierEmail": "A String", # The email address of the last modifier of this asset. This is only returned on GET requests and not LIST requests.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]177 "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).
178 "type": "A String", # The type of asset. One of raster, rasterCollection, table, map, or layer.
179 "id": "A String", # The asset's globally unique ID.
Craig Citro065b5302014-08-14 00:47:23 -0700[diff] [blame]180 "name": "A String", # The asset's name.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]181 },
182 ],
183 }</pre>
184</div>
185
186<div class="method">
187 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
188 <pre>Retrieves the next page of results.
189
190Args:
191 previous_request: The request for the previous page. (required)
192 previous_response: The response from the request for the previous page. (required)
193
194Returns:
195 A request object that you can call 'execute()' on to request the next
196 page. Returns None if there are no more items in the collection.
197 </pre>
198</div>
199
200</body></html>