| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: module gdata.contentforshopping.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.contentforshopping.html"><font color="#ffffff">contentforshopping</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/contentforshopping/client.py">/usr/local/google/home/afshar/src/external-gdata-release/google3/src/gdata/contentforshopping/client.py</a></font></td></tr></table> |
| <p><tt>Extend the gdata client for the Content API for Shopping.</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><a href="urllib.html">urllib</a><br> |
| </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.contentforshopping.client.html#ContentForShoppingClient">ContentForShoppingClient</a> |
| </font></dt></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="ContentForShoppingClient">class <strong>ContentForShoppingClient</strong></a>(<a href="gdata.client.html#GDClient">gdata.client.GDClient</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>Client for Content for Shopping API.<br> |
| <br> |
| :param account_id: Merchant account ID. This value will be used by default<br> |
| for all requests, but may be overridden on a<br> |
| request-by-request basis.<br> |
| :param api_version: The version of the API to target. Default value: 'v1'.<br> |
| :param **kwargs: Pass all addtional keywords to the <a href="gdata.client.html#GDClient">GDClient</a> constructor.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%"><dl><dt>Method resolution order:</dt> |
| <dd><a href="gdata.contentforshopping.client.html#ContentForShoppingClient">ContentForShoppingClient</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="ContentForShoppingClient-AddLocalId"><strong>AddLocalId</strong></a> = <a href="#ContentForShoppingClient-add_local_id">add_local_id</a>(self, product, id, country, language, store_code, account_id<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-Batch"><strong>Batch</strong></a> = <a href="#ContentForShoppingClient-batch">batch</a>(self, feed, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-DeleteClientAccount"><strong>DeleteClientAccount</strong></a> = <a href="#ContentForShoppingClient-delete_client_account">delete_client_account</a>(self, client_account_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-DeleteDatafeed"><strong>DeleteDatafeed</strong></a> = <a href="#ContentForShoppingClient-delete_datafeed">delete_datafeed</a>(self, feed_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-DeleteProduct"><strong>DeleteProduct</strong></a> = <a href="#ContentForShoppingClient-delete_product">delete_product</a>(self, product, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-DeleteProducts"><strong>DeleteProducts</strong></a> = <a href="#ContentForShoppingClient-delete_products">delete_products</a>(self, products, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-DeleteUsersEntry"><strong>DeleteUsersEntry</strong></a> = <a href="#ContentForShoppingClient-delete_users_entry">delete_users_entry</a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetClientAccount"><strong>GetClientAccount</strong></a> = <a href="#ContentForShoppingClient-get_client_account">get_client_account</a>(self, client_account_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetClientAccounts"><strong>GetClientAccounts</strong></a> = <a href="#ContentForShoppingClient-get_client_accounts">get_client_accounts</a>(self, max_results<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetDataQualityEntry"><strong>GetDataQualityEntry</strong></a> = <a href="#ContentForShoppingClient-get_data_quality_entry">get_data_quality_entry</a>(self, secondary_account_id<font color="#909090">=None</font>, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetDataQualityFeed"><strong>GetDataQualityFeed</strong></a> = <a href="#ContentForShoppingClient-get_data_quality_feed">get_data_quality_feed</a>(self, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, max_results<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetDatafeed"><strong>GetDatafeed</strong></a> = <a href="#ContentForShoppingClient-get_datafeed">get_datafeed</a>(self, feed_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetDatafeeds"><strong>GetDatafeeds</strong></a> = <a href="#ContentForShoppingClient-get_datafeeds">get_datafeeds</a>(self, account_id<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetProduct"><strong>GetProduct</strong></a> = <a href="#ContentForShoppingClient-get_product">get_product</a>(self, id, country, language, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetProducts"><strong>GetProducts</strong></a> = <a href="#ContentForShoppingClient-get_products">get_products</a>(self, max_results<font color="#909090">=None</font>, start_token<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>, performance_start<font color="#909090">=None</font>, performance_end<font color="#909090">=None</font>, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetUsersEntry"><strong>GetUsersEntry</strong></a> = <a href="#ContentForShoppingClient-get_users_entry">get_users_entry</a>(self, user_email, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-GetUsersFeed"><strong>GetUsersFeed</strong></a> = <a href="#ContentForShoppingClient-get_users_feed">get_users_feed</a>(self, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-InsertClientAccount"><strong>InsertClientAccount</strong></a> = <a href="#ContentForShoppingClient-insert_client_account">insert_client_account</a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-InsertDatafeed"><strong>InsertDatafeed</strong></a> = <a href="#ContentForShoppingClient-insert_datafeed">insert_datafeed</a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-InsertProduct"><strong>InsertProduct</strong></a> = <a href="#ContentForShoppingClient-insert_product">insert_product</a>(self, product, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-InsertProducts"><strong>InsertProducts</strong></a> = <a href="#ContentForShoppingClient-insert_products">insert_products</a>(self, products, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-InsertUsersEntry"><strong>InsertUsersEntry</strong></a> = <a href="#ContentForShoppingClient-insert_users_entry">insert_users_entry</a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-UpdateClientAccount"><strong>UpdateClientAccount</strong></a> = <a href="#ContentForShoppingClient-update_client_account">update_client_account</a>(self, entry, client_account_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-UpdateDatafeed"><strong>UpdateDatafeed</strong></a> = <a href="#ContentForShoppingClient-update_datafeed">update_datafeed</a>(self, entry, feed_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-UpdateInventoryEntry"><strong>UpdateInventoryEntry</strong></a> = <a href="#ContentForShoppingClient-update_inventory_entry">update_inventory_entry</a>(self, product, id, country, language, store_code, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-UpdateInventoryFeed"><strong>UpdateInventoryFeed</strong></a> = <a href="#ContentForShoppingClient-update_inventory_feed">update_inventory_feed</a>(self, products, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-UpdateProduct"><strong>UpdateProduct</strong></a> = <a href="#ContentForShoppingClient-update_product">update_product</a>(self, product, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-UpdateProducts"><strong>UpdateProducts</strong></a> = <a href="#ContentForShoppingClient-update_products">update_products</a>(self, products, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-UpdateUsersEntry"><strong>UpdateUsersEntry</strong></a> = <a href="#ContentForShoppingClient-update_users_entry">update_users_entry</a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-__init__"><strong>__init__</strong></a>(self, account_id<font color="#909090">=None</font>, api_version<font color="#909090">='v1'</font>, cfs_uri<font color="#909090">='https://content.googleapis.com/content'</font>, **kwargs)</dt></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-add_local_id"><strong>add_local_id</strong></a>(self, product, id, country, language, store_code, account_id<font color="#909090">=None</font>)</dt><dd><tt>Add an atom id to a local product with a local store specific URI.<br> |
| <br> |
| :param product: A :class:`gdata.contentforshopping.data.InventoryEntry`<br> |
| with the required product data.<br> |
| :param id: The product ID<br> |
| :param country: The country (target_country)<br> |
| :param language: The language (content_language)<br> |
| :param store_code: The code for the store where this local product will<br> |
| be updated.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-batch"><strong>batch</strong></a>(self, feed, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Send a batch request.<br> |
| <br> |
| :param feed: The feed of batch entries to send.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-delete_client_account"><strong>delete_client_account</strong></a>(self, client_account_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Delete a client account<br> |
| <br> |
| :param client_account_id: The client account ID<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-delete_datafeed"><strong>delete_datafeed</strong></a>(self, feed_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Delete a single datafeed.<br> |
| <br> |
| :param feed_id: The ID of the desired datafeed.<br> |
| :param account_id: The Sub-Account ID. If ommitted the default<br> |
| Account ID will be used for this client.<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-delete_product"><strong>delete_product</strong></a>(self, product, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Delete a product<br> |
| <br> |
| :param product: A :class:`gdata.contentforshopping.data.ProductEntry` with<br> |
| the required product data.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-delete_products"><strong>delete_products</strong></a>(self, products, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Delete the products using a batch request.<br> |
| <br> |
| :param products: A list of product entries<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.<br> |
| <br> |
| .. note:: Entries must have the atom:id element set.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-delete_users_entry"><strong>delete_users_entry</strong></a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Delete a users feed entry for an account.<br> |
| <br> |
| :param entry: A :class:`gdata.contentforshopping.data.UsersEntry` with<br> |
| the required user data.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_client_account"><strong>get_client_account</strong></a>(self, client_account_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Get a managed account.<br> |
| <br> |
| :param client_account_id: The Account ID of the subaccount being retrieved.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_client_accounts"><strong>get_client_accounts</strong></a>(self, max_results<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Get the feed of managed accounts<br> |
| <br> |
| :param max_results: The maximum number of results to return (default 25,<br> |
| maximum 250).<br> |
| :param start_index: The starting index of the feed to return (default 1,<br> |
| maximum 10000)<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_data_quality_entry"><strong>get_data_quality_entry</strong></a>(self, secondary_account_id<font color="#909090">=None</font>, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Get the data quality feed entry for an account.<br> |
| <br> |
| :param secondary_account_id: The Account ID of the secondary account. If<br> |
| ommitted the value of account_id is used.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_data_quality_feed"><strong>get_data_quality_feed</strong></a>(self, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, max_results<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>)</dt><dd><tt>Get the data quality feed for an account.<br> |
| <br> |
| :param max_results: The maximum number of results to return (default 25,<br> |
| max 100).<br> |
| :param start_index: The starting index of the feed to return.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_datafeed"><strong>get_datafeed</strong></a>(self, feed_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Get the feed of a single datafeed.<br> |
| <br> |
| :param feed_id: The ID of the desired datafeed.<br> |
| :param account_id: The Sub-Account ID. If ommitted the default<br> |
| Account ID will be used for this client.<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_datafeeds"><strong>get_datafeeds</strong></a>(self, account_id<font color="#909090">=None</font>)</dt><dd><tt>Get the feed of datafeeds.<br> |
| <br> |
| :param account_id: The Sub-Account ID. If ommitted the default<br> |
| Account ID will be used for this client.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_product"><strong>get_product</strong></a>(self, id, country, language, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Get a product by id, country and language.<br> |
| <br> |
| :param id: The product ID<br> |
| :param country: The country (target_country)<br> |
| :param language: The language (content_language)<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_products"><strong>get_products</strong></a>(self, max_results<font color="#909090">=None</font>, start_token<font color="#909090">=None</font>, start_index<font color="#909090">=None</font>, performance_start<font color="#909090">=None</font>, performance_end<font color="#909090">=None</font>, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Get a feed of products for the account.<br> |
| <br> |
| :param max_results: The maximum number of results to return (default 25,<br> |
| maximum 250).<br> |
| :param start_token: The start token of the feed provided by the API.<br> |
| :param start_index: The starting index of the feed to return (default 1,<br> |
| maximum 10000)<br> |
| :param performance_start: The start date (inclusive) of click data returned.<br> |
| Should be represented as YYYY-MM-DD; not appended<br> |
| if left as None.<br> |
| :param performance_end: The end date (inclusive) of click data returned.<br> |
| Should be represented as YYYY-MM-DD; not appended<br> |
| if left as None.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_users_entry"><strong>get_users_entry</strong></a>(self, user_email, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Get a users feed entry for an account.<br> |
| <br> |
| :param user_email: Email of the user entry to be retrieved.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-get_users_feed"><strong>get_users_feed</strong></a>(self, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Get the users feed for an account.<br> |
| <br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-insert_client_account"><strong>insert_client_account</strong></a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Insert a client account entry<br> |
| <br> |
| :param entry: An entry of type ClientAccount<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-insert_datafeed"><strong>insert_datafeed</strong></a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Insert a datafeed.<br> |
| <br> |
| :param entry: XML Content of post request required for registering a<br> |
| datafeed.<br> |
| :param account_id: The Sub-Account ID. If ommitted the default<br> |
| Account ID will be used for this client.<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-insert_product"><strong>insert_product</strong></a>(self, product, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Create a new product, by posting the product entry feed.<br> |
| <br> |
| :param product: A :class:`gdata.contentforshopping.data.ProductEntry` with<br> |
| the required product data.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-insert_products"><strong>insert_products</strong></a>(self, products, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Insert the products using a batch request<br> |
| <br> |
| :param products: A list of product entries<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-insert_users_entry"><strong>insert_users_entry</strong></a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Insert a users feed entry for an account.<br> |
| <br> |
| :param entry: A :class:`gdata.contentforshopping.data.UsersEntry` with<br> |
| the required user data.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-update_client_account"><strong>update_client_account</strong></a>(self, entry, client_account_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Update a client account<br> |
| <br> |
| :param entry: An entry of type ClientAccount to update to<br> |
| :param client_account_id: The client account ID<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-update_datafeed"><strong>update_datafeed</strong></a>(self, entry, feed_id, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Update the feed of a single datafeed.<br> |
| <br> |
| :param entry: XML Content of put request required for updating a<br> |
| datafeed.<br> |
| :param feed_id: The ID of the desired datafeed.<br> |
| :param account_id: The Sub-Account ID. If ommitted the default<br> |
| Account ID will be used for this client.<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-update_inventory_entry"><strong>update_inventory_entry</strong></a>(self, product, id, country, language, store_code, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Make a local product update, by putting the inventory entry.<br> |
| <br> |
| :param product: A :class:`gdata.contentforshopping.data.InventoryEntry`<br> |
| with the required product data.<br> |
| :param id: The product ID<br> |
| :param country: The country (target_country)<br> |
| :param language: The language (content_language)<br> |
| :param store_code: The code for the store where this local product will<br> |
| be updated.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-update_inventory_feed"><strong>update_inventory_feed</strong></a>(self, products, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Update a batch of local products, by putting the product entry feed.<br> |
| <br> |
| :param products: A list containing entries of<br> |
| :class:`gdata.contentforshopping.data.InventoryEntry`<br> |
| with the required product data<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| <br> |
| .. note:: Entries must have the atom:id element set. You can use<br> |
| add_local_id to set this attribute using the store_code, product<br> |
| id, country and language.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-update_product"><strong>update_product</strong></a>(self, product, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Update a product, by putting the product entry feed.<br> |
| <br> |
| :param product: A :class:`gdata.contentforshopping.data.ProductEntry` with<br> |
| the required product data.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False<br> |
| by default.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-update_products"><strong>update_products</strong></a>(self, products, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>, dry_run<font color="#909090">=False</font>, warnings<font color="#909090">=False</font>)</dt><dd><tt>Update the products using a batch request<br> |
| <br> |
| :param products: A list of product entries<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.<br> |
| :param dry_run: Flag to run all requests that modify persistent data in<br> |
| dry-run mode. False by default.<br> |
| :param warnings: Flag to include warnings in response. False by default.<br> |
| <br> |
| .. note:: Entries must have the atom:id element set.</tt></dd></dl> |
| |
| <dl><dt><a name="ContentForShoppingClient-update_users_entry"><strong>update_users_entry</strong></a>(self, entry, account_id<font color="#909090">=None</font>, auth_token<font color="#909090">=None</font>)</dt><dd><tt>Update a users feed entry for an account.<br> |
| <br> |
| :param entry: A :class:`gdata.contentforshopping.data.UsersEntry` with<br> |
| the required user data.<br> |
| :param account_id: The Merchant Center Account ID. If ommitted the default<br> |
| Account ID will be used for this client<br> |
| :param auth_token: An object which sets the Authorization HTTP header in its<br> |
| modify_request method.</tt></dd></dl> |
| |
| <hr> |
| Data and other attributes defined here:<br> |
| <dl><dt><strong>api_version</strong> = '1.0'</dl> |
| |
| <hr> |
| Methods inherited from <a href="gdata.client.html#GDClient">gdata.client.GDClient</a>:<br> |
| <dl><dt><a name="ContentForShoppingClient-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> |
| SpreadsheetsClient, 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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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> |
| SpreadsheetsClient, 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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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> |
| |
| <dl><dt><strong>auth_scopes</strong> = None</dl> |
| |
| <dl><dt><strong>auth_service</strong> = None</dl> |
| |
| <hr> |
| Methods inherited from <a href="atom.client.html#AtomPubClient">atom.client.AtomPubClient</a>:<br> |
| <dl><dt><a name="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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="ContentForShoppingClient-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>ssl</strong> = False</dl> |
| |
| <dl><dt><strong>xoauth_requestor_id</strong> = None</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>CFS_HOST</strong> = 'content.googleapis.com'<br> |
| <strong>CFS_PROJECTION</strong> = 'schema'<br> |
| <strong>CFS_URI</strong> = 'https://content.googleapis.com/content'<br> |
| <strong>CFS_VERSION</strong> = 'v1'<br> |
| <strong>__author__</strong> = 'afshar (Ali Afshar), dhermes (Daniel Hermes)'</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%">afshar (Ali Afshar), dhermes (Daniel Hermes)</td></tr></table> |
| </body></html> |
