Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
joshourisman
joshourisman / gdata python
Repository URL to install this package:
|
Version:
2.0.18 ▾
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module gdata.spreadsheets.client</title>
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="gdata.html"><font color="#ffffff">gdata</font></a>.<a href="gdata.spreadsheets.html"><font color="#ffffff">spreadsheets</font></a>.client</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/spreadsheets/client.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/spreadsheets/client.py</a></font></td></tr></table>
<p><tt>Contains a client to communicate with the Google Spreadsheets servers.<br>
<br>
For documentation on the Spreadsheets API, see:<br>
<a href="http://code.google.com/apis/spreadsheets/">http://code.google.com/apis/spreadsheets/</a></tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="atom.html">atom</a><br>
</td><td width="25%" valign=top><a href="gdata.html">gdata</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="gdata.client.html#GDClient">gdata.client.GDClient</a>(<a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.spreadsheets.client.html#SpreadsheetsClient">SpreadsheetsClient</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.client.html#Query">gdata.client.Query</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.spreadsheets.client.html#CellQuery">CellQuery</a>
</font></dt><dt><font face="helvetica, arial"><a href="gdata.spreadsheets.client.html#ListQuery">ListQuery</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.spreadsheets.client.html#TableQuery">TableQuery</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="gdata.spreadsheets.client.html#SpreadsheetQuery">SpreadsheetQuery</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="gdata.spreadsheets.client.html#WorksheetQuery">WorksheetQuery</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="CellQuery">class <strong>CellQuery</strong></a>(<a href="gdata.client.html#Query">gdata.client.Query</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.spreadsheets.client.html#CellQuery">CellQuery</a></dd>
<dd><a href="gdata.client.html#Query">gdata.client.Query</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="CellQuery-ModifyRequest"><strong>ModifyRequest</strong></a> = <a href="#CellQuery-modify_request">modify_request</a>(self, http_request)</dt></dl>
<dl><dt><a name="CellQuery-__init__"><strong>__init__</strong></a>(self, min_row<font color="#909090">=None</font>, max_row<font color="#909090">=None</font>, min_col<font color="#909090">=None</font>, max_col<font color="#909090">=None</font>, range<font color="#909090">=None</font>, return_empty<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Adds Cells-feed specific query parameters to a request.<br>
<br>
Args:<br>
min_row: str or int Positional number of minimum row returned in query.<br>
max_row: str or int Positional number of maximum row returned in query.<br>
min_col: str or int Positional number of minimum column returned in query.<br>
max_col: str or int Positional number of maximum column returned in query.<br>
range: str A single cell or a range of cells. Use standard spreadsheet<br>
cell-range notations, using a colon to separate start and end of<br>
range. Examples:<br>
- 'A1' and 'R1C1' both specify only cell A1.<br>
- 'D1:F3' and 'R1C4:R3C6' both specify the rectangle of cells with<br>
corners at D1 and F3.<br>
return_empty: str If 'true' then empty cells will be returned in the feed.<br>
If omitted, the default is 'false'.</tt></dd></dl>
<dl><dt><a name="CellQuery-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt></dl>
<hr>
Methods inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><a name="CellQuery-AddCustomParameter"><strong>AddCustomParameter</strong></a> = add_custom_parameter(self, key, value)</dt></dl>
<dl><dt><a name="CellQuery-add_custom_parameter"><strong>add_custom_parameter</strong></a>(self, key, value)</dt></dl>
<hr>
Data descriptors inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="ListQuery">class <strong>ListQuery</strong></a>(<a href="gdata.client.html#Query">gdata.client.Query</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.spreadsheets.client.html#ListQuery">ListQuery</a></dd>
<dd><a href="gdata.client.html#Query">gdata.client.Query</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="ListQuery-ModifyRequest"><strong>ModifyRequest</strong></a> = <a href="#ListQuery-modify_request">modify_request</a>(self, http_request)</dt></dl>
<dl><dt><a name="ListQuery-__init__"><strong>__init__</strong></a>(self, order_by<font color="#909090">=None</font>, reverse<font color="#909090">=None</font>, sq<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Adds List-feed specific query parameters to a request.<br>
<br>
Args:<br>
order_by: str Specifies what column to use in ordering the entries in<br>
the feed. By position (the default): 'position' returns<br>
rows in the order in which they appear in the GUI. Row 1, then<br>
row 2, then row 3, and so on. By column:<br>
'column:columnName' sorts rows in ascending order based on the<br>
values in the column with the given columnName, where<br>
columnName is the value in the header row for that column.<br>
reverse: str Specifies whether to sort in descending or ascending order.<br>
Reverses default sort order: 'true' results in a descending<br>
sort; 'false' (the default) results in an ascending sort.<br>
sq: str Structured query on the full text in the worksheet.<br>
[columnName][binaryOperator][value]<br>
Supported binaryOperators are:<br>
- (), for overriding order of operations<br>
- = or ==, for strict equality<br>
- <> or !=, for strict inequality<br>
- and or &&, for boolean and<br>
- or or ||, for boolean or</tt></dd></dl>
<dl><dt><a name="ListQuery-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt></dl>
<hr>
Methods inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><a name="ListQuery-AddCustomParameter"><strong>AddCustomParameter</strong></a> = add_custom_parameter(self, key, value)</dt></dl>
<dl><dt><a name="ListQuery-add_custom_parameter"><strong>add_custom_parameter</strong></a>(self, key, value)</dt></dl>
<hr>
Data descriptors inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="SpreadsheetQuery">class <strong>SpreadsheetQuery</strong></a>(<a href="gdata.client.html#Query">gdata.client.Query</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.spreadsheets.client.html#SpreadsheetQuery">SpreadsheetQuery</a></dd>
<dd><a href="gdata.client.html#Query">gdata.client.Query</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="SpreadsheetQuery-ModifyRequest"><strong>ModifyRequest</strong></a> = <a href="#SpreadsheetQuery-modify_request">modify_request</a>(self, http_request)</dt></dl>
<dl><dt><a name="SpreadsheetQuery-__init__"><strong>__init__</strong></a>(self, title<font color="#909090">=None</font>, title_exact<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Adds Spreadsheets feed query parameters to a request.<br>
<br>
Args:<br>
title: str Specifies the search terms for the title of a document.<br>
This parameter used without title-exact will only submit partial<br>
queries, not exact queries.<br>
title_exact: str Specifies whether the title query should be taken as an<br>
exact string. Meaningless without title. Possible values are<br>
'true' and 'false'.</tt></dd></dl>
<dl><dt><a name="SpreadsheetQuery-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt></dl>
<hr>
Methods inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><a name="SpreadsheetQuery-AddCustomParameter"><strong>AddCustomParameter</strong></a> = add_custom_parameter(self, key, value)</dt></dl>
<dl><dt><a name="SpreadsheetQuery-add_custom_parameter"><strong>add_custom_parameter</strong></a>(self, key, value)</dt></dl>
<hr>
Data descriptors inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="SpreadsheetsClient">class <strong>SpreadsheetsClient</strong></a>(<a href="gdata.client.html#GDClient">gdata.client.GDClient</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.spreadsheets.client.html#SpreadsheetsClient">SpreadsheetsClient</a></dd>
<dd><a href="gdata.client.html#GDClient">gdata.client.GDClient</a></dd>
<dd><a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="SpreadsheetsClient-AddListEntry"><strong>AddListEntry</strong></a> = <a href="#SpreadsheetsClient-add_list_entry">add_list_entry</a>(self, list_entry, spreadsheet_key, worksheet_id, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-AddRecord"><strong>AddRecord</strong></a> = <a href="#SpreadsheetsClient-add_record">add_record</a>(self, spreadsheet_key, table_id, fields, title<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-AddTable"><strong>AddTable</strong></a> = <a href="#SpreadsheetsClient-add_table">add_table</a>(self, spreadsheet_key, title, summary, worksheet_name, header_row, num_rows, start_row, insertion_mode, column_headers, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-AddWorksheet"><strong>AddWorksheet</strong></a> = <a href="#SpreadsheetsClient-add_worksheet">add_worksheet</a>(self, spreadsheet_key, title, rows, cols, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetCell"><strong>GetCell</strong></a> = <a href="#SpreadsheetsClient-get_cell">get_cell</a>(self, spreadsheet_key, worksheet_id, row_num, col_num, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.CellEntry'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetCells"><strong>GetCells</strong></a> = <a href="#SpreadsheetsClient-get_cells">get_cells</a>(self, spreadsheet_key, worksheet_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.CellsFeed'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetListFeed"><strong>GetListFeed</strong></a> = <a href="#SpreadsheetsClient-get_list_feed">get_list_feed</a>(self, spreadsheet_key, worksheet_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.ListsFeed'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetRecord"><strong>GetRecord</strong></a> = <a href="#SpreadsheetsClient-get_record">get_record</a>(self, spreadsheet_key, table_id, record_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.Record'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetRecords"><strong>GetRecords</strong></a> = <a href="#SpreadsheetsClient-get_records">get_records</a>(self, spreadsheet_key, table_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.RecordsFeed'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetSpreadsheets"><strong>GetSpreadsheets</strong></a> = <a href="#SpreadsheetsClient-get_spreadsheets">get_spreadsheets</a>(self, auth_token<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.SpreadsheetsFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetTables"><strong>GetTables</strong></a> = <a href="#SpreadsheetsClient-get_tables">get_tables</a>(self, spreadsheet_key, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.TablesFeed'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetWorksheet"><strong>GetWorksheet</strong></a> = <a href="#SpreadsheetsClient-get_worksheet">get_worksheet</a>(self, spreadsheet_key, worksheet_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.WorksheetEntry'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetWorksheets"><strong>GetWorksheets</strong></a> = <a href="#SpreadsheetsClient-get_worksheets">get_worksheets</a>(self, spreadsheet_key, auth_token<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.WorksheetsFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-add_list_entry"><strong>add_list_entry</strong></a>(self, list_entry, spreadsheet_key, worksheet_id, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Adds a new row to the worksheet's list feed.<br>
<br>
Args:<br>
list_entry: gdata.spreadsheets.data.ListsEntry An entry which contains<br>
the values which should be set for the columns in this<br>
record.<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
worksheet_id: str, The unique ID of the worksheet in this spreadsheet<br>
whose cells we want. This can be obtained using<br>
WorksheetEntry's get_worksheet_id method.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-add_record"><strong>add_record</strong></a>(self, spreadsheet_key, table_id, fields, title<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Adds a new row to the table.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
table_id: str, The ID of the table within the worksheet which should<br>
receive this new record. The table ID can be found using the<br>
get_table_id method of a gdata.spreadsheets.data.Table.<br>
fields: dict of strings mapping column names to values.<br>
title: str, optional The title for this row.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-add_table"><strong>add_table</strong></a>(self, spreadsheet_key, title, summary, worksheet_name, header_row, num_rows, start_row, insertion_mode, column_headers, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a new table within the worksheet.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
title: str, The title for the new table within a worksheet.<br>
summary: str, A description of the table.<br>
worksheet_name: str The name of the worksheet in which this table<br>
should live.<br>
header_row: int or str, The number of the row in the worksheet which<br>
will contain the column names for the data in this table.<br>
num_rows: int or str, The number of adjacent rows in this table.<br>
start_row: int or str, The number of the row at which the data begins.<br>
insertion_mode: str<br>
column_headers: dict of strings, maps the column letters (A, B, C) to<br>
the desired name which will be viewable in the<br>
worksheet.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-add_worksheet"><strong>add_worksheet</strong></a>(self, spreadsheet_key, title, rows, cols, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a new worksheet entry in the spreadsheet.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
title: str, The title to be used in for the worksheet.<br>
rows: str or int, The number of rows this worksheet should start with.<br>
cols: str or int, The number of columns this worksheet should start with.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_cell"><strong>get_cell</strong></a>(self, spreadsheet_key, worksheet_id, row_num, col_num, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.CellEntry'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves a single cell from the worksheet.<br>
<br>
Indexes are 1 based so the first cell in the worksheet is 1, 1.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
worksheet_id: str, The unique ID of the worksheet in this spreadsheet<br>
whose cells we want. This can be obtained using<br>
WorksheetEntry's get_worksheet_id method.<br>
row_num: int, The row of the cell that we want. Numbering starts with 1.<br>
col_num: int, The column of the cell we want. Numbering starts with 1.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned. Defaults to<br>
gdata.spreadsheets.data.CellEntry.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_cells"><strong>get_cells</strong></a>(self, spreadsheet_key, worksheet_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.CellsFeed'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves the cells which have values in this spreadsheet.<br>
<br>
Blank cells are not included.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
worksheet_id: str, The unique ID of the worksheet in this spreadsheet<br>
whose cells we want. This can be obtained using<br>
WorksheetEntry's get_worksheet_id method.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned. Defaults to<br>
gdata.spreadsheets.data.CellsFeed.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_list_feed"><strong>get_list_feed</strong></a>(self, spreadsheet_key, worksheet_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.ListsFeed'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves the value rows from the worksheet's list feed.<br>
<br>
The list feed is a view of the spreadsheet in which the first row is used<br>
for column names and subsequent rows up to the first blank line are<br>
records.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
worksheet_id: str, The unique ID of the worksheet in this spreadsheet<br>
whose cells we want. This can be obtained using<br>
WorksheetEntry's get_worksheet_id method.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned. Defaults to<br>
gdata.spreadsheets.data.ListsFeed.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_record"><strong>get_record</strong></a>(self, spreadsheet_key, table_id, record_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.Record'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves a single record from the table.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
table_id: str, The ID of the table within the worksheet whose records<br>
we would like to fetch. The table ID can be found using the<br>
get_table_id method of a gdata.spreadsheets.data.Table.<br>
record_id: str, The ID of the record within this table which we want to<br>
fetch. You can find the record ID using get_record_id() on<br>
an instance of the gdata.spreadsheets.data.Record class.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned. Defaults to<br>
gdata.spreadsheets.data.RecordsFeed.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_records"><strong>get_records</strong></a>(self, spreadsheet_key, table_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.RecordsFeed'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves the records in a table.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
table_id: str, The ID of the table within the worksheet whose records<br>
we would like to fetch. The table ID can be found using the<br>
get_table_id method of a gdata.spreadsheets.data.Table.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned. Defaults to<br>
gdata.spreadsheets.data.RecordsFeed.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_spreadsheets"><strong>get_spreadsheets</strong></a>(self, auth_token<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.SpreadsheetsFeed'></font>, **kwargs)</dt><dd><tt>Obtains a feed with the spreadsheets belonging to the current user.<br>
<br>
Args:<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned. Defaults to<br>
gdata.spreadsheets.data.SpreadsheetsFeed.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_tables"><strong>get_tables</strong></a>(self, spreadsheet_key, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.TablesFeed'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves a feed listing the tables in this spreadsheet.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned. Defaults to<br>
gdata.spreadsheets.data.TablesFeed.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_worksheet"><strong>get_worksheet</strong></a>(self, spreadsheet_key, worksheet_id, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.WorksheetEntry'></font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Retrieves a single worksheet.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
worksheet_id: str, The unique ID for the worksheet withing the desired<br>
spreadsheet.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned. Defaults to<br>
gdata.spreadsheets.data.WorksheetEntry.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_worksheets"><strong>get_worksheets</strong></a>(self, spreadsheet_key, auth_token<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.spreadsheets.data.WorksheetsFeed'></font>, **kwargs)</dt><dd><tt>Finds the worksheets within a given spreadsheet.<br>
<br>
Args:<br>
spreadsheet_key: str, The unique ID of this containing spreadsheet. This<br>
can be the ID from the URL or as provided in a<br>
Spreadsheet entry.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others. Represents the current user. Defaults to None<br>
and if None, this method will look for a value in the<br>
auth_token member of <a href="#SpreadsheetsClient">SpreadsheetsClient</a>.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned. Defaults to<br>
gdata.spreadsheets.data.WorksheetsFeed.</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>api_version</strong> = '3'</dl>
<dl><dt><strong>auth_scopes</strong> = ('https://spreadsheets.google.com/feeds/',)</dl>
<dl><dt><strong>auth_service</strong> = 'wise'</dl>
<dl><dt><strong>ssl</strong> = True</dl>
<hr>
Methods inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br>
<dl><dt><a name="SpreadsheetsClient-Batch"><strong>Batch</strong></a> = batch(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br>
<br>
Args:<br>
feed: A batch feed containing batch entries, each is an operation.<br>
uri: (optional) The uri to which the batch request feed should be POSTed.<br>
If none is provided, then the feed's edit link will be used.<br>
force: (optional) boolean set to True if you want the batch update to<br>
clobber all data. If False, the version in the information in the<br>
feed object will cause the server to check to see that no changes<br>
intervened between when you fetched the data and when you sent the<br>
changes.<br>
auth_token: (optional) An object which sets the Authorization HTTP header<br>
in its modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-ClientLogin"><strong>ClientLogin</strong></a> = client_login(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br>
<br>
In order to modify user specific data and read user private data, your<br>
application must be authorized by the user. One way to demonstrage<br>
authorization is by including a Client Login token in the Authorization<br>
HTTP header of all requests. This method requests the Client Login token<br>
by sending the user's email address, password, the name of the<br>
application, and the service code for the service which will be accessed<br>
by the application. If the username and password are correct, the server<br>
will respond with the client login code and a new ClientLoginToken<br>
object will be set in the client's auth_token member. With the auth_token<br>
set, future requests from this client will include the Client Login<br>
token.<br>
<br>
For a list of service names, see <br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
For more information on Client Login, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br>
<br>
Args:<br>
email: str The user's email address or username.<br>
password: str The password for the user's account.<br>
source: str The name of your application. This can be anything you<br>
like but should should give some indication of which app is<br>
making the request.<br>
service: str The service code for the service you would like to access.<br>
For example, 'cp' for contacts, 'cl' for calendar. For a full<br>
list see<br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br>
service will usually be filled in for you so you do not need<br>
to specify it. For example see BloggerClient,<br>
<a href="#SpreadsheetsClient">SpreadsheetsClient</a>, etc.<br>
account_type: str (optional) The type of account which is being<br>
authenticated. This can be either 'GOOGLE' for a Google<br>
Account, 'HOSTED' for a Google Apps Account, or the<br>
default 'HOSTED_OR_GOOGLE' which will select the Google<br>
Apps Account if the same email address is used for both<br>
a Google Account and a Google Apps Account.<br>
auth_url: str (optional) The URL to which the login request should be<br>
sent.<br>
captcha_token: str (optional) If a previous login attempt was reponded<br>
to with a CAPTCHA challenge, this is the token which<br>
identifies the challenge (from the CAPTCHA's URL).<br>
captcha_response: str (optional) If a previous login attempt was<br>
reponded to with a CAPTCHA challenge, this is the<br>
response text which was contained in the challenge.<br>
<br>
Returns:<br>
Generated token, which is also stored in this object.<br>
<br>
Raises:<br>
A RequestError or one of its suclasses: BadAuthentication,<br>
BadAuthenticationServiceURL, ClientLoginFailed,<br>
ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-Delete"><strong>Delete</strong></a> = delete(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetAccessToken"><strong>GetAccessToken</strong></a> = get_access_token(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br>
<br>
Contacts the Google OAuth server to upgrade a previously authorized<br>
request token. Once the request token is upgraded to an access token,<br>
the access token may be used to access the user's data.<br>
<br>
For more details, see the Google Accounts OAuth documentation:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br>
<br>
Args:<br>
request_token: An OAuth token which has been authorized by the user.<br>
url: (optional) The URL to which the upgrade request should be sent.<br>
Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-GetEntry"><strong>GetEntry</strong></a> = get_entry(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetFeed"><strong>GetFeed</strong></a> = get_feed(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-GetNext"><strong>GetNext</strong></a> = get_next(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br>
<br>
When requesting a feed, the number of entries returned is capped at a<br>
service specific default limit (often 25 entries). You can specify your<br>
own entry-count cap using the max-results URL query parameter. If there<br>
are more results than could fit under max-results, the feed will contain<br>
a next link. This method performs a GET against this next results URL.<br>
<br>
Returns:<br>
A new feed object containing the next set of entries in this feed.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-GetOAuthToken"><strong>GetOAuthToken</strong></a> = get_oauth_token(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br>
<br>
Once this client has a request token, the user can authorize the request<br>
token by visiting the authorization URL in their browser. After being<br>
redirected back to this app at the 'next' URL, this app can then exchange<br>
the authorized request token for an access token.<br>
<br>
For more information see the documentation on Google Accounts with OAuth:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br>
<br>
Args:<br>
scopes: list of strings or atom.http_core.Uri objects which specify the<br>
URL prefixes which this app will be accessing. For example, to access<br>
the Google Calendar API, you would want to use scopes:<br>
['https://www.google.com/calendar/feeds/',<br>
'<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br>
next: str or atom.http_core.Uri object, The URL which the user's browser<br>
should be sent to after they authorize access to their data. This<br>
should be a URL in your application which will read the token<br>
information from the URL and upgrade the request token to an access<br>
token.<br>
consumer_key: str This is the identifier for this application which you<br>
should have received when you registered your application with Google<br>
to use OAuth.<br>
consumer_secret: str (optional) The shared secret between your app and<br>
Google which provides evidence that this request is coming from you<br>
application and not another app. If present, this libraries assumes<br>
you want to use an HMAC signature to verify requests. Keep this data<br>
a secret.<br>
rsa_private_key: str (optional) The RSA private key which is used to<br>
generate a digital signature which is checked by Google's server. If<br>
present, this library assumes that you want to use an RSA signature<br>
to verify requests. Keep this data a secret.<br>
url: The URL to which a request for a token should be made. The default<br>
is Google's OAuth request token provider.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-ModifyRequest"><strong>ModifyRequest</strong></a> = modify_request(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br>
<br>
This client will add the API version if it is specified.<br>
Subclasses may override this method to add their own request<br>
modifications before the request is made.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-Post"><strong>Post</strong></a> = post(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-Request"><strong>Request</strong></a> = request(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br>
<br>
See also documentation for atom.client.AtomPubClient.request.<br>
<br>
If a 302 redirect is sent from the server to the client, this client<br>
assumes that the redirect is in the form used by the Google Calendar API.<br>
The same request URI and method will be used as in the original request,<br>
but a gsessionid URL parameter will be added to the request URI with<br>
the value provided in the server's 302 redirect response. If the 302<br>
redirect is not in the format specified by the Google Calendar API, a<br>
RedirectError will be raised containing the body of the server's<br>
response.<br>
<br>
The method calls the client's modify_request method to make any changes<br>
required by the client before the request is made. For example, a<br>
version 2 client could add a GData-Version: 2 header to the request in<br>
its modify_request method.<br>
<br>
Args:<br>
method: str The HTTP verb for this request, usually 'GET', 'POST',<br>
'PUT', or 'DELETE'<br>
uri: atom.http_core.Uri, str, or unicode The URL being requested.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.<br>
http_request: (optional) atom.http_core.HttpRequest<br>
converter: function which takes the body of the response as its only<br>
argument and returns the desired object.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned.<br>
redirects_remaining: (optional) int, if this number is 0 and the<br>
server sends a 302 redirect, the request method<br>
will raise an exception. This parameter is used in<br>
recursive request calls to avoid an infinite loop.<br>
<br>
Any additional arguments are passed through to<br>
atom.client.AtomPubClient.request.<br>
<br>
Returns:<br>
An HTTP response object (see atom.http_core.HttpResponse for a<br>
description of the object's interface) if no converter was<br>
specified and no desired_class was specified. If a converter function<br>
was provided, the results of calling the converter are returned. If no<br>
converter was specified but a desired_class was provided, the response<br>
body will be converted to the class using<br>
atom.core.parse.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-RequestClientLoginToken"><strong>RequestClientLoginToken</strong></a> = request_client_login_token(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-RevokeToken"><strong>RevokeToken</strong></a> = revoke_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br>
<br>
This method can be used for both AuthSub and OAuth tokens (to invalidate<br>
a ClientLogin token, the user must change their password).<br>
<br>
Returns:<br>
True if the server responded with a 200.<br>
<br>
Raises:<br>
A RequestError if the server responds with a non-200 status.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-Update"><strong>Update</strong></a> = update(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br>
<br>
Performs a PUT and converts the response to a new entry object with a<br>
matching class to the entry passed in.<br>
<br>
Args:<br>
entry:<br>
auth_token:<br>
force: boolean stating whether an update should be forced. Defaults to<br>
False. Normally, if a change has been made since the passed in<br>
entry was obtained, the server will not overwrite the entry since<br>
the changes were based on an obsolete version of the entry.<br>
Setting force to True will cause the update to silently<br>
overwrite whatever version is present.<br>
uri: The uri to put to. If provided, this uri is PUT to rather than the<br>
inferred uri from the entry's edit link.<br>
<br>
Returns:<br>
A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-UpgradeToken"><strong>UpgradeToken</strong></a> = upgrade_token(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br>
<br>
For details on AuthSub, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br>
<br>
Args:<br>
token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br>
(optional) If no token is passed in, the client's auth_token member<br>
is used to request the new token. The token object will be modified<br>
to contain the new session token string.<br>
url: str or atom.http_core.Uri (optional) The URL to which the token<br>
upgrade request should be sent. Defaults to:<br>
https://www.google.com/accounts/AuthSubSessionToken<br>
<br>
Returns:<br>
The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-batch"><strong>batch</strong></a>(self, feed, uri<font color="#909090">=None</font>, force<font color="#909090">=False</font>, auth_token<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends a batch request to the server to execute operation entries.<br>
<br>
Args:<br>
feed: A batch feed containing batch entries, each is an operation.<br>
uri: (optional) The uri to which the batch request feed should be POSTed.<br>
If none is provided, then the feed's edit link will be used.<br>
force: (optional) boolean set to True if you want the batch update to<br>
clobber all data. If False, the version in the information in the<br>
feed object will cause the server to check to see that no changes<br>
intervened between when you fetched the data and when you sent the<br>
changes.<br>
auth_token: (optional) An object which sets the Authorization HTTP header<br>
in its modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-client_login"><strong>client_login</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt><dd><tt>Performs an auth request using the user's email address and password.<br>
<br>
In order to modify user specific data and read user private data, your<br>
application must be authorized by the user. One way to demonstrage<br>
authorization is by including a Client Login token in the Authorization<br>
HTTP header of all requests. This method requests the Client Login token<br>
by sending the user's email address, password, the name of the<br>
application, and the service code for the service which will be accessed<br>
by the application. If the username and password are correct, the server<br>
will respond with the client login code and a new ClientLoginToken<br>
object will be set in the client's auth_token member. With the auth_token<br>
set, future requests from this client will include the Client Login<br>
token.<br>
<br>
For a list of service names, see <br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
For more information on Client Login, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html">http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html</a><br>
<br>
Args:<br>
email: str The user's email address or username.<br>
password: str The password for the user's account.<br>
source: str The name of your application. This can be anything you<br>
like but should should give some indication of which app is<br>
making the request.<br>
service: str The service code for the service you would like to access.<br>
For example, 'cp' for contacts, 'cl' for calendar. For a full<br>
list see<br>
<a href="http://code.google.com/apis/gdata/faq.html#clientlogin">http://code.google.com/apis/gdata/faq.html#clientlogin</a><br>
If you are using a subclass of the gdata.client.<a href="gdata.client.html#GDClient">GDClient</a>, the<br>
service will usually be filled in for you so you do not need<br>
to specify it. For example see BloggerClient,<br>
<a href="#SpreadsheetsClient">SpreadsheetsClient</a>, etc.<br>
account_type: str (optional) The type of account which is being<br>
authenticated. This can be either 'GOOGLE' for a Google<br>
Account, 'HOSTED' for a Google Apps Account, or the<br>
default 'HOSTED_OR_GOOGLE' which will select the Google<br>
Apps Account if the same email address is used for both<br>
a Google Account and a Google Apps Account.<br>
auth_url: str (optional) The URL to which the login request should be<br>
sent.<br>
captcha_token: str (optional) If a previous login attempt was reponded<br>
to with a CAPTCHA challenge, this is the token which<br>
identifies the challenge (from the CAPTCHA's URL).<br>
captcha_response: str (optional) If a previous login attempt was<br>
reponded to with a CAPTCHA challenge, this is the<br>
response text which was contained in the challenge.<br>
<br>
Returns:<br>
Generated token, which is also stored in this object.<br>
<br>
Raises:<br>
A RequestError or one of its suclasses: BadAuthentication,<br>
BadAuthenticationServiceURL, ClientLoginFailed,<br>
ClientLoginTokenMissing, or CaptchaChallenge</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-delete"><strong>delete</strong></a>(self, entry_or_uri, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-get_access_token"><strong>get_access_token</strong></a>(self, request_token, url<font color="#909090">='https://www.google.com/accounts/OAuthGetAccessToken'</font>)</dt><dd><tt>Exchanges an authorized OAuth request token for an access token.<br>
<br>
Contacts the Google OAuth server to upgrade a previously authorized<br>
request token. Once the request token is upgraded to an access token,<br>
the access token may be used to access the user's data.<br>
<br>
For more details, see the Google Accounts OAuth documentation:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken">http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken</a><br>
<br>
Args:<br>
request_token: An OAuth token which has been authorized by the user.<br>
url: (optional) The URL to which the upgrade request should be sent.<br>
Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_entry"><strong>get_entry</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDEntry'></font>, etag<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-get_feed"><strong>get_feed</strong></a>(self, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=<class 'gdata.data.GDFeed'></font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-get_next"><strong>get_next</strong></a>(self, feed, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Fetches the next set of results from the feed.<br>
<br>
When requesting a feed, the number of entries returned is capped at a<br>
service specific default limit (often 25 entries). You can specify your<br>
own entry-count cap using the max-results URL query parameter. If there<br>
are more results than could fit under max-results, the feed will contain<br>
a next link. This method performs a GET against this next results URL.<br>
<br>
Returns:<br>
A new feed object containing the next set of entries in this feed.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get_oauth_token"><strong>get_oauth_token</strong></a>(self, scopes, next, consumer_key, consumer_secret<font color="#909090">=None</font>, rsa_private_key<font color="#909090">=None</font>, url<font color="#909090">='https://www.google.com/accounts/OAuthGetRequestToken'</font>)</dt><dd><tt>Obtains an OAuth request token to allow the user to authorize this app.<br>
<br>
Once this client has a request token, the user can authorize the request<br>
token by visiting the authorization URL in their browser. After being<br>
redirected back to this app at the 'next' URL, this app can then exchange<br>
the authorized request token for an access token.<br>
<br>
For more information see the documentation on Google Accounts with OAuth:<br>
<a href="http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess">http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess</a><br>
<br>
Args:<br>
scopes: list of strings or atom.http_core.Uri objects which specify the<br>
URL prefixes which this app will be accessing. For example, to access<br>
the Google Calendar API, you would want to use scopes:<br>
['https://www.google.com/calendar/feeds/',<br>
'<a href="http://www.google.com/calendar/feeds/">http://www.google.com/calendar/feeds/</a>']<br>
next: str or atom.http_core.Uri object, The URL which the user's browser<br>
should be sent to after they authorize access to their data. This<br>
should be a URL in your application which will read the token<br>
information from the URL and upgrade the request token to an access<br>
token.<br>
consumer_key: str This is the identifier for this application which you<br>
should have received when you registered your application with Google<br>
to use OAuth.<br>
consumer_secret: str (optional) The shared secret between your app and<br>
Google which provides evidence that this request is coming from you<br>
application and not another app. If present, this libraries assumes<br>
you want to use an HMAC signature to verify requests. Keep this data<br>
a secret.<br>
rsa_private_key: str (optional) The RSA private key which is used to<br>
generate a digital signature which is checked by Google's server. If<br>
present, this library assumes that you want to use an RSA signature<br>
to verify requests. Keep this data a secret.<br>
url: The URL to which a request for a token should be made. The default<br>
is Google's OAuth request token provider.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt><dd><tt>Adds or changes request before making the HTTP request.<br>
<br>
This client will add the API version if it is specified.<br>
Subclasses may override this method to add their own request<br>
modifications before the request is made.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-post"><strong>post</strong></a>(self, entry, uri, auth_token<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, **kwargs)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-request"><strong>request</strong></a>(self, method<font color="#909090">=None</font>, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, converter<font color="#909090">=None</font>, desired_class<font color="#909090">=None</font>, redirects_remaining<font color="#909090">=4</font>, **kwargs)</dt><dd><tt>Make an HTTP request to the server.<br>
<br>
See also documentation for atom.client.AtomPubClient.request.<br>
<br>
If a 302 redirect is sent from the server to the client, this client<br>
assumes that the redirect is in the form used by the Google Calendar API.<br>
The same request URI and method will be used as in the original request,<br>
but a gsessionid URL parameter will be added to the request URI with<br>
the value provided in the server's 302 redirect response. If the 302<br>
redirect is not in the format specified by the Google Calendar API, a<br>
RedirectError will be raised containing the body of the server's<br>
response.<br>
<br>
The method calls the client's modify_request method to make any changes<br>
required by the client before the request is made. For example, a<br>
version 2 client could add a GData-Version: 2 header to the request in<br>
its modify_request method.<br>
<br>
Args:<br>
method: str The HTTP verb for this request, usually 'GET', 'POST',<br>
'PUT', or 'DELETE'<br>
uri: atom.http_core.Uri, str, or unicode The URL being requested.<br>
auth_token: An object which sets the Authorization HTTP header in its<br>
modify_request method. Recommended classes include<br>
gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken<br>
among others.<br>
http_request: (optional) atom.http_core.HttpRequest<br>
converter: function which takes the body of the response as its only<br>
argument and returns the desired object.<br>
desired_class: class descended from atom.core.XmlElement to which a<br>
successful response should be converted. If there is no<br>
converter function specified (converter=None) then the<br>
desired_class will be used in calling the<br>
atom.core.parse function. If neither<br>
the desired_class nor the converter is specified, an<br>
HTTP reponse object will be returned.<br>
redirects_remaining: (optional) int, if this number is 0 and the<br>
server sends a 302 redirect, the request method<br>
will raise an exception. This parameter is used in<br>
recursive request calls to avoid an infinite loop.<br>
<br>
Any additional arguments are passed through to<br>
atom.client.AtomPubClient.request.<br>
<br>
Returns:<br>
An HTTP response object (see atom.http_core.HttpResponse for a<br>
description of the object's interface) if no converter was<br>
specified and no desired_class was specified. If a converter function<br>
was provided, the results of calling the converter are returned. If no<br>
converter was specified but a desired_class was provided, the response<br>
body will be converted to the class using<br>
atom.core.parse.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-request_client_login_token"><strong>request_client_login_token</strong></a>(self, email, password, source, service<font color="#909090">=None</font>, account_type<font color="#909090">='HOSTED_OR_GOOGLE'</font>, auth_url<font color="#909090">=<atom.http_core.Uri object></font>, captcha_token<font color="#909090">=None</font>, captcha_response<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="SpreadsheetsClient-revoke_token"><strong>revoke_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Requests that the token be invalidated.<br>
<br>
This method can be used for both AuthSub and OAuth tokens (to invalidate<br>
a ClientLogin token, the user must change their password).<br>
<br>
Returns:<br>
True if the server responded with a 200.<br>
<br>
Raises:<br>
A RequestError if the server responds with a non-200 status.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-update"><strong>update</strong></a>(self, entry, auth_token<font color="#909090">=None</font>, force<font color="#909090">=False</font>, uri<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Edits the entry on the server by sending the XML for this entry.<br>
<br>
Performs a PUT and converts the response to a new entry object with a<br>
matching class to the entry passed in.<br>
<br>
Args:<br>
entry:<br>
auth_token:<br>
force: boolean stating whether an update should be forced. Defaults to<br>
False. Normally, if a change has been made since the passed in<br>
entry was obtained, the server will not overwrite the entry since<br>
the changes were based on an obsolete version of the entry.<br>
Setting force to True will cause the update to silently<br>
overwrite whatever version is present.<br>
uri: The uri to put to. If provided, this uri is PUT to rather than the<br>
inferred uri from the entry's edit link.<br>
<br>
Returns:<br>
A new Entry object of a matching type to the entry which was passed in.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-upgrade_token"><strong>upgrade_token</strong></a>(self, token<font color="#909090">=None</font>, url<font color="#909090">=<atom.http_core.Uri object></font>)</dt><dd><tt>Asks the Google auth server for a multi-use AuthSub token.<br>
<br>
For details on AuthSub, see:<br>
<a href="http://code.google.com/apis/accounts/docs/AuthSub.html">http://code.google.com/apis/accounts/docs/AuthSub.html</a><br>
<br>
Args:<br>
token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken<br>
(optional) If no token is passed in, the client's auth_token member<br>
is used to request the new token. The token object will be modified<br>
to contain the new session token string.<br>
url: str or atom.http_core.Uri (optional) The URL to which the token<br>
upgrade request should be sent. Defaults to:<br>
https://www.google.com/accounts/AuthSubSessionToken<br>
<br>
Returns:<br>
The upgraded gdata.gauth.AuthSubToken object.</tt></dd></dl>
<hr>
Data and other attributes inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br>
<dl><dt><strong>alt_auth_service</strong> = None</dl>
<hr>
Methods inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><a name="SpreadsheetsClient-Get"><strong>Get</strong></a> = get(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-Put"><strong>Put</strong></a> = put(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-__init__"><strong>__init__</strong></a>(self, http_client<font color="#909090">=None</font>, host<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, source<font color="#909090">=None</font>, xoauth_requestor_id<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Creates a new AtomPubClient instance.<br>
<br>
Args:<br>
source: The name of your application.<br>
http_client: An object capable of performing HTTP requests through a<br>
request method. This object is used to perform the request<br>
when the AtomPubClient's request method is called. Used to<br>
allow HTTP requests to be directed to a mock server, or use<br>
an alternate library instead of the default of httplib to<br>
make HTTP requests.<br>
host: str The default host name to use if a host is not specified in the<br>
requested URI.<br>
auth_token: An object which sets the HTTP Authorization header when its<br>
modify_request method is called.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-get"><strong>get</strong></a>(self, uri<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Performs a request using the GET method, returns an HTTP response.</tt></dd></dl>
<dl><dt><a name="SpreadsheetsClient-put"><strong>put</strong></a>(self, uri<font color="#909090">=None</font>, data<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, http_request<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Sends data using the PUT method, returns an HTTP response.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br>
<dl><dt><strong>auth_token</strong> = None</dl>
<dl><dt><strong>host</strong> = None</dl>
<dl><dt><strong>xoauth_requestor_id</strong> = None</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="TableQuery">class <strong>TableQuery</strong></a>(<a href="gdata.spreadsheets.client.html#ListQuery">ListQuery</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.spreadsheets.client.html#TableQuery">TableQuery</a></dd>
<dd><a href="gdata.spreadsheets.client.html#ListQuery">ListQuery</a></dd>
<dd><a href="gdata.client.html#Query">gdata.client.Query</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods inherited from <a href="gdata.spreadsheets.client.html#ListQuery">ListQuery</a>:<br>
<dl><dt><a name="TableQuery-ModifyRequest"><strong>ModifyRequest</strong></a> = modify_request(self, http_request)</dt></dl>
<dl><dt><a name="TableQuery-__init__"><strong>__init__</strong></a>(self, order_by<font color="#909090">=None</font>, reverse<font color="#909090">=None</font>, sq<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Adds List-feed specific query parameters to a request.<br>
<br>
Args:<br>
order_by: str Specifies what column to use in ordering the entries in<br>
the feed. By position (the default): 'position' returns<br>
rows in the order in which they appear in the GUI. Row 1, then<br>
row 2, then row 3, and so on. By column:<br>
'column:columnName' sorts rows in ascending order based on the<br>
values in the column with the given columnName, where<br>
columnName is the value in the header row for that column.<br>
reverse: str Specifies whether to sort in descending or ascending order.<br>
Reverses default sort order: 'true' results in a descending<br>
sort; 'false' (the default) results in an ascending sort.<br>
sq: str Structured query on the full text in the worksheet.<br>
[columnName][binaryOperator][value]<br>
Supported binaryOperators are:<br>
- (), for overriding order of operations<br>
- = or ==, for strict equality<br>
- <> or !=, for strict inequality<br>
- and or &&, for boolean and<br>
- or or ||, for boolean or</tt></dd></dl>
<dl><dt><a name="TableQuery-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt></dl>
<hr>
Methods inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><a name="TableQuery-AddCustomParameter"><strong>AddCustomParameter</strong></a> = add_custom_parameter(self, key, value)</dt></dl>
<dl><dt><a name="TableQuery-add_custom_parameter"><strong>add_custom_parameter</strong></a>(self, key, value)</dt></dl>
<hr>
Data descriptors inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="WorksheetQuery">class <strong>WorksheetQuery</strong></a>(<a href="gdata.spreadsheets.client.html#SpreadsheetQuery">SpreadsheetQuery</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="gdata.spreadsheets.client.html#WorksheetQuery">WorksheetQuery</a></dd>
<dd><a href="gdata.spreadsheets.client.html#SpreadsheetQuery">SpreadsheetQuery</a></dd>
<dd><a href="gdata.client.html#Query">gdata.client.Query</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods inherited from <a href="gdata.spreadsheets.client.html#SpreadsheetQuery">SpreadsheetQuery</a>:<br>
<dl><dt><a name="WorksheetQuery-ModifyRequest"><strong>ModifyRequest</strong></a> = modify_request(self, http_request)</dt></dl>
<dl><dt><a name="WorksheetQuery-__init__"><strong>__init__</strong></a>(self, title<font color="#909090">=None</font>, title_exact<font color="#909090">=None</font>, **kwargs)</dt><dd><tt>Adds Spreadsheets feed query parameters to a request.<br>
<br>
Args:<br>
title: str Specifies the search terms for the title of a document.<br>
This parameter used without title-exact will only submit partial<br>
queries, not exact queries.<br>
title_exact: str Specifies whether the title query should be taken as an<br>
exact string. Meaningless without title. Possible values are<br>
'true' and 'false'.</tt></dd></dl>
<dl><dt><a name="WorksheetQuery-modify_request"><strong>modify_request</strong></a>(self, http_request)</dt></dl>
<hr>
Methods inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><a name="WorksheetQuery-AddCustomParameter"><strong>AddCustomParameter</strong></a> = add_custom_parameter(self, key, value)</dt></dl>
<dl><dt><a name="WorksheetQuery-add_custom_parameter"><strong>add_custom_parameter</strong></a>(self, key, value)</dt></dl>
<hr>
Data descriptors inherited from <a href="gdata.client.html#Query">gdata.client.Query</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>CELLS_URL</strong> = 'https://spreadsheets.google.com/feeds/cells/%s/%s/private/full'<br>
<strong>CELL_URL</strong> = 'https://spreadsheets.google.com/feeds/cells/%s/%s/private/full/R%sC%s'<br>
<strong>LISTS_URL</strong> = 'https://spreadsheets.google.com/feeds/list/%s/%s/private/full'<br>
<strong>RECORDS_URL</strong> = 'https://spreadsheets.google.com/feeds/%s/records/%s'<br>
<strong>RECORD_URL</strong> = 'https://spreadsheets.google.com/feeds/%s/records/%s/%s'<br>
<strong>SPREADSHEETS_URL</strong> = 'https://spreadsheets.google.com/feeds/spreadsheets/private/full'<br>
<strong>TABLES_URL</strong> = 'https://spreadsheets.google.com/feeds/%s/tables'<br>
<strong>WORKSHEETS_URL</strong> = 'https://spreadsheets.google.com/feeds/worksheets/%s/private/full'<br>
<strong>WORKSHEET_URL</strong> = 'https://spreadsheets.google.com/feeds/worksheets/%s/private/full/%s'<br>
<strong>__author__</strong> = 'j.s@google.com (Jeff Scudder)'</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
<td width="100%">j.s@google.com (Jeff Scudder)</td></tr></table>
</body></html>