Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 32f7319a5e294b44afb47d75320ef18f32a11b83 / . / docs / dyn / fusiontables_v1.template.html
blob: d5d9a437a035dc2f45ffa224478629c218fdccfd [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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="fusiontables_v1.html">Fusion Tables API</a> . <a href="fusiontables_v1.template.html">template</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(tableId, templateId)</a></code></p>
79<p class="firstline">Deletes a template</p>
80<p class="toc_element">
81 <code><a href="#get">get(tableId, templateId)</a></code></p>
82<p class="firstline">Retrieves a specific template by its id</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(tableId, body)</a></code></p>
85<p class="firstline">Creates a new template for the table.</p>
86<p class="toc_element">
87 <code><a href="#list">list(tableId, pageToken=None, maxResults=None)</a></code></p>
88<p class="firstline">Retrieves a list of templates.</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<p class="toc_element">
93 <code><a href="#patch">patch(tableId, templateId, body)</a></code></p>
94<p class="firstline">Updates an existing template. This method supports patch semantics.</p>
95<p class="toc_element">
96 <code><a href="#update">update(tableId, templateId, body)</a></code></p>
97<p class="firstline">Updates an existing template</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="delete">delete(tableId, templateId)</code>
101 <pre>Deletes a template
102
103Args:
104 tableId: string, Table from which the template is being deleted (required)
105 templateId: integer, Identifier for the template which is being deleted (required)
106</pre>
107</div>
108
109<div class="method">
110 <code class="details" id="get">get(tableId, templateId)</code>
111 <pre>Retrieves a specific template by its id
112
113Args:
114 tableId: string, Table to which the template belongs (required)
115 templateId: integer, Identifier for the template that is being requested (required)
116
117Returns:
118 An object of the form:
119
120 { # Represents the contents of InfoWindow templates.
121 "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
122 "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
123 "name": "A String", # Optional name assigned to a template.
124 "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
125 "A String",
126 ],
127 "isDefaultForTable": True or False, # Is this the default template for the table.
128 "tableId": "A String", # Identifier for the table for which the template is defined.
129 "templateId": 42, # Identifier for the template, unique within the context of a particular table.
130 }</pre>
131</div>
132
133<div class="method">
134 <code class="details" id="insert">insert(tableId, body)</code>
135 <pre>Creates a new template for the table.
136
137Args:
138 tableId: string, Table for which a new template is being created (required)
139 body: object, The request body. (required)
140 The object takes the form of:
141
142{ # Represents the contents of InfoWindow templates.
143 "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
144 "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
145 "name": "A String", # Optional name assigned to a template.
146 "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
147 "A String",
148 ],
149 "isDefaultForTable": True or False, # Is this the default template for the table.
150 "tableId": "A String", # Identifier for the table for which the template is defined.
151 "templateId": 42, # Identifier for the template, unique within the context of a particular table.
152 }
153
154
155Returns:
156 An object of the form:
157
158 { # Represents the contents of InfoWindow templates.
159 "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
160 "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
161 "name": "A String", # Optional name assigned to a template.
162 "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
163 "A String",
164 ],
165 "isDefaultForTable": True or False, # Is this the default template for the table.
166 "tableId": "A String", # Identifier for the table for which the template is defined.
167 "templateId": 42, # Identifier for the template, unique within the context of a particular table.
168 }</pre>
169</div>
170
171<div class="method">
172 <code class="details" id="list">list(tableId, pageToken=None, maxResults=None)</code>
173 <pre>Retrieves a list of templates.
174
175Args:
176 tableId: string, Identifier for the table whose templates are being requested (required)
177 pageToken: string, Continuation token specifying which results page to return. Optional.
178 maxResults: integer, Maximum number of templates to return. Optional. Default is 5.
179
180Returns:
181 An object of the form:
182
183 { # Represents a list of templates for a given table.
184 "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
185 "items": [ # List of all requested templates.
186 { # Represents the contents of InfoWindow templates.
187 "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
188 "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
189 "name": "A String", # Optional name assigned to a template.
190 "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
191 "A String",
192 ],
193 "isDefaultForTable": True or False, # Is this the default template for the table.
194 "tableId": "A String", # Identifier for the table for which the template is defined.
195 "templateId": 42, # Identifier for the template, unique within the context of a particular table.
196 },
197 ],
198 "kind": "fusiontables#templateList", # Type name: a list of all templates.
199 "totalItems": 42, # Total number of templates for the table.
200 }</pre>
201</div>
202
203<div class="method">
204 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
205 <pre>Retrieves the next page of results.
206
207Args:
208 previous_request: The request for the previous page. (required)
209 previous_response: The response from the request for the previous page. (required)
210
211Returns:
212 A request object that you can call 'execute()' on to request the next
213 page. Returns None if there are no more items in the collection.
214 </pre>
215</div>
216
217<div class="method">
218 <code class="details" id="patch">patch(tableId, templateId, body)</code>
219 <pre>Updates an existing template. This method supports patch semantics.
220
221Args:
222 tableId: string, Table to which the updated template belongs (required)
223 templateId: integer, Identifier for the template that is being updated (required)
224 body: object, The request body. (required)
225 The object takes the form of:
226
227{ # Represents the contents of InfoWindow templates.
228 "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
229 "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
230 "name": "A String", # Optional name assigned to a template.
231 "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
232 "A String",
233 ],
234 "isDefaultForTable": True or False, # Is this the default template for the table.
235 "tableId": "A String", # Identifier for the table for which the template is defined.
236 "templateId": 42, # Identifier for the template, unique within the context of a particular table.
237 }
238
239
240Returns:
241 An object of the form:
242
243 { # Represents the contents of InfoWindow templates.
244 "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
245 "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
246 "name": "A String", # Optional name assigned to a template.
247 "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
248 "A String",
249 ],
250 "isDefaultForTable": True or False, # Is this the default template for the table.
251 "tableId": "A String", # Identifier for the table for which the template is defined.
252 "templateId": 42, # Identifier for the template, unique within the context of a particular table.
253 }</pre>
254</div>
255
256<div class="method">
257 <code class="details" id="update">update(tableId, templateId, body)</code>
258 <pre>Updates an existing template
259
260Args:
261 tableId: string, Table to which the updated template belongs (required)
262 templateId: integer, Identifier for the template that is being updated (required)
263 body: object, The request body. (required)
264 The object takes the form of:
265
266{ # Represents the contents of InfoWindow templates.
267 "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
268 "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
269 "name": "A String", # Optional name assigned to a template.
270 "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
271 "A String",
272 ],
273 "isDefaultForTable": True or False, # Is this the default template for the table.
274 "tableId": "A String", # Identifier for the table for which the template is defined.
275 "templateId": 42, # Identifier for the template, unique within the context of a particular table.
276 }
277
278
279Returns:
280 An object of the form:
281
282 { # Represents the contents of InfoWindow templates.
283 "body": "A String", # Body of the template. It contains HTML with {column_name} to insert values from a particular column. The body is sanitized to remove certain tags, e.g., script. Only one of body or automaticColumns can be specified.
284 "kind": "fusiontables#template", # Type name: a template for the info window contents. The template can either include an HTML body or a list of columns from which the template is computed automatically.
285 "name": "A String", # Optional name assigned to a template.
286 "automaticColumnNames": [ # List of columns from which the template is to be automatically constructed. Only one of body or automaticColumns can be specified.
287 "A String",
288 ],
289 "isDefaultForTable": True or False, # Is this the default template for the table.
290 "tableId": "A String", # Identifier for the table for which the template is defined.
291 "templateId": 42, # Identifier for the template, unique within the context of a particular table.
292 }</pre>
293</div>
294
295</body></html>