Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 703c92ca475a5fd3e8cc2c5b3961be0251b5480c / . / docs / dyn / mapsengine_v1.projects.icons.html
blob: 486cba07572a5e7c3af45654f7024804c67def72 [file] [log] [blame]
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[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.projects.html">projects</a> . <a href="mapsengine_v1.projects.icons.html">icons</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(projectId, body=None, media_body=None)</a></code></p>
79<p class="firstline">Create an icon.</p>
80<p class="toc_element">
81 <code><a href="#get">get(projectId, id)</a></code></p>
82<p class="firstline">Return an icon or its associated metadata</p>
83<p class="toc_element">
84 <code><a href="#get_media">get_media(projectId, id)</a></code></p>
85<p class="firstline">Return an icon or its associated metadata</p>
86<p class="toc_element">
87 <code><a href="#list">list(projectId, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Return all icons in the current project</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="create">create(projectId, body=None, media_body=None)</code>
95 <pre>Create an icon.
96
97Args:
98 projectId: string, The ID of the project. (required)
99 body: object, The request body.
100 The object takes the form of:
101
102{ # An icon is a user-uploaded image that can be used to style point geometries.
103 "description": "A String", # The description of this Icon, supplied by the author.
104 "name": "A String", # The name of this Icon, supplied by the author.
105 "id": "A String", # An ID used to refer to this Icon.
106 }
107
108 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
109
110Returns:
111 An object of the form:
112
113 { # An icon is a user-uploaded image that can be used to style point geometries.
114 "description": "A String", # The description of this Icon, supplied by the author.
115 "name": "A String", # The name of this Icon, supplied by the author.
116 "id": "A String", # An ID used to refer to this Icon.
117 }</pre>
118</div>
119
120<div class="method">
121 <code class="details" id="get">get(projectId, id)</code>
122 <pre>Return an icon or its associated metadata
123
124Args:
125 projectId: string, The ID of the project. (required)
126 id: string, The ID of the icon. (required)
127
128Returns:
129 An object of the form:
130
131 { # An icon is a user-uploaded image that can be used to style point geometries.
132 "description": "A String", # The description of this Icon, supplied by the author.
133 "name": "A String", # The name of this Icon, supplied by the author.
134 "id": "A String", # An ID used to refer to this Icon.
135 }</pre>
136</div>
137
138<div class="method">
139 <code class="details" id="get_media">get_media(projectId, id)</code>
140 <pre>Return an icon or its associated metadata
141
142Args:
143 projectId: string, The ID of the project. (required)
144 id: string, The ID of the icon. (required)
145
146Returns:
147 The media object as a string.
148
149 </pre>
150</div>
151
152<div class="method">
153 <code class="details" id="list">list(projectId, pageToken=None, maxResults=None)</code>
154 <pre>Return all icons in the current project
155
156Args:
157 projectId: string, The ID of the project. (required)
158 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.
159 maxResults: integer, The maximum number of items to include in a single response page. The maximum supported value is 50.
160
161Returns:
162 An object of the form:
163
164 { # The response returned by a call to icons.List.
165 "nextPageToken": "A String", # Next page token.
166 "icons": [ # Resources returned.
167 { # An icon is a user-uploaded image that can be used to style point geometries.
168 "description": "A String", # The description of this Icon, supplied by the author.
169 "name": "A String", # The name of this Icon, supplied by the author.
170 "id": "A String", # An ID used to refer to this Icon.
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>