• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.table.html">table</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#copy">copy(tableId, copyPresentation=None)</a></code></p>
79<p class="firstline">Copies a table.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(tableId)</a></code></p>
82<p class="firstline">Deletes a table.</p>
83<p class="toc_element">
84  <code><a href="#get">get(tableId)</a></code></p>
85<p class="firstline">Retrieves a specific table by its id.</p>
86<p class="toc_element">
87  <code><a href="#importRows">importRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, media_mime_type=None, delimiter=None, endLine=None)</a></code></p>
88<p class="firstline">Import more rows into a table.</p>
89<p class="toc_element">
90  <code><a href="#importTable">importTable(name, media_body=None, encoding=None, delimiter=None, media_mime_type=None)</a></code></p>
91<p class="firstline">Import a new table.</p>
92<p class="toc_element">
93  <code><a href="#insert">insert(body)</a></code></p>
94<p class="firstline">Creates a new table.</p>
95<p class="toc_element">
96  <code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
97<p class="firstline">Retrieves a list of tables a user owns.</p>
98<p class="toc_element">
99  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
102  <code><a href="#patch">patch(tableId, body, replaceViewDefinition=None)</a></code></p>
103<p class="firstline">Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics.</p>
104<p class="toc_element">
105  <code><a href="#update">update(tableId, body, replaceViewDefinition=None)</a></code></p>
106<p class="firstline">Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.</p>
107<h3>Method Details</h3>
108<div class="method">
109    <code class="details" id="copy">copy(tableId, copyPresentation=None)</code>
110  <pre>Copies a table.
111
112Args:
113  tableId: string, ID of the table that is being copied. (required)
114  copyPresentation: boolean, Whether to also copy tabs, styles, and templates. Default is false.
115
116Returns:
117  An object of the form:
118
119    { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
120      "kind": "fusiontables#table", # Type name: a template for an individual table.
121      "attribution": "A String", # Optional attribution assigned to the table.
122      "description": "A String", # Optional description assigned to the table.
123      "isExportable": True or False, # Variable for whether table is exportable.
124      "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
125        "A String",
126      ],
127      "attributionLink": "A String", # Optional link for attribution.
128      "sql": "A String", # Optional sql that encodes the table definition for derived tables.
129      "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
130      "columns": [ # Columns in the table.
131        { # Specifies the id, name and type of a column in a table.
132            "kind": "fusiontables#column", # Type name: a template for an individual column.
133            "description": "A String", # Optional column description.
134            "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
135              "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
136              "columnId": 42, # The id of the column in the base table from which this column is derived.
137            },
138            "columnId": 42, # Identifier for the column.
139            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
140            "type": "A String", # Required type of the column.
141            "name": "A String", # Required name of the column.
142          },
143      ],
144      "name": "A String", # Name assigned to a table.
145    }</pre>
146</div>
147
148<div class="method">
149    <code class="details" id="delete">delete(tableId)</code>
150  <pre>Deletes a table.
151
152Args:
153  tableId: string, ID of the table that is being deleted. (required)
154</pre>
155</div>
156
157<div class="method">
158    <code class="details" id="get">get(tableId)</code>
159  <pre>Retrieves a specific table by its id.
160
161Args:
162  tableId: string, Identifier(ID) for the table being requested. (required)
163
164Returns:
165  An object of the form:
166
167    { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
168      "kind": "fusiontables#table", # Type name: a template for an individual table.
169      "attribution": "A String", # Optional attribution assigned to the table.
170      "description": "A String", # Optional description assigned to the table.
171      "isExportable": True or False, # Variable for whether table is exportable.
172      "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
173        "A String",
174      ],
175      "attributionLink": "A String", # Optional link for attribution.
176      "sql": "A String", # Optional sql that encodes the table definition for derived tables.
177      "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
178      "columns": [ # Columns in the table.
179        { # Specifies the id, name and type of a column in a table.
180            "kind": "fusiontables#column", # Type name: a template for an individual column.
181            "description": "A String", # Optional column description.
182            "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
183              "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
184              "columnId": 42, # The id of the column in the base table from which this column is derived.
185            },
186            "columnId": 42, # Identifier for the column.
187            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
188            "type": "A String", # Required type of the column.
189            "name": "A String", # Required name of the column.
190          },
191      ],
192      "name": "A String", # Name assigned to a table.
193    }</pre>
194</div>
195
196<div class="method">
197    <code class="details" id="importRows">importRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, media_mime_type=None, delimiter=None, endLine=None)</code>
198  <pre>Import more rows into a table.
199
200Args:
201  tableId: string, The table into which new rows are being imported. (required)
202  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
203  startLine: integer, The index of the first line from which to start importing, inclusive. Default is 0.
204  isStrict: boolean, Whether the CSV must have the same number of values for each row. If false, rows with fewer values will be padded with empty values. Default is true.
205  encoding: string, The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding.
206  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
207  delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ','.
208  endLine: integer, The index of the last line from which to start importing, exclusive. Thus, the number of imported lines is endLine - startLine. If this parameter is not provided, the file will be imported until the last line of the file. If endLine is negative, then the imported content will exclude the last endLine lines. That is, if endline is negative, no line will be imported whose index is greater than N + endLine where N is the number of lines in the file, and the number of imported lines will be N + endLine - startLine.
209
210Returns:
211  An object of the form:
212
213    { # Represents an import request.
214    "numRowsReceived": "A String", # The number of rows received from the import request.
215    "kind": "fusiontables#import", # Type name: a template for an import request.
216  }</pre>
217</div>
218
219<div class="method">
220    <code class="details" id="importTable">importTable(name, media_body=None, encoding=None, delimiter=None, media_mime_type=None)</code>
221  <pre>Import a new table.
222
223Args:
224  name: string, The name to be assigned to the new table. (required)
225  media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
226  encoding: string, The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding.
227  delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ','.
228  media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
229
230Returns:
231  An object of the form:
232
233    { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
234      "kind": "fusiontables#table", # Type name: a template for an individual table.
235      "attribution": "A String", # Optional attribution assigned to the table.
236      "description": "A String", # Optional description assigned to the table.
237      "isExportable": True or False, # Variable for whether table is exportable.
238      "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
239        "A String",
240      ],
241      "attributionLink": "A String", # Optional link for attribution.
242      "sql": "A String", # Optional sql that encodes the table definition for derived tables.
243      "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
244      "columns": [ # Columns in the table.
245        { # Specifies the id, name and type of a column in a table.
246            "kind": "fusiontables#column", # Type name: a template for an individual column.
247            "description": "A String", # Optional column description.
248            "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
249              "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
250              "columnId": 42, # The id of the column in the base table from which this column is derived.
251            },
252            "columnId": 42, # Identifier for the column.
253            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
254            "type": "A String", # Required type of the column.
255            "name": "A String", # Required name of the column.
256          },
257      ],
258      "name": "A String", # Name assigned to a table.
259    }</pre>
260</div>
261
262<div class="method">
263    <code class="details" id="insert">insert(body)</code>
264  <pre>Creates a new table.
265
266Args:
267  body: object, The request body. (required)
268    The object takes the form of:
269
270{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
271    "kind": "fusiontables#table", # Type name: a template for an individual table.
272    "attribution": "A String", # Optional attribution assigned to the table.
273    "description": "A String", # Optional description assigned to the table.
274    "isExportable": True or False, # Variable for whether table is exportable.
275    "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
276      "A String",
277    ],
278    "attributionLink": "A String", # Optional link for attribution.
279    "sql": "A String", # Optional sql that encodes the table definition for derived tables.
280    "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
281    "columns": [ # Columns in the table.
282      { # Specifies the id, name and type of a column in a table.
283          "kind": "fusiontables#column", # Type name: a template for an individual column.
284          "description": "A String", # Optional column description.
285          "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
286            "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
287            "columnId": 42, # The id of the column in the base table from which this column is derived.
288          },
289          "columnId": 42, # Identifier for the column.
290          "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
291          "type": "A String", # Required type of the column.
292          "name": "A String", # Required name of the column.
293        },
294    ],
295    "name": "A String", # Name assigned to a table.
296  }
297
298
299Returns:
300  An object of the form:
301
302    { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
303      "kind": "fusiontables#table", # Type name: a template for an individual table.
304      "attribution": "A String", # Optional attribution assigned to the table.
305      "description": "A String", # Optional description assigned to the table.
306      "isExportable": True or False, # Variable for whether table is exportable.
307      "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
308        "A String",
309      ],
310      "attributionLink": "A String", # Optional link for attribution.
311      "sql": "A String", # Optional sql that encodes the table definition for derived tables.
312      "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
313      "columns": [ # Columns in the table.
314        { # Specifies the id, name and type of a column in a table.
315            "kind": "fusiontables#column", # Type name: a template for an individual column.
316            "description": "A String", # Optional column description.
317            "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
318              "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
319              "columnId": 42, # The id of the column in the base table from which this column is derived.
320            },
321            "columnId": 42, # Identifier for the column.
322            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
323            "type": "A String", # Required type of the column.
324            "name": "A String", # Required name of the column.
325          },
326      ],
327      "name": "A String", # Name assigned to a table.
328    }</pre>
329</div>
330
331<div class="method">
332    <code class="details" id="list">list(pageToken=None, maxResults=None)</code>
333  <pre>Retrieves a list of tables a user owns.
334
335Args:
336  pageToken: string, Continuation token specifying which result page to return. Optional.
337  maxResults: integer, Maximum number of styles to return. Optional. Default is 5.
338
339Returns:
340  An object of the form:
341
342    { # Represents a list of tables.
343    "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
344    "items": [ # List of all requested tables.
345      { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
346          "kind": "fusiontables#table", # Type name: a template for an individual table.
347          "attribution": "A String", # Optional attribution assigned to the table.
348          "description": "A String", # Optional description assigned to the table.
349          "isExportable": True or False, # Variable for whether table is exportable.
350          "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
351            "A String",
352          ],
353          "attributionLink": "A String", # Optional link for attribution.
354          "sql": "A String", # Optional sql that encodes the table definition for derived tables.
355          "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
356          "columns": [ # Columns in the table.
357            { # Specifies the id, name and type of a column in a table.
358                "kind": "fusiontables#column", # Type name: a template for an individual column.
359                "description": "A String", # Optional column description.
360                "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
361                  "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
362                  "columnId": 42, # The id of the column in the base table from which this column is derived.
363                },
364                "columnId": 42, # Identifier for the column.
365                "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
366                "type": "A String", # Required type of the column.
367                "name": "A String", # Required name of the column.
368              },
369          ],
370          "name": "A String", # Name assigned to a table.
371        },
372    ],
373    "kind": "fusiontables#tableList", # Type name: a list of all tables.
374  }</pre>
375</div>
376
377<div class="method">
378    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
379  <pre>Retrieves the next page of results.
380
381Args:
382  previous_request: The request for the previous page. (required)
383  previous_response: The response from the request for the previous page. (required)
384
385Returns:
386  A request object that you can call 'execute()' on to request the next
387  page. Returns None if there are no more items in the collection.
388    </pre>
389</div>
390
391<div class="method">
392    <code class="details" id="patch">patch(tableId, body, replaceViewDefinition=None)</code>
393  <pre>Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics.
394
395Args:
396  tableId: string, ID of the table that is being updated. (required)
397  body: object, The request body. (required)
398    The object takes the form of:
399
400{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
401    "kind": "fusiontables#table", # Type name: a template for an individual table.
402    "attribution": "A String", # Optional attribution assigned to the table.
403    "description": "A String", # Optional description assigned to the table.
404    "isExportable": True or False, # Variable for whether table is exportable.
405    "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
406      "A String",
407    ],
408    "attributionLink": "A String", # Optional link for attribution.
409    "sql": "A String", # Optional sql that encodes the table definition for derived tables.
410    "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
411    "columns": [ # Columns in the table.
412      { # Specifies the id, name and type of a column in a table.
413          "kind": "fusiontables#column", # Type name: a template for an individual column.
414          "description": "A String", # Optional column description.
415          "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
416            "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
417            "columnId": 42, # The id of the column in the base table from which this column is derived.
418          },
419          "columnId": 42, # Identifier for the column.
420          "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
421          "type": "A String", # Required type of the column.
422          "name": "A String", # Required name of the column.
423        },
424    ],
425    "name": "A String", # Name assigned to a table.
426  }
427
428  replaceViewDefinition: boolean, Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition.
429
430Returns:
431  An object of the form:
432
433    { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
434      "kind": "fusiontables#table", # Type name: a template for an individual table.
435      "attribution": "A String", # Optional attribution assigned to the table.
436      "description": "A String", # Optional description assigned to the table.
437      "isExportable": True or False, # Variable for whether table is exportable.
438      "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
439        "A String",
440      ],
441      "attributionLink": "A String", # Optional link for attribution.
442      "sql": "A String", # Optional sql that encodes the table definition for derived tables.
443      "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
444      "columns": [ # Columns in the table.
445        { # Specifies the id, name and type of a column in a table.
446            "kind": "fusiontables#column", # Type name: a template for an individual column.
447            "description": "A String", # Optional column description.
448            "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
449              "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
450              "columnId": 42, # The id of the column in the base table from which this column is derived.
451            },
452            "columnId": 42, # Identifier for the column.
453            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
454            "type": "A String", # Required type of the column.
455            "name": "A String", # Required name of the column.
456          },
457      ],
458      "name": "A String", # Name assigned to a table.
459    }</pre>
460</div>
461
462<div class="method">
463    <code class="details" id="update">update(tableId, body, replaceViewDefinition=None)</code>
464  <pre>Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.
465
466Args:
467  tableId: string, ID of the table that is being updated. (required)
468  body: object, The request body. (required)
469    The object takes the form of:
470
471{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
472    "kind": "fusiontables#table", # Type name: a template for an individual table.
473    "attribution": "A String", # Optional attribution assigned to the table.
474    "description": "A String", # Optional description assigned to the table.
475    "isExportable": True or False, # Variable for whether table is exportable.
476    "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
477      "A String",
478    ],
479    "attributionLink": "A String", # Optional link for attribution.
480    "sql": "A String", # Optional sql that encodes the table definition for derived tables.
481    "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
482    "columns": [ # Columns in the table.
483      { # Specifies the id, name and type of a column in a table.
484          "kind": "fusiontables#column", # Type name: a template for an individual column.
485          "description": "A String", # Optional column description.
486          "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
487            "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
488            "columnId": 42, # The id of the column in the base table from which this column is derived.
489          },
490          "columnId": 42, # Identifier for the column.
491          "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
492          "type": "A String", # Required type of the column.
493          "name": "A String", # Required name of the column.
494        },
495    ],
496    "name": "A String", # Name assigned to a table.
497  }
498
499  replaceViewDefinition: boolean, Should the view definition also be updated? The specified view definition replaces the existing one. Only a view can be updated with a new definition.
500
501Returns:
502  An object of the form:
503
504    { # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
505      "kind": "fusiontables#table", # Type name: a template for an individual table.
506      "attribution": "A String", # Optional attribution assigned to the table.
507      "description": "A String", # Optional description assigned to the table.
508      "isExportable": True or False, # Variable for whether table is exportable.
509      "baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
510        "A String",
511      ],
512      "attributionLink": "A String", # Optional link for attribution.
513      "sql": "A String", # Optional sql that encodes the table definition for derived tables.
514      "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
515      "columns": [ # Columns in the table.
516        { # Specifies the id, name and type of a column in a table.
517            "kind": "fusiontables#column", # Type name: a template for an individual column.
518            "description": "A String", # Optional column description.
519            "baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
520              "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
521              "columnId": 42, # The id of the column in the base table from which this column is derived.
522            },
523            "columnId": 42, # Identifier for the column.
524            "graph_predicate": "A String", # Optional column predicate. Used to map table to graph data model (subject,predicate,object) See http://www.w3.org/TR/2014/REC-rdf11-concepts-20140225/#data-model
525            "type": "A String", # Required type of the column.
526            "name": "A String", # Required name of the column.
527          },
528      ],
529      "name": "A String", # Name assigned to a table.
530    }</pre>
531</div>
532
533</body></html>