Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / fusiontables_v2.table.html
blob: 5133a077de875cbb1682b08665b73c2a00b71009 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[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_v2.html">Fusion Tables API</a> . <a href="fusiontables_v2.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>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]85<p class="firstline">Retrieves a specific table by its ID.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]86<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]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>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]88<p class="firstline">Imports more rows into a table.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]89<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]90 <code><a href="#importTable">importTable(name, media_body=None, encoding=None, delimiter=None, media_mime_type=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]91<p class="firstline">Imports a new table.</p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]105 <code><a href="#refetchSheet">refetchSheet(tableId)</a></code></p>
106<p class="firstline">Replaces rows of the table with the rows of the spreadsheet that is first imported from. Current rows remain visible until all replacement rows are ready.</p>
107<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]108 <code><a href="#replaceRows">replaceRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, media_mime_type=None, delimiter=None, endLine=None)</a></code></p>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]109<p class="firstline">Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready.</p>
110<p class="toc_element">
111 <code><a href="#update">update(tableId, body, replaceViewDefinition=None)</a></code></p>
112<p class="firstline">Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.</p>
113<h3>Method Details</h3>
114<div class="method">
115 <code class="details" id="copy">copy(tableId, copyPresentation=None)</code>
116 <pre>Copies a table.
117
118Args:
119 tableId: string, ID of the table that is being copied. (required)
120 copyPresentation: boolean, Whether to also copy tabs, styles, and templates. Default is false.
121
122Returns:
123 An object of the form:
124
125 { # Represents a table.
126 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]127 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]128 "attribution": "A String", # Attribution assigned to the table.
129 "description": "A String", # Description assigned to the table.
130 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
131 "isExportable": True or False, # Variable for whether table is exportable.
132 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
133 "A String",
134 ],
135 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
136 "attributionLink": "A String", # Optional link for attribution.
137 "sql": "A String", # SQL that encodes the table definition for derived tables.
138 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
139 "columns": [ # Columns in the table.
140 { # Specifies the details of a column in a table.
141 "graphPredicate": "A String", # Column graph predicate.
142 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]143 # See W3C Graph-based Data Model.
144 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]145 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
146 "A String",
147 ],
148 "description": "A String", # Column description.
149 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
150 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
151 "columnId": 42, # The id of the column in the base table from which this column is derived.
152 },
153 "name": "A String", # Name of the column.
154 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
155 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]156 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]157 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
158 "type": "A String", # Type of the column.
159 "validateData": True or False, # If true, data entered via the web application is validated.
160 "columnId": 42, # Identifier for the column.
161 },
162 ],
163 "name": "A String", # Name assigned to a table.
164 }</pre>
165</div>
166
167<div class="method">
168 <code class="details" id="delete">delete(tableId)</code>
169 <pre>Deletes a table.
170
171Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]172 tableId: string, ID of the table to be deleted. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]173</pre>
174</div>
175
176<div class="method">
177 <code class="details" id="get">get(tableId)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]178 <pre>Retrieves a specific table by its ID.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]179
180Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]181 tableId: string, Identifier for the table being requested. (required)
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]182
183Returns:
184 An object of the form:
185
186 { # Represents a table.
187 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]188 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]189 "attribution": "A String", # Attribution assigned to the table.
190 "description": "A String", # Description assigned to the table.
191 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
192 "isExportable": True or False, # Variable for whether table is exportable.
193 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
194 "A String",
195 ],
196 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
197 "attributionLink": "A String", # Optional link for attribution.
198 "sql": "A String", # SQL that encodes the table definition for derived tables.
199 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
200 "columns": [ # Columns in the table.
201 { # Specifies the details of a column in a table.
202 "graphPredicate": "A String", # Column graph predicate.
203 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]204 # See W3C Graph-based Data Model.
205 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]206 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
207 "A String",
208 ],
209 "description": "A String", # Column description.
210 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
211 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
212 "columnId": 42, # The id of the column in the base table from which this column is derived.
213 },
214 "name": "A String", # Name of the column.
215 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
216 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]217 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]218 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
219 "type": "A String", # Type of the column.
220 "validateData": True or False, # If true, data entered via the web application is validated.
221 "columnId": 42, # Identifier for the column.
222 },
223 ],
224 "name": "A String", # Name assigned to a table.
225 }</pre>
226</div>
227
228<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]229 <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>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]230 <pre>Imports more rows into a table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]231
232Args:
233 tableId: string, The table into which new rows are being imported. (required)
234 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
235 startLine: integer, The index of the first line from which to start importing, inclusive. Default is 0.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]236 isStrict: boolean, Whether the imported 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.
237 encoding: string, The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]238 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]239 delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ,.
240 endLine: integer, The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]241
242Returns:
243 An object of the form:
244
245 { # Represents an import request.
246 "numRowsReceived": "A String", # The number of rows received from the import request.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]247 "kind": "fusiontables#import", # The kind of item this is. For an import, this is always fusiontables#import.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]248 }</pre>
249</div>
250
251<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]252 <code class="details" id="importTable">importTable(name, media_body=None, encoding=None, delimiter=None, media_mime_type=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]253 <pre>Imports a new table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]254
255Args:
256 name: string, The name to be assigned to the new table. (required)
257 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]258 encoding: string, The encoding of the content. Default is UTF-8. Use auto-detect if you are unsure of the encoding.
259 delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ,.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]260 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]261
262Returns:
263 An object of the form:
264
265 { # Represents a table.
266 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]267 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]268 "attribution": "A String", # Attribution assigned to the table.
269 "description": "A String", # Description assigned to the table.
270 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
271 "isExportable": True or False, # Variable for whether table is exportable.
272 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
273 "A String",
274 ],
275 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
276 "attributionLink": "A String", # Optional link for attribution.
277 "sql": "A String", # SQL that encodes the table definition for derived tables.
278 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
279 "columns": [ # Columns in the table.
280 { # Specifies the details of a column in a table.
281 "graphPredicate": "A String", # Column graph predicate.
282 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]283 # See W3C Graph-based Data Model.
284 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]285 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
286 "A String",
287 ],
288 "description": "A String", # Column description.
289 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
290 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
291 "columnId": 42, # The id of the column in the base table from which this column is derived.
292 },
293 "name": "A String", # Name of the column.
294 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
295 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]296 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]297 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
298 "type": "A String", # Type of the column.
299 "validateData": True or False, # If true, data entered via the web application is validated.
300 "columnId": 42, # Identifier for the column.
301 },
302 ],
303 "name": "A String", # Name assigned to a table.
304 }</pre>
305</div>
306
307<div class="method">
308 <code class="details" id="insert">insert(body)</code>
309 <pre>Creates a new table.
310
311Args:
312 body: object, The request body. (required)
313 The object takes the form of:
314
315{ # Represents a table.
316 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]317 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]318 "attribution": "A String", # Attribution assigned to the table.
319 "description": "A String", # Description assigned to the table.
320 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
321 "isExportable": True or False, # Variable for whether table is exportable.
322 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
323 "A String",
324 ],
325 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
326 "attributionLink": "A String", # Optional link for attribution.
327 "sql": "A String", # SQL that encodes the table definition for derived tables.
328 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
329 "columns": [ # Columns in the table.
330 { # Specifies the details of a column in a table.
331 "graphPredicate": "A String", # Column graph predicate.
332 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]333 # See W3C Graph-based Data Model.
334 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]335 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
336 "A String",
337 ],
338 "description": "A String", # Column description.
339 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
340 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
341 "columnId": 42, # The id of the column in the base table from which this column is derived.
342 },
343 "name": "A String", # Name of the column.
344 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
345 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]346 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]347 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
348 "type": "A String", # Type of the column.
349 "validateData": True or False, # If true, data entered via the web application is validated.
350 "columnId": 42, # Identifier for the column.
351 },
352 ],
353 "name": "A String", # Name assigned to a table.
354 }
355
356
357Returns:
358 An object of the form:
359
360 { # Represents a table.
361 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]362 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]363 "attribution": "A String", # Attribution assigned to the table.
364 "description": "A String", # Description assigned to the table.
365 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
366 "isExportable": True or False, # Variable for whether table is exportable.
367 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
368 "A String",
369 ],
370 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
371 "attributionLink": "A String", # Optional link for attribution.
372 "sql": "A String", # SQL that encodes the table definition for derived tables.
373 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
374 "columns": [ # Columns in the table.
375 { # Specifies the details of a column in a table.
376 "graphPredicate": "A String", # Column graph predicate.
377 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]378 # See W3C Graph-based Data Model.
379 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]380 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
381 "A String",
382 ],
383 "description": "A String", # Column description.
384 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
385 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
386 "columnId": 42, # The id of the column in the base table from which this column is derived.
387 },
388 "name": "A String", # Name of the column.
389 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
390 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]391 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]392 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
393 "type": "A String", # Type of the column.
394 "validateData": True or False, # If true, data entered via the web application is validated.
395 "columnId": 42, # Identifier for the column.
396 },
397 ],
398 "name": "A String", # Name assigned to a table.
399 }</pre>
400</div>
401
402<div class="method">
403 <code class="details" id="list">list(pageToken=None, maxResults=None)</code>
404 <pre>Retrieves a list of tables a user owns.
405
406Args:
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]407 pageToken: string, Continuation token specifying which result page to return.
408 maxResults: integer, Maximum number of tables to return. Default is 5.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]409
410Returns:
411 An object of the form:
412
413 { # Represents a list of tables.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]414 "nextPageToken": "A String", # Token used to access the next page of this result. No token is displayed if there are no more pages left.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]415 "items": [ # List of all requested tables.
416 { # Represents a table.
417 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]418 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]419 "attribution": "A String", # Attribution assigned to the table.
420 "description": "A String", # Description assigned to the table.
421 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
422 "isExportable": True or False, # Variable for whether table is exportable.
423 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
424 "A String",
425 ],
426 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
427 "attributionLink": "A String", # Optional link for attribution.
428 "sql": "A String", # SQL that encodes the table definition for derived tables.
429 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
430 "columns": [ # Columns in the table.
431 { # Specifies the details of a column in a table.
432 "graphPredicate": "A String", # Column graph predicate.
433 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]434 # See W3C Graph-based Data Model.
435 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]436 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
437 "A String",
438 ],
439 "description": "A String", # Column description.
440 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
441 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
442 "columnId": 42, # The id of the column in the base table from which this column is derived.
443 },
444 "name": "A String", # Name of the column.
445 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
446 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]447 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]448 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
449 "type": "A String", # Type of the column.
450 "validateData": True or False, # If true, data entered via the web application is validated.
451 "columnId": 42, # Identifier for the column.
452 },
453 ],
454 "name": "A String", # Name assigned to a table.
455 },
456 ],
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]457 "kind": "fusiontables#tableList", # The kind of item this is. For table list, this is always fusiontables#tableList.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]458 }</pre>
459</div>
460
461<div class="method">
462 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
463 <pre>Retrieves the next page of results.
464
465Args:
466 previous_request: The request for the previous page. (required)
467 previous_response: The response from the request for the previous page. (required)
468
469Returns:
470 A request object that you can call 'execute()' on to request the next
471 page. Returns None if there are no more items in the collection.
472 </pre>
473</div>
474
475<div class="method">
476 <code class="details" id="patch">patch(tableId, body, replaceViewDefinition=None)</code>
477 <pre>Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics.
478
479Args:
480 tableId: string, ID of the table that is being updated. (required)
481 body: object, The request body. (required)
482 The object takes the form of:
483
484{ # Represents a table.
485 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]486 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]487 "attribution": "A String", # Attribution assigned to the table.
488 "description": "A String", # Description assigned to the table.
489 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
490 "isExportable": True or False, # Variable for whether table is exportable.
491 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
492 "A String",
493 ],
494 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
495 "attributionLink": "A String", # Optional link for attribution.
496 "sql": "A String", # SQL that encodes the table definition for derived tables.
497 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
498 "columns": [ # Columns in the table.
499 { # Specifies the details of a column in a table.
500 "graphPredicate": "A String", # Column graph predicate.
501 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]502 # See W3C Graph-based Data Model.
503 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]504 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
505 "A String",
506 ],
507 "description": "A String", # Column description.
508 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
509 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
510 "columnId": 42, # The id of the column in the base table from which this column is derived.
511 },
512 "name": "A String", # Name of the column.
513 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
514 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]515 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]516 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
517 "type": "A String", # Type of the column.
518 "validateData": True or False, # If true, data entered via the web application is validated.
519 "columnId": 42, # Identifier for the column.
520 },
521 ],
522 "name": "A String", # Name assigned to a table.
523 }
524
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]525 replaceViewDefinition: boolean, Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]526
527Returns:
528 An object of the form:
529
530 { # Represents a table.
531 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]532 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]533 "attribution": "A String", # Attribution assigned to the table.
534 "description": "A String", # Description assigned to the table.
535 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
536 "isExportable": True or False, # Variable for whether table is exportable.
537 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
538 "A String",
539 ],
540 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
541 "attributionLink": "A String", # Optional link for attribution.
542 "sql": "A String", # SQL that encodes the table definition for derived tables.
543 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
544 "columns": [ # Columns in the table.
545 { # Specifies the details of a column in a table.
546 "graphPredicate": "A String", # Column graph predicate.
547 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]548 # See W3C Graph-based Data Model.
549 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]550 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
551 "A String",
552 ],
553 "description": "A String", # Column description.
554 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
555 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
556 "columnId": 42, # The id of the column in the base table from which this column is derived.
557 },
558 "name": "A String", # Name of the column.
559 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
560 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]561 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]562 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
563 "type": "A String", # Type of the column.
564 "validateData": True or False, # If true, data entered via the web application is validated.
565 "columnId": 42, # Identifier for the column.
566 },
567 ],
568 "name": "A String", # Name assigned to a table.
569 }</pre>
570</div>
571
572<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]573 <code class="details" id="refetchSheet">refetchSheet(tableId)</code>
574 <pre>Replaces rows of the table with the rows of the spreadsheet that is first imported from. Current rows remain visible until all replacement rows are ready.
575
576Args:
577 tableId: string, Table whose rows will be replaced from the spreadsheet. (required)
578
579Returns:
580 An object of the form:
581
582 { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
583 "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
584 "progress": "A String", # Task percentage completion.
585 "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
586 "type": "A String", # Type of background task.
587 "taskId": "A String", # Identifier for the task.
588 }</pre>
589</div>
590
591<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]592 <code class="details" id="replaceRows">replaceRows(tableId, media_body=None, startLine=None, isStrict=None, encoding=None, media_mime_type=None, delimiter=None, endLine=None)</code>
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]593 <pre>Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready.
594
595Args:
596 tableId: string, Table whose rows will be replaced. (required)
597 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
598 startLine: integer, The index of the first line from which to start importing, inclusive. Default is 0.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]599 isStrict: boolean, Whether the imported CSV must have the same number of column values for each row. If true, throws an exception if the CSV does not have the same number of columns. If false, rows with fewer column values will be padded with empty values. Default is true.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]600 encoding: string, The encoding of the content. Default is UTF-8. Use 'auto-detect' if you are unsure of the encoding.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]601 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]602 delimiter: string, The delimiter used to separate cell values. This can only consist of a single character. Default is ,.
603 endLine: integer, The index of the line up to which data will be imported. Default is to import the entire file. If endLine is negative, it is an offset from the end of the file; the imported content will exclude the last endLine lines.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]604
605Returns:
606 An object of the form:
607
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]608 { # A background task on a table, initiated for time- or resource-consuming operations such as changing column types or deleting all rows.
609 "started": True or False, # false while the table is busy with some other task. true if this background task is currently running.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]610 "progress": "A String", # Task percentage completion.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]611 "kind": "fusiontables#task", # Type of the resource. This is always "fusiontables#task".
612 "type": "A String", # Type of background task.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]613 "taskId": "A String", # Identifier for the task.
614 }</pre>
615</div>
616
617<div class="method">
618 <code class="details" id="update">update(tableId, body, replaceViewDefinition=None)</code>
619 <pre>Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.
620
621Args:
622 tableId: string, ID of the table that is being updated. (required)
623 body: object, The request body. (required)
624 The object takes the form of:
625
626{ # Represents a table.
627 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]628 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]629 "attribution": "A String", # Attribution assigned to the table.
630 "description": "A String", # Description assigned to the table.
631 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
632 "isExportable": True or False, # Variable for whether table is exportable.
633 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
634 "A String",
635 ],
636 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
637 "attributionLink": "A String", # Optional link for attribution.
638 "sql": "A String", # SQL that encodes the table definition for derived tables.
639 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
640 "columns": [ # Columns in the table.
641 { # Specifies the details of a column in a table.
642 "graphPredicate": "A String", # Column graph predicate.
643 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]644 # See W3C Graph-based Data Model.
645 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]646 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
647 "A String",
648 ],
649 "description": "A String", # Column description.
650 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
651 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
652 "columnId": 42, # The id of the column in the base table from which this column is derived.
653 },
654 "name": "A String", # Name of the column.
655 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
656 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]657 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]658 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
659 "type": "A String", # Type of the column.
660 "validateData": True or False, # If true, data entered via the web application is validated.
661 "columnId": 42, # Identifier for the column.
662 },
663 ],
664 "name": "A String", # Name assigned to a table.
665 }
666
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]667 replaceViewDefinition: boolean, Whether the view definition is also updated. The specified view definition replaces the existing one. Only a view can be updated with a new definition.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]668
669Returns:
670 An object of the form:
671
672 { # Represents a table.
673 "tablePropertiesJsonSchema": "A String", # JSON schema for validating the JSON table properties.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]674 "kind": "fusiontables#table", # The kind of item this is. For a table, this is always fusiontables#table.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]675 "attribution": "A String", # Attribution assigned to the table.
676 "description": "A String", # Description assigned to the table.
677 "columnPropertiesJsonSchema": "A String", # Default JSON schema for validating all JSON column properties.
678 "isExportable": True or False, # Variable for whether table is exportable.
679 "baseTableIds": [ # Base table identifier if this table is a view or merged table.
680 "A String",
681 ],
682 "tablePropertiesJson": "A String", # JSON object containing custom table properties.
683 "attributionLink": "A String", # Optional link for attribution.
684 "sql": "A String", # SQL that encodes the table definition for derived tables.
685 "tableId": "A String", # Encrypted unique alphanumeric identifier for the table.
686 "columns": [ # Columns in the table.
687 { # Specifies the details of a column in a table.
688 "graphPredicate": "A String", # Column graph predicate.
689 # Used to map table to graph data model (subject,predicate,object)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]690 # See W3C Graph-based Data Model.
691 "kind": "fusiontables#column", # The kind of item this is. For a column, this is always fusiontables#column.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]692 "validValues": [ # List of valid values used to validate data and supply a drop-down list of values in the web application.
693 "A String",
694 ],
695 "description": "A String", # Column description.
696 "baseColumn": { # Identifier of the base column. If present, this column is derived from the specified base column.
697 "tableIndex": 42, # Offset to the entry in the list of base tables in the table definition.
698 "columnId": 42, # The id of the column in the base table from which this column is derived.
699 },
700 "name": "A String", # Name of the column.
701 "columnPropertiesJson": "A String", # JSON object containing custom column properties.
702 "formatPattern": "A String", # Format pattern.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]703 # Acceptable values are DT_DATE_MEDIUMe.g Dec 24, 2008 DT_DATE_SHORTfor example 12/24/08 DT_DATE_TIME_MEDIUMfor example Dec 24, 2008 8:30:45 PM DT_DATE_TIME_SHORTfor example 12/24/08 8:30 PM DT_DAY_MONTH_2_DIGIT_YEARfor example 24/12/08 DT_DAY_MONTH_2_DIGIT_YEAR_TIMEfor example 24/12/08 20:30 DT_DAY_MONTH_2_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/08 8:30 PM DT_DAY_MONTH_4_DIGIT_YEARfor example 24/12/2008 DT_DAY_MONTH_4_DIGIT_YEAR_TIMEfor example 24/12/2008 20:30 DT_DAY_MONTH_4_DIGIT_YEAR_TIME_MERIDIANfor example 24/12/2008 8:30 PM DT_ISO_YEAR_MONTH_DAYfor example 2008-12-24 DT_ISO_YEAR_MONTH_DAY_TIMEfor example 2008-12-24 20:30:45 DT_MONTH_DAY_4_DIGIT_YEARfor example 12/24/2008 DT_TIME_LONGfor example 8:30:45 PM UTC-6 DT_TIME_MEDIUMfor example 8:30:45 PM DT_TIME_SHORTfor example 8:30 PM DT_YEAR_ONLYfor example 2008 HIGHLIGHT_UNTYPED_CELLSHighlight cell data that does not match the data type NONENo formatting (default) NUMBER_CURRENCYfor example $1234.56 NUMBER_DEFAULTfor example 1,234.56 NUMBER_INTEGERfor example 1235 NUMBER_NO_SEPARATORfor example 1234.56 NUMBER_PERCENTfor example 123,456% NUMBER_SCIENTIFICfor example 1E3 STRING_EIGHT_LINE_IMAGEDisplays thumbnail images as tall as eight lines of text STRING_FOUR_LINE_IMAGEDisplays thumbnail images as tall as four lines of text STRING_JSON_TEXTAllows editing of text as JSON in UI STRING_JSON_LISTAllows editing of text as a JSON list in UI STRING_LINKTreats cell as a link (must start with http:// or https://) STRING_ONE_LINE_IMAGEDisplays thumbnail images as tall as one line of text STRING_VIDEO_OR_MAPDisplay a video or map thumbnail
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]704 "columnJsonSchema": "A String", # JSON schema for interpreting JSON in this column.
705 "type": "A String", # Type of the column.
706 "validateData": True or False, # If true, data entered via the web application is validated.
707 "columnId": 42, # Identifier for the column.
708 },
709 ],
710 "name": "A String", # Name assigned to a table.
711 }</pre>
712</div>
713
714</body></html>