blob: 6bfdddce001d162641e7ce20585b6ad412d17ca6 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="fusiontables_v1.html">Fusion Tables API</a> . <a href="fusiontables_v1.table.html">table</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#delete">delete(tableId)</a></code></p>
<p class="firstline">Deletes a table.</p>
<p class="toc_element">
<code><a href="#get">get(tableId)</a></code></p>
<p class="firstline">Retrieves a specific table by its id.</p>
<p class="toc_element">
<code><a href="#insert">insert(body)</a></code></p>
<p class="firstline">Creates a new table.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Retrieves a list of tables a user owns.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(tableId, body, replaceViewDefinition=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#update">update(tableId, body, replaceViewDefinition=None)</a></code></p>
<p class="firstline">Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="delete">delete(tableId)</code>
<pre>Deletes a table.
Args:
tableId: string, Id of the table that is being deleted. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(tableId)</code>
<pre>Retrieves a specific table by its id.
Args:
tableId: string, Identifier(ID) for the table being requested. (required)
Returns:
An object of the form:
{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
"kind": "fusiontables#table", # Type name: a template for an individual table.
"attribution": "A String", # Optional attribution assigned to the table.
"description": "A String", # Optional description assigned to the table.
"isExportable": True or False, # Variable for whether table is exportable.
"baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
"A String",
],
"attributionLink": "A String", # Optional link for attribution.
"tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
"columns": [ # Columns in the table.
{ # Specifies the id, name and type of a column in a table.
"kind": "fusiontables#column", # Type name: a template for an individual column.
"type": "A String", # Required type of the column.
"columnId": 42, # Identifier for the column.
"name": "A String", # Required name of the column.
"baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
"tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
"columnId": 42, # The id of the column in the base table from which this column is derived.
},
},
],
"name": "A String", # Name assigned to a table.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body)</code>
<pre>Creates a new table.
Args:
body: object, The request body. (required)
The object takes the form of:
{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
"kind": "fusiontables#table", # Type name: a template for an individual table.
"attribution": "A String", # Optional attribution assigned to the table.
"description": "A String", # Optional description assigned to the table.
"isExportable": True or False, # Variable for whether table is exportable.
"baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
"A String",
],
"attributionLink": "A String", # Optional link for attribution.
"tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
"columns": [ # Columns in the table.
{ # Specifies the id, name and type of a column in a table.
"kind": "fusiontables#column", # Type name: a template for an individual column.
"type": "A String", # Required type of the column.
"columnId": 42, # Identifier for the column.
"name": "A String", # Required name of the column.
"baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
"tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
"columnId": 42, # The id of the column in the base table from which this column is derived.
},
},
],
"name": "A String", # Name assigned to a table.
}
Returns:
An object of the form:
{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
"kind": "fusiontables#table", # Type name: a template for an individual table.
"attribution": "A String", # Optional attribution assigned to the table.
"description": "A String", # Optional description assigned to the table.
"isExportable": True or False, # Variable for whether table is exportable.
"baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
"A String",
],
"attributionLink": "A String", # Optional link for attribution.
"tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
"columns": [ # Columns in the table.
{ # Specifies the id, name and type of a column in a table.
"kind": "fusiontables#column", # Type name: a template for an individual column.
"type": "A String", # Required type of the column.
"columnId": 42, # Identifier for the column.
"name": "A String", # Required name of the column.
"baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
"tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
"columnId": 42, # The id of the column in the base table from which this column is derived.
},
},
],
"name": "A String", # Name assigned to a table.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, maxResults=None)</code>
<pre>Retrieves a list of tables a user owns.
Args:
pageToken: string, Continuation token specifying which result page to return. Optional.
maxResults: integer, Maximum number of styles to return. Optional. Default is 5.
Returns:
An object of the form:
{ # Represents a list of tables.
"nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more tokens left.
"items": [ # List of all requested tables.
{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
"kind": "fusiontables#table", # Type name: a template for an individual table.
"attribution": "A String", # Optional attribution assigned to the table.
"description": "A String", # Optional description assigned to the table.
"isExportable": True or False, # Variable for whether table is exportable.
"baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
"A String",
],
"attributionLink": "A String", # Optional link for attribution.
"tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
"columns": [ # Columns in the table.
{ # Specifies the id, name and type of a column in a table.
"kind": "fusiontables#column", # Type name: a template for an individual column.
"type": "A String", # Required type of the column.
"columnId": 42, # Identifier for the column.
"name": "A String", # Required name of the column.
"baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
"tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
"columnId": 42, # The id of the column in the base table from which this column is derived.
},
},
],
"name": "A String", # Name assigned to a table.
},
],
"kind": "fusiontables#tableList", # Type name: a list of all tables.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(tableId, body, replaceViewDefinition=None)</code>
<pre>Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics.
Args:
tableId: string, Id of the table that is being updated. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
"kind": "fusiontables#table", # Type name: a template for an individual table.
"attribution": "A String", # Optional attribution assigned to the table.
"description": "A String", # Optional description assigned to the table.
"isExportable": True or False, # Variable for whether table is exportable.
"baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
"A String",
],
"attributionLink": "A String", # Optional link for attribution.
"tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
"columns": [ # Columns in the table.
{ # Specifies the id, name and type of a column in a table.
"kind": "fusiontables#column", # Type name: a template for an individual column.
"type": "A String", # Required type of the column.
"columnId": 42, # Identifier for the column.
"name": "A String", # Required name of the column.
"baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
"tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
"columnId": 42, # The id of the column in the base table from which this column is derived.
},
},
],
"name": "A String", # Name assigned to a table.
}
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.
Returns:
An object of the form:
{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
"kind": "fusiontables#table", # Type name: a template for an individual table.
"attribution": "A String", # Optional attribution assigned to the table.
"description": "A String", # Optional description assigned to the table.
"isExportable": True or False, # Variable for whether table is exportable.
"baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
"A String",
],
"attributionLink": "A String", # Optional link for attribution.
"tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
"columns": [ # Columns in the table.
{ # Specifies the id, name and type of a column in a table.
"kind": "fusiontables#column", # Type name: a template for an individual column.
"type": "A String", # Required type of the column.
"columnId": 42, # Identifier for the column.
"name": "A String", # Required name of the column.
"baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
"tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
"columnId": 42, # The id of the column in the base table from which this column is derived.
},
},
],
"name": "A String", # Name assigned to a table.
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(tableId, body, replaceViewDefinition=None)</code>
<pre>Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.
Args:
tableId: string, Id of the table that is being updated. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
"kind": "fusiontables#table", # Type name: a template for an individual table.
"attribution": "A String", # Optional attribution assigned to the table.
"description": "A String", # Optional description assigned to the table.
"isExportable": True or False, # Variable for whether table is exportable.
"baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
"A String",
],
"attributionLink": "A String", # Optional link for attribution.
"tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
"columns": [ # Columns in the table.
{ # Specifies the id, name and type of a column in a table.
"kind": "fusiontables#column", # Type name: a template for an individual column.
"type": "A String", # Required type of the column.
"columnId": 42, # Identifier for the column.
"name": "A String", # Required name of the column.
"baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
"tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
"columnId": 42, # The id of the column in the base table from which this column is derived.
},
},
],
"name": "A String", # Name assigned to a table.
}
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.
Returns:
An object of the form:
{ # Represents a table. Specifies the name, whether it is exportable, description, attribution, and attribution link.
"kind": "fusiontables#table", # Type name: a template for an individual table.
"attribution": "A String", # Optional attribution assigned to the table.
"description": "A String", # Optional description assigned to the table.
"isExportable": True or False, # Variable for whether table is exportable.
"baseTableIds": [ # Optional base table identifier if this table is a view or merged table.
"A String",
],
"attributionLink": "A String", # Optional link for attribution.
"tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
"columns": [ # Columns in the table.
{ # Specifies the id, name and type of a column in a table.
"kind": "fusiontables#column", # Type name: a template for an individual column.
"type": "A String", # Required type of the column.
"columnId": 42, # Identifier for the column.
"name": "A String", # Required name of the column.
"baseColumn": { # Optional identifier of the base column. If present, this column is derived from the specified base column.
"tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
"columnId": 42, # The id of the column in the base table from which this column is derived.
},
},
],
"name": "A String", # Name assigned to a table.
}</pre>
</div>
</body></html>