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