| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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="area120tables_v1alpha1.html">Area120 Tables API</a> . <a href="area120tables_v1alpha1.tables.html">tables</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="area120tables_v1alpha1.tables.rows.html">rows()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the rows Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#close">close()</a></code></p> |
| 84 | <p class="firstline">Close httplib2 connections.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Gets a table. Returns NOT_FOUND if the table does not exist.</p> |
| 88 | <p class="toc_element"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 89 | <code><a href="#list">list(pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 90 | <p class="firstline">Lists tables for the user.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 93 | <p class="firstline">Retrieves the next page of results.</p> |
| 94 | <h3>Method Details</h3> |
| 95 | <div class="method"> |
| 96 | <code class="details" id="close">close()</code> |
| 97 | <pre>Close httplib2 connections.</pre> |
| 98 | </div> |
| 99 | |
| 100 | <div class="method"> |
| 101 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 102 | <pre>Gets a table. Returns NOT_FOUND if the table does not exist. |
| 103 | |
| 104 | Args: |
| 105 | name: string, Required. The name of the table to retrieve. Format: tables/{table} (required) |
| 106 | x__xgafv: string, V1 error format. |
| 107 | Allowed values |
| 108 | 1 - v1 error format |
| 109 | 2 - v2 error format |
| 110 | |
| 111 | Returns: |
| 112 | An object of the form: |
| 113 | |
| 114 | { # A single table. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 115 | "name": "A String", # The resource name of the table. Table names have the form `tables/{table}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 116 | "columns": [ # List of columns in this table. Order of columns matches the display order. |
| 117 | { # Details on a column in the table. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 118 | "dataType": "A String", # Data type of the column Supported types are auto_id, boolean, boolean_list, creator, create_timestamp, date, dropdown, location, integer, integer_list, number, number_list, person, person_list, tags, check_list, text, text_list, update_timestamp, updater, relationship, file_attachment_list. These types directly map to the column types supported on Tables website. |
| 119 | "relationshipDetails": { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship. |
| 120 | "linkedTable": "A String", # The name of the table this relationship is linked to. |
| 121 | }, |
| 122 | "name": "A String", # column name |
| 123 | "lookupDetails": { # Details about a lookup column whose value comes from the associated relationship. # Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column. |
| 124 | "relationshipColumn": "A String", # The name of the relationship column associated with the lookup. |
| 125 | "relationshipColumnId": "A String", # The id of the relationship column. |
| 126 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 127 | "labels": [ # Optional. Range of labeled values for the column. Some columns like tags and drop-downs limit the values to a set of possible values. We return the range of values in such cases to help clients implement better user data validation. |
| 128 | { # A single item in a labeled column. |
| 129 | "name": "A String", # Display string as entered by user. |
| 130 | "id": "A String", # Internal id associated with the item. |
| 131 | }, |
| 132 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 133 | "id": "A String", # Internal id for a column. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 134 | }, |
| 135 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 136 | "displayName": "A String", # The human readable title of the table. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 137 | }</pre> |
| 138 | </div> |
| 139 | |
| 140 | <div class="method"> |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 141 | <code class="details" id="list">list(pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 142 | <pre>Lists tables for the user. |
| 143 | |
| 144 | Args: |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 145 | pageToken: string, A page token, received from a previous `ListTables` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTables` must match the call that provided the page token. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 146 | pageSize: integer, The maximum number of tables to return. The service may return fewer than this value. If unspecified, at most 20 tables are returned. The maximum value is 100; values above 100 are coerced to 100. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 147 | x__xgafv: string, V1 error format. |
| 148 | Allowed values |
| 149 | 1 - v1 error format |
| 150 | 2 - v2 error format |
| 151 | |
| 152 | Returns: |
| 153 | An object of the form: |
| 154 | |
| 155 | { # Response message for TablesService.ListTables. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 156 | "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 157 | "tables": [ # The list of tables. |
| 158 | { # A single table. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 159 | "name": "A String", # The resource name of the table. Table names have the form `tables/{table}`. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 160 | "columns": [ # List of columns in this table. Order of columns matches the display order. |
| 161 | { # Details on a column in the table. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 162 | "dataType": "A String", # Data type of the column Supported types are auto_id, boolean, boolean_list, creator, create_timestamp, date, dropdown, location, integer, integer_list, number, number_list, person, person_list, tags, check_list, text, text_list, update_timestamp, updater, relationship, file_attachment_list. These types directly map to the column types supported on Tables website. |
| 163 | "relationshipDetails": { # Details about a relationship column. # Optional. Additional details about a relationship column. Specified when data_type is relationship. |
| 164 | "linkedTable": "A String", # The name of the table this relationship is linked to. |
| 165 | }, |
| 166 | "name": "A String", # column name |
| 167 | "lookupDetails": { # Details about a lookup column whose value comes from the associated relationship. # Optional. Indicates that this is a lookup column whose value is derived from the relationship column specified in the details. Lookup columns can not be updated directly. To change the value you must update the associated relationship column. |
| 168 | "relationshipColumn": "A String", # The name of the relationship column associated with the lookup. |
| 169 | "relationshipColumnId": "A String", # The id of the relationship column. |
| 170 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 171 | "labels": [ # Optional. Range of labeled values for the column. Some columns like tags and drop-downs limit the values to a set of possible values. We return the range of values in such cases to help clients implement better user data validation. |
| 172 | { # A single item in a labeled column. |
| 173 | "name": "A String", # Display string as entered by user. |
| 174 | "id": "A String", # Internal id associated with the item. |
| 175 | }, |
| 176 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 177 | "id": "A String", # Internal id for a column. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 178 | }, |
| 179 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame^] | 180 | "displayName": "A String", # The human readable title of the table. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 181 | }, |
| 182 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 183 | }</pre> |
| 184 | </div> |
| 185 | |
| 186 | <div class="method"> |
| 187 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 188 | <pre>Retrieves the next page of results. |
| 189 | |
| 190 | Args: |
| 191 | previous_request: The request for the previous page. (required) |
| 192 | previous_response: The response from the request for the previous page. (required) |
| 193 | |
| 194 | Returns: |
| 195 | A request object that you can call 'execute()' on to request the next |
| 196 | page. Returns None if there are no more items in the collection. |
| 197 | </pre> |
| 198 | </div> |
| 199 | |
| 200 | </body></html> |