gdata.analytics.client | index /home/afshar/wrk/gdata-python-client/src/gdata/analytics/client.py

`Streamlines requests to the Google Analytics APIs.`

Modules
`` |  |
atom | gdata |  |

Classes
`` |  | gdata.client.GDClient(atom.client.AtomPubClient) AnalyticsClient gdata.client.GDQuery(atom.http_core.Uri) AnalyticsBaseQuery AccountFeedQuery AccountQuery AdvSegQuery DataFeedQuery GoalQuery ProfileQuery WebPropertyQuery
class AccountFeedQuery(AnalyticsBaseQuery)
`` | `Account Feed query class to simplify constructing Account Feed Urls. To use this class, you can either pass a dict in the constructor that has all the data feed query parameters as keys: queryUrl = AccountFeedQuery({'max-results': '10000'}) Alternatively you can add new parameters directly to the query object: queryUrl = AccountFeedQuery() queryUrl.query['max-results'] = '10000' Args: query: dict (optional) Contains all the GA Data Feed query parameters as keys.`
| Method resolution order: AccountFeedQuery AnalyticsBaseQuery gdata.client.GDQuery atom.http_core.Uri __builtin__.object Methods defined here: __init__(self, query={}, **kwargs) Data and other attributes defined here: path = '/analytics/feeds/accounts/default' Data and other attributes inherited from AnalyticsBaseQuery: host = 'www.google.com' scheme = 'https' Data descriptors inherited from gdata.client.GDQuery: text_query `The q parameter for searching for an exact text match on content` Methods inherited from atom.http_core.Uri: ModifyRequest = modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` __str__(self) modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` Static methods inherited from atom.http_core.Uri: ParseUri = parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` Data descriptors inherited from atom.http_core.Uri: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Data and other attributes inherited from atom.http_core.Uri: port = None
class AccountQuery(AnalyticsBaseQuery)
`` | `Management API Account Feed query class. Example Usage: queryUrl = AccountQuery() queryUrl = AccountQuery({'max-results': 100}) queryUrl2 = AccountQuery() queryUrl2.query['max-results'] = 100 Args: query: dict (optional) A dictionary of query parameters.`
| Method resolution order: AccountQuery AnalyticsBaseQuery gdata.client.GDQuery atom.http_core.Uri __builtin__.object Methods defined here: __init__(self, query={}, **kwargs) Data and other attributes defined here: path = '/analytics/feeds/datasources/ga/accounts' Data and other attributes inherited from AnalyticsBaseQuery: host = 'www.google.com' scheme = 'https' Data descriptors inherited from gdata.client.GDQuery: text_query `The q parameter for searching for an exact text match on content` Methods inherited from atom.http_core.Uri: ModifyRequest = modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` __str__(self) modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` Static methods inherited from atom.http_core.Uri: ParseUri = parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` Data descriptors inherited from atom.http_core.Uri: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Data and other attributes inherited from atom.http_core.Uri: port = None
class AdvSegQuery(AnalyticsBaseQuery)
`` | `Management API Goal Feed query class. Example Usage: queryUrl = AdvSegQuery() queryUrl = AdvSegQuery({'max-results': 100}) queryUrl1 = AdvSegQuery() queryUrl1.query['max-results'] = 100 Args: query: dict (optional) A dictionary of query parameters.`
| Method resolution order: AdvSegQuery AnalyticsBaseQuery gdata.client.GDQuery atom.http_core.Uri __builtin__.object Methods defined here: __init__(self, query={}, **kwargs) Data and other attributes defined here: path = '/analytics/feeds/datasources/ga/segments' Data and other attributes inherited from AnalyticsBaseQuery: host = 'www.google.com' scheme = 'https' Data descriptors inherited from gdata.client.GDQuery: text_query `The q parameter for searching for an exact text match on content` Methods inherited from atom.http_core.Uri: ModifyRequest = modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` __str__(self) modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` Static methods inherited from atom.http_core.Uri: ParseUri = parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` Data descriptors inherited from atom.http_core.Uri: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Data and other attributes inherited from atom.http_core.Uri: port = None
class AnalyticsBaseQuery(gdata.client.GDQuery)
`` | `Abstracts common configuration across all query objects. Attributes: scheme: string The default scheme. Should always be https. host: string The default host.`
| Method resolution order: AnalyticsBaseQuery gdata.client.GDQuery atom.http_core.Uri __builtin__.object Data and other attributes defined here: host = 'www.google.com' scheme = 'https' Data descriptors inherited from gdata.client.GDQuery: text_query `The q parameter for searching for an exact text match on content` Methods inherited from atom.http_core.Uri: ModifyRequest = modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` __init__(self, scheme=None, host=None, port=None, path=None, query=None) `Constructor for a URI. Args: scheme: str This is usually 'http' or 'https'. host: str The host name or IP address of the desired server. post: int The server's port number. path: str The path of the resource following the host. This begins with a /, example: '/calendar/feeds/default/allcalendars/full' query: dict of strings The URL query parameters. The keys and values are both escaped so this dict should contain the unescaped values. For example {'my key': 'val', 'second': '!!!'} will become '?my+key=val&second=%21%21%21' which is appended to the path.` __str__(self) modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` Static methods inherited from atom.http_core.Uri: ParseUri = parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` Data descriptors inherited from atom.http_core.Uri: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Data and other attributes inherited from atom.http_core.Uri: path = None port = None
class AnalyticsClient(gdata.client.GDClient)
`` | `Client extension for the Google Analytics API service.`
| Method resolution order: AnalyticsClient gdata.client.GDClient atom.client.AtomPubClient __builtin__.object Methods defined here: GetAccountFeed = get_account_feed(self, feed_uri, auth_token=None, **kwargs) GetDataFeed = get_data_feed(self, feed_uri, auth_token=None, **kwargs) GetManagementFeed = get_management_feed(self, feed_uri, auth_token=None, **kwargs) GetMgmtFeed = get_management_feed(self, feed_uri, auth_token=None, **kwargs) __init__(self, auth_token=None, **kwargs) `Initializes a new client for the Google Analytics Data Export API. Args: auth_token: gdata.gauth.ClientLoginToken, AuthSubToken, or OAuthToken (optional) Authorizes this client to edit the user's data. kwargs: The other parameters to pass to gdata.client.GDClient constructor.` get_account_feed(self, feed_uri, auth_token=None, **kwargs) `Makes a request to the Analytics API Account Feed. Args: feed_uri: str or gdata.analytics.AccountFeedQuery The Analytics Account Feed uri to define what data to retrieve from the API. Can also be used with a gdata.analytics.AccountFeedQuery object.` get_data_feed(self, feed_uri, auth_token=None, **kwargs) `Makes a request to the Analytics API Data Feed. Args: feed_uri: str or gdata.analytics.AccountFeedQuery The Analytics Data Feed uri to define what data to retrieve from the API. Can also be used with a gdata.analytics.AccountFeedQuery object.` get_management_feed(self, feed_uri, auth_token=None, **kwargs) `Makes a request to the Google Analytics Management API. The Management API provides read-only access to configuration data for Google Analytics and supercedes the Data Export API Account Feed. The Management API supports 5 feeds: account, web property, profile, goal, advanced segment. You can access each feed through the respective management query class below. All requests return the same data object. Args: feed_uri: str or AccountQuery, WebPropertyQuery, ProfileQuery, GoalQuery, MgmtAdvSegFeedQuery The Management API Feed uri to define which feed to retrieve. Either use a string or one of the wrapper classes.` Data and other attributes defined here: account_type = 'GOOGLE' api_version = '2' auth_scopes = ('https://www.google.com/analytics/feeds/',) auth_service = 'analytics' ssl = True Methods inherited from gdata.client.GDClient: Batch = batch(self, feed, uri=None, force=False, auth_token=None, **kwargs) `Sends a batch request to the server to execute operation entries. Args: feed: A batch feed containing batch entries, each is an operation. uri: (optional) The uri to which the batch request feed should be POSTed. If none is provided, then the feed's edit link will be used. force: (optional) boolean set to True if you want the batch update to clobber all data. If False, the version in the information in the feed object will cause the server to check to see that no changes intervened between when you fetched the data and when you sent the changes. auth_token: (optional) An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.` ClientLogin = client_login(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None) `Performs an auth request using the user's email address and password. In order to modify user specific data and read user private data, your application must be authorized by the user. One way to demonstrage authorization is by including a Client Login token in the Authorization HTTP header of all requests. This method requests the Client Login token by sending the user's email address, password, the name of the application, and the service code for the service which will be accessed by the application. If the username and password are correct, the server will respond with the client login code and a new ClientLoginToken object will be set in the client's auth_token member. With the auth_token set, future requests from this client will include the Client Login token. For a list of service names, see http://code.google.com/apis/gdata/faq.html#clientlogin For more information on Client Login, see: http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html Args: email: str The user's email address or username. password: str The password for the user's account. source: str The name of your application. This can be anything you like but should should give some indication of which app is making the request. service: str The service code for the service you would like to access. For example, 'cp' for contacts, 'cl' for calendar. For a full list see http://code.google.com/apis/gdata/faq.html#clientlogin If you are using a subclass of the gdata.client.GDClient, the service will usually be filled in for you so you do not need to specify it. For example see BloggerClient, SpreadsheetsClient, etc. account_type: str (optional) The type of account which is being authenticated. This can be either 'GOOGLE' for a Google Account, 'HOSTED' for a Google Apps Account, or the default 'HOSTED_OR_GOOGLE' which will select the Google Apps Account if the same email address is used for both a Google Account and a Google Apps Account. auth_url: str (optional) The URL to which the login request should be sent. captcha_token: str (optional) If a previous login attempt was reponded to with a CAPTCHA challenge, this is the token which identifies the challenge (from the CAPTCHA's URL). captcha_response: str (optional) If a previous login attempt was reponded to with a CAPTCHA challenge, this is the response text which was contained in the challenge. Returns: Generated token, which is also stored in this object. Raises: A RequestError or one of its suclasses: BadAuthentication, BadAuthenticationServiceURL, ClientLoginFailed, ClientLoginTokenMissing, or CaptchaChallenge` Delete = delete(self, entry_or_uri, auth_token=None, force=False, **kwargs) GetAccessToken = get_access_token(self, request_token, url='https://www.google.com/accounts/OAuthGetAccessToken') `Exchanges an authorized OAuth request token for an access token. Contacts the Google OAuth server to upgrade a previously authorized request token. Once the request token is upgraded to an access token, the access token may be used to access the user's data. For more details, see the Google Accounts OAuth documentation: http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken Args: request_token: An OAuth token which has been authorized by the user. url: (optional) The URL to which the upgrade request should be sent. Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken` GetEntry = get_entry(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDEntry'>, etag=None, **kwargs) GetFeed = get_feed(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDFeed'>, **kwargs) GetNext = get_next(self, feed, auth_token=None, converter=None, desired_class=None, **kwargs) `Fetches the next set of results from the feed. When requesting a feed, the number of entries returned is capped at a service specific default limit (often 25 entries). You can specify your own entry-count cap using the max-results URL query parameter. If there are more results than could fit under max-results, the feed will contain a next link. This method performs a GET against this next results URL. Returns: A new feed object containing the next set of entries in this feed.` GetOAuthToken = get_oauth_token(self, scopes, next, consumer_key, consumer_secret=None, rsa_private_key=None, url='https://www.google.com/accounts/OAuthGetRequestToken') `Obtains an OAuth request token to allow the user to authorize this app. Once this client has a request token, the user can authorize the request token by visiting the authorization URL in their browser. After being redirected back to this app at the 'next' URL, this app can then exchange the authorized request token for an access token. For more information see the documentation on Google Accounts with OAuth: http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess Args: scopes: list of strings or atom.http_core.Uri objects which specify the URL prefixes which this app will be accessing. For example, to access the Google Calendar API, you would want to use scopes: ['https://www.google.com/calendar/feeds/', 'http://www.google.com/calendar/feeds/'] next: str or atom.http_core.Uri object, The URL which the user's browser should be sent to after they authorize access to their data. This should be a URL in your application which will read the token information from the URL and upgrade the request token to an access token. consumer_key: str This is the identifier for this application which you should have received when you registered your application with Google to use OAuth. consumer_secret: str (optional) The shared secret between your app and Google which provides evidence that this request is coming from you application and not another app. If present, this libraries assumes you want to use an HMAC signature to verify requests. Keep this data a secret. rsa_private_key: str (optional) The RSA private key which is used to generate a digital signature which is checked by Google's server. If present, this library assumes that you want to use an RSA signature to verify requests. Keep this data a secret. url: The URL to which a request for a token should be made. The default is Google's OAuth request token provider.` ModifyRequest = modify_request(self, http_request) `Adds or changes request before making the HTTP request. This client will add the API version if it is specified. Subclasses may override this method to add their own request modifications before the request is made.` Post = post(self, entry, uri, auth_token=None, converter=None, desired_class=None, **kwargs) Request = request(self, method=None, uri=None, auth_token=None, http_request=None, converter=None, desired_class=None, redirects_remaining=4, **kwargs) `Make an HTTP request to the server. See also documentation for atom.client.AtomPubClient.request. If a 302 redirect is sent from the server to the client, this client assumes that the redirect is in the form used by the Google Calendar API. The same request URI and method will be used as in the original request, but a gsessionid URL parameter will be added to the request URI with the value provided in the server's 302 redirect response. If the 302 redirect is not in the format specified by the Google Calendar API, a RedirectError will be raised containing the body of the server's response. The method calls the client's modify_request method to make any changes required by the client before the request is made. For example, a version 2 client could add a GData-Version: 2 header to the request in its modify_request method. Args: method: str The HTTP verb for this request, usually 'GET', 'POST', 'PUT', or 'DELETE' uri: atom.http_core.Uri, str, or unicode The URL being requested. auth_token: An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others. http_request: (optional) atom.http_core.HttpRequest converter: function which takes the body of the response as its only argument and returns the desired object. desired_class: class descended from atom.core.XmlElement to which a successful response should be converted. If there is no converter function specified (converter=None) then the desired_class will be used in calling the atom.core.parse function. If neither the desired_class nor the converter is specified, an HTTP reponse object will be returned. redirects_remaining: (optional) int, if this number is 0 and the server sends a 302 redirect, the request method will raise an exception. This parameter is used in recursive request calls to avoid an infinite loop. Any additional arguments are passed through to atom.client.AtomPubClient.request. Returns: An HTTP response object (see atom.http_core.HttpResponse for a description of the object's interface) if no converter was specified and no desired_class was specified. If a converter function was provided, the results of calling the converter are returned. If no converter was specified but a desired_class was provided, the response body will be converted to the class using atom.core.parse.` RequestClientLoginToken = request_client_login_token(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None) RevokeToken = revoke_token(self, token=None, url=<atom.http_core.Uri object>) `Requests that the token be invalidated. This method can be used for both AuthSub and OAuth tokens (to invalidate a ClientLogin token, the user must change their password). Returns: True if the server responded with a 200. Raises: A RequestError if the server responds with a non-200 status.` Update = update(self, entry, auth_token=None, force=False, uri=None, **kwargs) `Edits the entry on the server by sending the XML for this entry. Performs a PUT and converts the response to a new entry object with a matching class to the entry passed in. Args: entry: auth_token: force: boolean stating whether an update should be forced. Defaults to False. Normally, if a change has been made since the passed in entry was obtained, the server will not overwrite the entry since the changes were based on an obsolete version of the entry. Setting force to True will cause the update to silently overwrite whatever version is present. uri: The uri to put to. If provided, this uri is PUT to rather than the inferred uri from the entry's edit link. Returns: A new Entry object of a matching type to the entry which was passed in.` UpgradeToken = upgrade_token(self, token=None, url=<atom.http_core.Uri object>) `Asks the Google auth server for a multi-use AuthSub token. For details on AuthSub, see: http://code.google.com/apis/accounts/docs/AuthSub.html Args: token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken (optional) If no token is passed in, the client's auth_token member is used to request the new token. The token object will be modified to contain the new session token string. url: str or atom.http_core.Uri (optional) The URL to which the token upgrade request should be sent. Defaults to: https://www.google.com/accounts/AuthSubSessionToken Returns: The upgraded gdata.gauth.AuthSubToken object.` batch(self, feed, uri=None, force=False, auth_token=None, **kwargs) `Sends a batch request to the server to execute operation entries. Args: feed: A batch feed containing batch entries, each is an operation. uri: (optional) The uri to which the batch request feed should be POSTed. If none is provided, then the feed's edit link will be used. force: (optional) boolean set to True if you want the batch update to clobber all data. If False, the version in the information in the feed object will cause the server to check to see that no changes intervened between when you fetched the data and when you sent the changes. auth_token: (optional) An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others.` client_login(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None) `Performs an auth request using the user's email address and password. In order to modify user specific data and read user private data, your application must be authorized by the user. One way to demonstrage authorization is by including a Client Login token in the Authorization HTTP header of all requests. This method requests the Client Login token by sending the user's email address, password, the name of the application, and the service code for the service which will be accessed by the application. If the username and password are correct, the server will respond with the client login code and a new ClientLoginToken object will be set in the client's auth_token member. With the auth_token set, future requests from this client will include the Client Login token. For a list of service names, see http://code.google.com/apis/gdata/faq.html#clientlogin For more information on Client Login, see: http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html Args: email: str The user's email address or username. password: str The password for the user's account. source: str The name of your application. This can be anything you like but should should give some indication of which app is making the request. service: str The service code for the service you would like to access. For example, 'cp' for contacts, 'cl' for calendar. For a full list see http://code.google.com/apis/gdata/faq.html#clientlogin If you are using a subclass of the gdata.client.GDClient, the service will usually be filled in for you so you do not need to specify it. For example see BloggerClient, SpreadsheetsClient, etc. account_type: str (optional) The type of account which is being authenticated. This can be either 'GOOGLE' for a Google Account, 'HOSTED' for a Google Apps Account, or the default 'HOSTED_OR_GOOGLE' which will select the Google Apps Account if the same email address is used for both a Google Account and a Google Apps Account. auth_url: str (optional) The URL to which the login request should be sent. captcha_token: str (optional) If a previous login attempt was reponded to with a CAPTCHA challenge, this is the token which identifies the challenge (from the CAPTCHA's URL). captcha_response: str (optional) If a previous login attempt was reponded to with a CAPTCHA challenge, this is the response text which was contained in the challenge. Returns: Generated token, which is also stored in this object. Raises: A RequestError or one of its suclasses: BadAuthentication, BadAuthenticationServiceURL, ClientLoginFailed, ClientLoginTokenMissing, or CaptchaChallenge` delete(self, entry_or_uri, auth_token=None, force=False, **kwargs) get_access_token(self, request_token, url='https://www.google.com/accounts/OAuthGetAccessToken') `Exchanges an authorized OAuth request token for an access token. Contacts the Google OAuth server to upgrade a previously authorized request token. Once the request token is upgraded to an access token, the access token may be used to access the user's data. For more details, see the Google Accounts OAuth documentation: http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken Args: request_token: An OAuth token which has been authorized by the user. url: (optional) The URL to which the upgrade request should be sent. Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken` get_entry(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDEntry'>, etag=None, **kwargs) get_feed(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDFeed'>, **kwargs) get_next(self, feed, auth_token=None, converter=None, desired_class=None, **kwargs) `Fetches the next set of results from the feed. When requesting a feed, the number of entries returned is capped at a service specific default limit (often 25 entries). You can specify your own entry-count cap using the max-results URL query parameter. If there are more results than could fit under max-results, the feed will contain a next link. This method performs a GET against this next results URL. Returns: A new feed object containing the next set of entries in this feed.` get_oauth_token(self, scopes, next, consumer_key, consumer_secret=None, rsa_private_key=None, url='https://www.google.com/accounts/OAuthGetRequestToken') `Obtains an OAuth request token to allow the user to authorize this app. Once this client has a request token, the user can authorize the request token by visiting the authorization URL in their browser. After being redirected back to this app at the 'next' URL, this app can then exchange the authorized request token for an access token. For more information see the documentation on Google Accounts with OAuth: http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess Args: scopes: list of strings or atom.http_core.Uri objects which specify the URL prefixes which this app will be accessing. For example, to access the Google Calendar API, you would want to use scopes: ['https://www.google.com/calendar/feeds/', 'http://www.google.com/calendar/feeds/'] next: str or atom.http_core.Uri object, The URL which the user's browser should be sent to after they authorize access to their data. This should be a URL in your application which will read the token information from the URL and upgrade the request token to an access token. consumer_key: str This is the identifier for this application which you should have received when you registered your application with Google to use OAuth. consumer_secret: str (optional) The shared secret between your app and Google which provides evidence that this request is coming from you application and not another app. If present, this libraries assumes you want to use an HMAC signature to verify requests. Keep this data a secret. rsa_private_key: str (optional) The RSA private key which is used to generate a digital signature which is checked by Google's server. If present, this library assumes that you want to use an RSA signature to verify requests. Keep this data a secret. url: The URL to which a request for a token should be made. The default is Google's OAuth request token provider.` modify_request(self, http_request) `Adds or changes request before making the HTTP request. This client will add the API version if it is specified. Subclasses may override this method to add their own request modifications before the request is made.` post(self, entry, uri, auth_token=None, converter=None, desired_class=None, **kwargs) request(self, method=None, uri=None, auth_token=None, http_request=None, converter=None, desired_class=None, redirects_remaining=4, **kwargs) `Make an HTTP request to the server. See also documentation for atom.client.AtomPubClient.request. If a 302 redirect is sent from the server to the client, this client assumes that the redirect is in the form used by the Google Calendar API. The same request URI and method will be used as in the original request, but a gsessionid URL parameter will be added to the request URI with the value provided in the server's 302 redirect response. If the 302 redirect is not in the format specified by the Google Calendar API, a RedirectError will be raised containing the body of the server's response. The method calls the client's modify_request method to make any changes required by the client before the request is made. For example, a version 2 client could add a GData-Version: 2 header to the request in its modify_request method. Args: method: str The HTTP verb for this request, usually 'GET', 'POST', 'PUT', or 'DELETE' uri: atom.http_core.Uri, str, or unicode The URL being requested. auth_token: An object which sets the Authorization HTTP header in its modify_request method. Recommended classes include gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken among others. http_request: (optional) atom.http_core.HttpRequest converter: function which takes the body of the response as its only argument and returns the desired object. desired_class: class descended from atom.core.XmlElement to which a successful response should be converted. If there is no converter function specified (converter=None) then the desired_class will be used in calling the atom.core.parse function. If neither the desired_class nor the converter is specified, an HTTP reponse object will be returned. redirects_remaining: (optional) int, if this number is 0 and the server sends a 302 redirect, the request method will raise an exception. This parameter is used in recursive request calls to avoid an infinite loop. Any additional arguments are passed through to atom.client.AtomPubClient.request. Returns: An HTTP response object (see atom.http_core.HttpResponse for a description of the object's interface) if no converter was specified and no desired_class was specified. If a converter function was provided, the results of calling the converter are returned. If no converter was specified but a desired_class was provided, the response body will be converted to the class using atom.core.parse.` request_client_login_token(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None) revoke_token(self, token=None, url=<atom.http_core.Uri object>) `Requests that the token be invalidated. This method can be used for both AuthSub and OAuth tokens (to invalidate a ClientLogin token, the user must change their password). Returns: True if the server responded with a 200. Raises: A RequestError if the server responds with a non-200 status.` update(self, entry, auth_token=None, force=False, uri=None, **kwargs) `Edits the entry on the server by sending the XML for this entry. Performs a PUT and converts the response to a new entry object with a matching class to the entry passed in. Args: entry: auth_token: force: boolean stating whether an update should be forced. Defaults to False. Normally, if a change has been made since the passed in entry was obtained, the server will not overwrite the entry since the changes were based on an obsolete version of the entry. Setting force to True will cause the update to silently overwrite whatever version is present. uri: The uri to put to. If provided, this uri is PUT to rather than the inferred uri from the entry's edit link. Returns: A new Entry object of a matching type to the entry which was passed in.` upgrade_token(self, token=None, url=<atom.http_core.Uri object>) `Asks the Google auth server for a multi-use AuthSub token. For details on AuthSub, see: http://code.google.com/apis/accounts/docs/AuthSub.html Args: token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken (optional) If no token is passed in, the client's auth_token member is used to request the new token. The token object will be modified to contain the new session token string. url: str or atom.http_core.Uri (optional) The URL to which the token upgrade request should be sent. Defaults to: https://www.google.com/accounts/AuthSubSessionToken Returns: The upgraded gdata.gauth.AuthSubToken object.` Data and other attributes inherited from gdata.client.GDClient: alt_auth_service = None Methods inherited from atom.client.AtomPubClient: Get = get(self, uri=None, auth_token=None, http_request=None, **kwargs) `Performs a request using the GET method, returns an HTTP response.` Put = put(self, uri=None, data=None, auth_token=None, http_request=None, **kwargs) `Sends data using the PUT method, returns an HTTP response.` get(self, uri=None, auth_token=None, http_request=None, **kwargs) `Performs a request using the GET method, returns an HTTP response.` put(self, uri=None, data=None, auth_token=None, http_request=None, **kwargs) `Sends data using the PUT method, returns an HTTP response.` Data descriptors inherited from atom.client.AtomPubClient: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Data and other attributes inherited from atom.client.AtomPubClient: auth_token = None host = None xoauth_requestor_id = None
class DataFeedQuery(AnalyticsBaseQuery)
`` | `Data Feed query class to simplify constructing Data Feed Urls. To use this class, you can either pass a dict in the constructor that has all the data feed query parameters as keys: queryUrl = DataFeedQuery({'start-date': '2008-10-01'}) Alternatively you can add new parameters directly to the query object: queryUrl = DataFeedQuery() queryUrl.query['start-date'] = '2008-10-01' Args: query: dict (optional) Contains all the GA Data Feed query parameters as keys.`
| Method resolution order: DataFeedQuery AnalyticsBaseQuery gdata.client.GDQuery atom.http_core.Uri __builtin__.object Methods defined here: __init__(self, query={}, **kwargs) Data and other attributes defined here: path = '/analytics/feeds/data' Data and other attributes inherited from AnalyticsBaseQuery: host = 'www.google.com' scheme = 'https' Data descriptors inherited from gdata.client.GDQuery: text_query `The q parameter for searching for an exact text match on content` Methods inherited from atom.http_core.Uri: ModifyRequest = modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` __str__(self) modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` Static methods inherited from atom.http_core.Uri: ParseUri = parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` Data descriptors inherited from atom.http_core.Uri: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Data and other attributes inherited from atom.http_core.Uri: port = None
class GoalQuery(AnalyticsBaseQuery)
`` | `Management API Goal Feed query class. Example Usage: queryUrl = GoalQuery() queryUrl = GoalQuery('123', 'UA-123-1', '555', {'max-results': 100}) queryUrl = GoalQuery(acct_id='123', web_prop_id='UA-123-1', profile_id='555', query={'max-results': 100}) queryUrl2 = GoalQuery() queryUrl2.acct_id = '123' queryUrl2.web_prop_id = 'UA-123-1' queryUrl2.query['max-results'] = 100 Args: acct_id: string (optional) The account ID to filter results. Default is ~all. web_prop_id: string (optional) The web property ID to filter results. Default is ~all. profile_id: string (optional) The profile ID to filter results. Default is ~all. query: dict (optional) A dictionary of query parameters.`
| Method resolution order: GoalQuery AnalyticsBaseQuery gdata.client.GDQuery atom.http_core.Uri __builtin__.object Methods defined here: __init__(self, acct_id='~all', web_prop_id='~all', profile_id='~all', query={}, **kwargs) Data descriptors defined here: path `Wrapper for path attribute.` Data and other attributes inherited from AnalyticsBaseQuery: host = 'www.google.com' scheme = 'https' Data descriptors inherited from gdata.client.GDQuery: text_query `The q parameter for searching for an exact text match on content` Methods inherited from atom.http_core.Uri: ModifyRequest = modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` __str__(self) modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` Static methods inherited from atom.http_core.Uri: ParseUri = parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` Data descriptors inherited from atom.http_core.Uri: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Data and other attributes inherited from atom.http_core.Uri: port = None
class ProfileQuery(AnalyticsBaseQuery)
`` | `Management API Profile Feed query class. Example Usage: queryUrl = ProfileQuery() queryUrl = ProfileQuery('123', 'UA-123-1', {'max-results': 100}) queryUrl = ProfileQuery(acct_id='123', web_prop_id='UA-123-1', query={'max-results': 100}) queryUrl2 = ProfileQuery() queryUrl2.acct_id = '123' queryUrl2.web_prop_id = 'UA-123-1' queryUrl2.query['max-results'] = 100 Args: acct_id: string (optional) The account ID to filter results. Default is ~all. web_prop_id: string (optional) The web property ID to filter results. Default is ~all. query: dict (optional) A dictionary of query parameters.`
| Method resolution order: ProfileQuery AnalyticsBaseQuery gdata.client.GDQuery atom.http_core.Uri __builtin__.object Methods defined here: __init__(self, acct_id='~all', web_prop_id='~all', query={}, **kwargs) Data descriptors defined here: path `Wrapper for path attribute.` Data and other attributes inherited from AnalyticsBaseQuery: host = 'www.google.com' scheme = 'https' Data descriptors inherited from gdata.client.GDQuery: text_query `The q parameter for searching for an exact text match on content` Methods inherited from atom.http_core.Uri: ModifyRequest = modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` __str__(self) modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` Static methods inherited from atom.http_core.Uri: ParseUri = parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` Data descriptors inherited from atom.http_core.Uri: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Data and other attributes inherited from atom.http_core.Uri: port = None
class WebPropertyQuery(AnalyticsBaseQuery)
`` | `Management API Web Property Feed query class. Example Usage: queryUrl = WebPropertyQuery() queryUrl = WebPropertyQuery('123', {'max-results': 100}) queryUrl = WebPropertyQuery(acct_id='123', query={'max-results': 100}) queryUrl2 = WebPropertyQuery() queryUrl2.acct_id = '1234' queryUrl2.query['max-results'] = 100 Args: acct_id: string (optional) The account ID to filter results. Default is ~all. query: dict (optional) A dictionary of query parameters.`
| Method resolution order: WebPropertyQuery AnalyticsBaseQuery gdata.client.GDQuery atom.http_core.Uri __builtin__.object Methods defined here: __init__(self, acct_id='~all', query={}, **kwargs) Data descriptors defined here: path `Wrapper for path attribute.` Data and other attributes inherited from AnalyticsBaseQuery: host = 'www.google.com' scheme = 'https' Data descriptors inherited from gdata.client.GDQuery: text_query `The q parameter for searching for an exact text match on content` Methods inherited from atom.http_core.Uri: ModifyRequest = modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` __str__(self) modify_request(self, http_request=None) `Sets HTTP request components based on the URI.` Static methods inherited from atom.http_core.Uri: ParseUri = parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` parse_uri(uri_string) `Creates a Uri object which corresponds to the URI string. This method can accept partial URIs, but it will leave missing members of the Uri unset.` Data descriptors inherited from atom.http_core.Uri: __dict__ `dictionary for instance variables (if defined)` __weakref__ `list of weak references to the object (if defined)` Data and other attributes inherited from atom.http_core.Uri: port = None

Data
`` |  | __author__ = 'api.nickm@google.com (Nick Mihailovski)'

Author
`` |  | api.nickm@google.com (Nick Mihailovski)