API¶

DocsClient simplifies interactions with the Documents List API.

class gdata.docs.client.DocsClient(http_client=None, host=None, auth_token=None, source=None, xoauth_requestor_id=None, **kwargs)[source]¶

Client for all features of the Google Documents List API.

AddAclEntry(resource, acl_entry, send_notifications=None, **kwargs)¶

Adds the given AclEntry to the given Resource.

Parameters:	resource – gdata.docs.data.Resource to which to add AclEntry. acl_entry – gdata.docs.data.AclEntry representing ACL entry to add. send_notifications – True if users should be notified by email when this AclEntry is added. kwargs – Other parameters to pass to self.post().
Return type:	gdata.docs.data.AclEntry containing information about new entry. Raises: ValueError: If given resource has no ACL link.

Batch(feed, uri=None, force=False, auth_token=None, **kwargs)¶

Sends a batch request to the server to execute operation entries.

Parameters:

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.

BatchProcessAclEntries(resource, entries, **kwargs)¶

Applies the specified operation of each entry in a single request.

To use this, simply set acl_entry.batch_operation to one of [‘query’, ‘insert’, ‘update’, ‘delete’], and optionally set acl_entry.batch_id to a string of your choice.

Then, put all of your modified AclEntry objects into a list and pass that list as the entries parameter.

Parameters:	resource – gdata.docs.data.Resource to which the given entries belong. entries – [gdata.docs.data.AclEntry] to modify in some way. kwargs – Other args to pass to gdata.client.GDClient.post()
Return type:	Resulting gdata.docs.data.AclFeed of changes.

ClientLogin(email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object at 0x2692090>, 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

Parameters:

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 –
RequestError or one of its suclasses (A) – BadAuthentication, BadAuthenticationServiceURL, ClientLoginFailed, ClientLoginTokenMissing, or CaptchaChallenge

CopyResource(entry, title, **kwargs)¶

Copies the given entry to a new entry with the given title.

Note: Files do not support this feature.

Parameters:	entry – gdata.docs.data.Resource to copy. title – String title for the new entry. kwargs – Other parameters to pass to self.post().
Return type:	gdata.docs.data.Resource representing duplicated resource.

CreateArchive(entry, **kwargs)¶

Creates a new archive of resources.

Parameters:	entry – gdata.docs.data.Archive representing metadata of archive to create. kwargs – Other parameters to pass to self.post().
Return type:	gdata.docs.data.Archive containing information about new archive.

CreateResource(entry, media=None, collection=None, create_uri=None, **kwargs)¶

Creates new entries in Google Docs, and uploads their contents.

Parameters:

entry – gdata.docs.data.Resource representing initial version of entry being created. If media is also provided, the entry will first be created with the given metadata and content.
media – (optional) gdata.data.MediaSource containing the file to be uploaded.
collection – (optional) gdata.docs.data.Resource representing a collection in which this new entry should be created. If provided along with create_uri, create_uri will win (e.g. entry will be created at create_uri, not necessarily in given collection).
create_uri – (optional) String URI at which to create the given entry. If collection, media and create_uri are None, use gdata.docs.client.RESOURCE_FEED_URI. If collection and create_uri are None, use gdata.docs.client.RESOURCE_UPLOAD_URI. If collection and media are not None, collection.GetResumableCreateMediaLink() is used, with the collection’s resource ID substituted in.
kwargs – Other parameters to pass to self.post() and self.update().

Return type:

gdata.docs.data.Resource containing information about new entry.

DeleteAclEntry(entry, **kwargs)¶

Deletes the given AclEntry.

Parameters:	entry – gdata.docs.data.AclEntry to delete. kwargs – Other args to pass to gdata.client.GDClient.Delete()
Return type:	Result of delete request.

DeleteArchive(entry, **kwargs)¶

Aborts the given Archive operation, or deletes the Archive.

Parameters:	entry – gdata.docs.data.Archive to delete. kwargs – Other args to pass to gdata.client.GDClient.Delete()
Return type:	Result of delete request.

DeleteResource(entry, permanent=False, **kwargs)¶

Trashes or deletes the given entry.

Parameters:	entry – gdata.docs.data.Resource to trash or delete. permanent – True to skip the trash and delete the entry forever. kwargs – Other args to pass to gdata.client.GDClient.Delete()
Return type:	Result of delete request.

DeleteRevision(entry, **kwargs)¶

Deletes the given Revision.

Parameters:	entry – gdata.docs.data.Revision to delete. kwargs – Other args to pass to gdata.client.GDClient.Delete()
Return type:	Result of delete request.

DownloadArchive(entry, file_path, extra_params=None, **kwargs)¶

Downloads the contents of the given entry to disk.

Note: to download a file in memory, use the DownloadResourceToMemory() method.

Parameters:

entry – gdata.docs.data.Resource whose contents to fetch.
file_path – str Full path to which to save file.
extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. For example, exporting a
as a .csv (spreadsheet) – extra_params={‘gid’: 0, ‘exportFormat’: ‘csv’}
kwargs – Other parameters to pass to self._download_file().
Raises – gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

DownloadArchiveToMemory(entry, extra_params=None, **kwargs)¶

Returns the contents of the given entry.

Parameters:	entry – gdata.docs.data.Resource whose contents to fetch. extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. For example, exporting a as a .csv (spreadsheet) – extra_params={‘gid’: 0, ‘exportFormat’: ‘csv’} kwargs – Other parameters to pass to self._get_content().
Return type:	Content of given resource after being downloaded. Raises: gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

DownloadResource(entry, file_path, extra_params=None, **kwargs)¶

Downloads the contents of the given entry to disk.

Note: to download a file in memory, use the DownloadResourceToMemory() method.

Parameters:

entry – gdata.docs.data.Resource whose contents to fetch.
file_path – str Full path to which to save file.
extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. For example, exporting a
as a .csv (spreadsheet) – extra_params={‘gid’: 0, ‘exportFormat’: ‘csv’}
kwargs – Other parameters to pass to self._download_file().
Raises – gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

DownloadResourceToMemory(entry, extra_params=None, **kwargs)¶

Returns the contents of the given entry.

Parameters:	entry – gdata.docs.data.Resource whose contents to fetch. extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. For example, exporting a as a .csv (spreadsheet) – extra_params={‘gid’: 0, ‘exportFormat’: ‘csv’} kwargs – Other parameters to pass to self._get_content().
Return type:	Content of given resource after being downloaded. Raises: gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

DownloadRevision(entry, file_path, extra_params=None, **kwargs)¶

Downloads the contents of the given revision to disk.

Note: to download a revision in memory, use the DownloadRevisionToMemory() method.

Parameters:

entry – gdata.docs.data.Revision whose contents to fetch.
file_path – str Full path to which to save file.
extra_params – dict (optional) A map of any further parameters to control how the document is downloaded.
kwargs – Other parameters to pass to self._download_file().
Raises – gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

DownloadRevisionToMemory(entry, extra_params=None, **kwargs)¶

Returns the contents of the given revision.

Parameters:	entry – gdata.docs.data.Revision whose contents to fetch. extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. kwargs – Other parameters to pass to self._get_content().
Return type:	Content of given revision after being downloaded. Raises: gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

Get(uri=None, auth_token=None, http_request=None, **kwargs)¶: Performs a request using the GET method, returns an HTTP response.

GetAccessToken(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

Parameters:	request_token – An OAuth token which has been authorized by the user. url – (optional) The URL to which the upgrade request should be sent. to (Defaults) – https://www.google.com/accounts/OAuthAuthorizeToken

GetAcl(entry, **kwargs)¶

Retrieves an AclFeed for the given resource.

Parameters:	entry – gdata.docs.data.Resource to fetch AclFeed for. kwargs – Other args to pass to GetFeed().
Return type:	gdata.docs.data.AclFeed representing retrieved entries.

GetAclEntry(entry, **kwargs)¶

Retrieves an AclEntry again.

This is useful if you need to poll for an ACL changing.

Parameters:	entry – gdata.docs.data.AclEntry to fetch and return. kwargs – Other args to pass to GetAclEntryBySelfLink().
Return type:	gdata.docs.data.AclEntry representing retrieved entry.

GetAclEntryBySelfLink(self_link, **kwargs)¶

Retrieves a particular AclEntry by its self link.

Parameters:	self_link – URI at which to query for given ACL entry. This can be found using entry.GetSelfLink(). kwargs – Other parameters to pass to self.get_entry().
Return type:	gdata.docs.data.AclEntry representing the retrieved entry.

GetAllResources(uri=None, show_root=None, **kwargs)¶

Retrieves all of a user’s non-collections or everything at the given URI.

Folders are not included in this by default. Pass in a custom URI to include collections in your query. The DocsQuery class is an easy way to generate such a URI.

This method makes multiple HTTP requests (by following the feed’s next links) in order to fetch the user’s entire document list.

Parameters:	uri – (optional) URI to query the doclist feed with. If None, then use DocsClient.RESOURCE_FEED_URI, which will retrieve all non-collections. show_root – (optional) True to include indications if a resource is in the root collection. kwargs – Other parameters to pass to self.GetResources().
Return type:	List of gdata.docs.data.Resource objects representing the retrieved entries.

GetArchive(entry, **kwargs)¶

Retrieves an archive again given its entry.

This is useful if you need to poll for an archive completing.

Parameters:	entry – gdata.docs.data.Archive to fetch and return. kwargs – Other args to pass to GetArchiveBySelfLink().
Return type:	gdata.docs.data.Archive representing retrieved archive.

GetArchiveBySelfLink(self_link, **kwargs)¶

Retrieves a particular archive by its self link.

Parameters:	self_link – URI at which to query for given archive. This can be found using entry.GetSelfLink(). kwargs – Other parameters to pass to self.get_entry().
Return type:	gdata.docs.data.Archive representing the retrieved archive.

GetChanges(changestamp=None, max_results=None, show_root=None, **kwargs)¶

Retrieves changes to a user’s documents list.

Parameters:

changestamp – (optional) String changestamp value to query since. If provided, returned changes will have a changestamp larger than the given one.
max_results – (optional) Number of results to fetch. API will limit this number to 100 at most.
show_root – (optional) True to include indications if a resource is in the root collection.
kwargs – Other parameters to pass to self.get_feed().

Return type:

gdata.docs.data.ChangeFeed.

GetMetadata(**kwargs)¶

Retrieves the metadata of a user account.

Parameters:	kwargs – Other parameters to pass to self.get_entry().
Return type:	gdata.docs.data.Metadata representing metadata of user’s account.

GetNext(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.

Return type:	A new feed object containing the next set of entries in this feed.

GetOAuthToken(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

Parameters:

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
Google Calendar API, you would want to use scopes (the) –
[‘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.

GetResource(entry, **kwargs)¶

Retrieves a resource again given its entry.

Parameters:	entry – gdata.docs.data.Resource to fetch and return. kwargs – Other args to pass to GetResourceBySelfLink().
Return type:	gdata.docs.data.Resource representing retrieved resource.

GetResourceAcl(entry, **kwargs)¶

Retrieves the ACL sharing permissions for the given entry.

Parameters:	entry – gdata.docs.data.Resource for which to get ACL. kwargs – Other parameters to pass to self.get_feed().
Return type:	gdata.docs.data.AclFeed representing the resource’s ACL.

GetResourceById(resource_id, **kwargs)¶

Retrieves a resource again given its resource ID.

Parameters:	resource_id – Typed or untyped resource ID of a resource. kwargs – Other args to pass to GetResourceBySelfLink().
Return type:	gdata.docs.data.Resource representing retrieved resource.

GetResourceBySelfLink(uri, etag=None, show_root=None, **kwargs)¶

Retrieves a particular resource by its self link.

Parameters:

uri – str URI at which to query for given resource. This can be found using entry.GetSelfLink().
etag – str (optional) The document/item’s etag value to be used in a
GET. See http (conditional) – //code.google.com/apis/documents/docs/3.0/ developers_guide_protocol.html#RetrievingCached.
show_root – (optional) True to include indications if a resource is in the root collection.
kwargs – Other parameters to pass to self.get_entry().

Return type:

gdata.docs.data.Resource representing the retrieved resource.

GetResources(uri=None, limit=None, show_root=None, **kwargs)¶

Retrieves the resources in a user’s docslist, or the given URI.

Parameters:

uri – (optional) URI to query for resources. If None, then gdata.docs.client.DocsClient.RESOURCE_FEED_URI is used, which will query for all non-collections.
limit – int (optional) A maximum cap for the number of results to return in the feed. By default, the API returns a maximum of 100 per page. Thus, if you set limit=5000, you will get <= 5000 documents (guarenteed no more than 5000), and will need to follow the feed’s next links (feed.GetNextLink()) to the rest. See get_everything(). Similarly, if you set limit=50, only <= 50
are returned. Note (documents) – if the max-results parameter is set in the uri parameter, it is chosen over a value set for limit.
show_root – (optional) True to include indications if a resource is in the root collection.
kwargs – Other parameters to pass to self.get_feed().

Return type:

gdata.docs.data.ResourceFeed feed.

GetRevision(entry, **kwargs)¶

Retrieves a revision again given its entry.

Parameters:	entry – gdata.docs.data.Revision to fetch and return. kwargs – Other args to pass to GetRevisionBySelfLink().
Return type:	gdata.docs.data.Revision representing retrieved revision.

GetRevisionBySelfLink(self_link, **kwargs)¶

Retrieves a particular reivision by its self link.

Parameters:	self_link – URI at which to query for given revision. This can be found using entry.GetSelfLink(). kwargs – Other parameters to pass to self.get_entry().
Return type:	gdata.docs.data.Revision representing the retrieved revision.

GetRevisions(entry, **kwargs)¶

Retrieves the revision history for a resource.

Parameters:	entry – gdata.docs.data.Resource for which to get revisions. kwargs – Other parameters to pass to self.get_feed().
Return type:	gdata.docs.data.RevisionFeed representing the resource’s revisions.

ModifyRequest(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.

MoveResource(entry, collection=None, keep_in_collections=False, **kwargs)¶

Moves an item into a different collection (or out of all collections).

Parameters:

entry – gdata.docs.data.Resource to move.
collection – gdata.docs.data.Resource (optional) An object representing the destination collection. If None, set keep_in_collections to False to remove the item from all collections.
keep_in_collections – boolean (optional) If True, the given entry is not removed from any existing collections it is already in.
kwargs – Other parameters to pass to self.post().

Return type:

gdata.docs.data.Resource of the moved entry.

PublishRevision(entry, publish_auto=None, publish_outside_domain=False, **kwargs)¶

Publishes the given revision.

This method can only be used for document revisions.

Parameters:

entry – Revision to update.
publish_auto – True to automatically publish future revisions of the document. False to not automatically publish future revisions. None to take no action and use the default value.
publish_outside_domain – True to make the published revision available outside of a Google Apps domain. False to not publish outside the domain. None to use the default value.
kwargs – Other parameters to pass to super(DocsClient, self).update().

Return type:

gdata.docs.data.Revision representing the updated revision.

Put(uri=None, data=None, auth_token=None, http_request=None, **kwargs)¶: Sends data using the PUT method, returns an HTTP response.

Request(method=None, uri=None, **kwargs)¶

Add support for imitating other users via 2-Legged OAuth.

Parameters:	uri – (optional) URI of the request in which to replace default with self.xoauth_requestor_id.
Return type:	Result of super(DocsClient, self).request().

RevokeToken(token=None, url=<atom.http_core.Uri object at 0x2692110>)¶

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).

Return type:	True if the server responded with a 200. Raises: A RequestError if the server responds with a non-200 status.

UnpublishRevision(entry, **kwargs)¶

Unpublishes the given revision.

This method can only be used for document revisions.

Parameters:	entry – Revision to update. kwargs – Other parameters to pass to super(DocsClient, self).update().
Return type:	gdata.docs.data.Revision representing the updated revision.

Update(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.

Parameters:

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.

Return type:

A new Entry object of a matching type to the entry which was passed in.

UpdateAclEntry(entry, send_notifications=None, **kwargs)¶

Updates the given AclEntry with new metadata.

Parameters:	entry – AclEntry to update. Make any metadata changes to this entry. send_notifications – True if users should be notified by email when this AclEntry is updated. kwargs – Other parameters to pass to super(DocsClient, self).update().
Return type:	gdata.docs.data.AclEntry representing the updated ACL entry.

UpdateArchive(entry, **kwargs)¶

Updates the given Archive with new metadata.

This method is really only useful for updating the notification email address of an archive that is being processed.

Parameters:	entry – Archive to update. Make any metadata changes to this entry. kwargs – Other parameters to pass to super(DocsClient, self).update().
Return type:	gdata.docs.data.Archive representing the updated archive.

UpdateResource(entry, media=None, update_metadata=True, new_revision=False, **kwargs)¶

Updates an entry in Google Docs with new metadata and/or new data.

Parameters:

entry – Entry to update. Make any metadata changes to this entry.
media – (optional) gdata.data.MediaSource object containing the file with which to replace the entry’s data.
update_metadata – (optional) True to update the metadata from the entry itself. You might set this to False to only update an entry’s file content, and not its metadata.
new_revision – (optional) True to create a new revision with this update, False otherwise.
kwargs – Other parameters to pass to self.post().

Return type:

gdata.docs.data.Resource representing the updated entry.

UpgradeToken(token=None, url=<atom.http_core.Uri object at 0x26920d0>)¶

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

Parameters:

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
request should be sent. Defaults to (upgrade) –
https – //www.google.com/accounts/AuthSubSessionToken

Return type:

The upgraded gdata.gauth.AuthSubToken object.

add_acl_entry(resource, acl_entry, send_notifications=None, **kwargs)[source]¶

Adds the given AclEntry to the given Resource.

Parameters:	resource – gdata.docs.data.Resource to which to add AclEntry. acl_entry – gdata.docs.data.AclEntry representing ACL entry to add. send_notifications – True if users should be notified by email when this AclEntry is added. kwargs – Other parameters to pass to self.post().
Return type:	gdata.docs.data.AclEntry containing information about new entry. Raises: ValueError: If given resource has no ACL link.

batch(feed, uri=None, force=False, auth_token=None, **kwargs)¶

Sends a batch request to the server to execute operation entries.

Parameters:

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.

batch_process_acl_entries(resource, entries, **kwargs)[source]¶

Applies the specified operation of each entry in a single request.

To use this, simply set acl_entry.batch_operation to one of [‘query’, ‘insert’, ‘update’, ‘delete’], and optionally set acl_entry.batch_id to a string of your choice.

Then, put all of your modified AclEntry objects into a list and pass that list as the entries parameter.

Parameters:	resource – gdata.docs.data.Resource to which the given entries belong. entries – [gdata.docs.data.AclEntry] to modify in some way. kwargs – Other args to pass to gdata.client.GDClient.post()
Return type:	Resulting gdata.docs.data.AclFeed of changes.

client_login(email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object at 0x2692090>, 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

Parameters:

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 –
RequestError or one of its suclasses (A) – BadAuthentication, BadAuthenticationServiceURL, ClientLoginFailed, ClientLoginTokenMissing, or CaptchaChallenge

copy_resource(entry, title, **kwargs)[source]¶

Copies the given entry to a new entry with the given title.

Note: Files do not support this feature.

Parameters:	entry – gdata.docs.data.Resource to copy. title – String title for the new entry. kwargs – Other parameters to pass to self.post().
Return type:	gdata.docs.data.Resource representing duplicated resource.

create_archive(entry, **kwargs)[source]¶

Creates a new archive of resources.

Parameters:	entry – gdata.docs.data.Archive representing metadata of archive to create. kwargs – Other parameters to pass to self.post().
Return type:	gdata.docs.data.Archive containing information about new archive.

create_resource(entry, media=None, collection=None, create_uri=None, **kwargs)[source]¶

Creates new entries in Google Docs, and uploads their contents.

Parameters:

entry – gdata.docs.data.Resource representing initial version of entry being created. If media is also provided, the entry will first be created with the given metadata and content.
media – (optional) gdata.data.MediaSource containing the file to be uploaded.
collection – (optional) gdata.docs.data.Resource representing a collection in which this new entry should be created. If provided along with create_uri, create_uri will win (e.g. entry will be created at create_uri, not necessarily in given collection).
create_uri – (optional) String URI at which to create the given entry. If collection, media and create_uri are None, use gdata.docs.client.RESOURCE_FEED_URI. If collection and create_uri are None, use gdata.docs.client.RESOURCE_UPLOAD_URI. If collection and media are not None, collection.GetResumableCreateMediaLink() is used, with the collection’s resource ID substituted in.
kwargs – Other parameters to pass to self.post() and self.update().

Return type:

gdata.docs.data.Resource containing information about new entry.

delete_acl_entry(entry, **kwargs)[source]¶

Deletes the given AclEntry.

Parameters:	entry – gdata.docs.data.AclEntry to delete. kwargs – Other args to pass to gdata.client.GDClient.Delete()
Return type:	Result of delete request.

delete_archive(entry, **kwargs)[source]¶

Aborts the given Archive operation, or deletes the Archive.

Parameters:	entry – gdata.docs.data.Archive to delete. kwargs – Other args to pass to gdata.client.GDClient.Delete()
Return type:	Result of delete request.

delete_resource(entry, permanent=False, **kwargs)[source]¶

Trashes or deletes the given entry.

Parameters:	entry – gdata.docs.data.Resource to trash or delete. permanent – True to skip the trash and delete the entry forever. kwargs – Other args to pass to gdata.client.GDClient.Delete()
Return type:	Result of delete request.

delete_revision(entry, **kwargs)[source]¶

Deletes the given Revision.

Parameters:	entry – gdata.docs.data.Revision to delete. kwargs – Other args to pass to gdata.client.GDClient.Delete()
Return type:	Result of delete request.

download_archive(entry, file_path, extra_params=None, **kwargs)¶

Downloads the contents of the given entry to disk.

Note: to download a file in memory, use the DownloadResourceToMemory() method.

Parameters:

entry – gdata.docs.data.Resource whose contents to fetch.
file_path – str Full path to which to save file.
extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. For example, exporting a
as a .csv (spreadsheet) – extra_params={‘gid’: 0, ‘exportFormat’: ‘csv’}
kwargs – Other parameters to pass to self._download_file().
Raises – gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

download_archive_to_memory(entry, extra_params=None, **kwargs)¶

Returns the contents of the given entry.

Parameters:	entry – gdata.docs.data.Resource whose contents to fetch. extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. For example, exporting a as a .csv (spreadsheet) – extra_params={‘gid’: 0, ‘exportFormat’: ‘csv’} kwargs – Other parameters to pass to self._get_content().
Return type:	Content of given resource after being downloaded. Raises: gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

download_resource(entry, file_path, extra_params=None, **kwargs)[source]¶

Downloads the contents of the given entry to disk.

Note: to download a file in memory, use the DownloadResourceToMemory() method.

Parameters:

entry – gdata.docs.data.Resource whose contents to fetch.
file_path – str Full path to which to save file.
extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. For example, exporting a
as a .csv (spreadsheet) – extra_params={‘gid’: 0, ‘exportFormat’: ‘csv’}
kwargs – Other parameters to pass to self._download_file().
Raises – gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

download_resource_to_memory(entry, extra_params=None, **kwargs)[source]¶

Returns the contents of the given entry.

Parameters:	entry – gdata.docs.data.Resource whose contents to fetch. extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. For example, exporting a as a .csv (spreadsheet) – extra_params={‘gid’: 0, ‘exportFormat’: ‘csv’} kwargs – Other parameters to pass to self._get_content().
Return type:	Content of given resource after being downloaded. Raises: gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

download_revision(entry, file_path, extra_params=None, **kwargs)[source]¶

Downloads the contents of the given revision to disk.

Note: to download a revision in memory, use the DownloadRevisionToMemory() method.

Parameters:

entry – gdata.docs.data.Revision whose contents to fetch.
file_path – str Full path to which to save file.
extra_params – dict (optional) A map of any further parameters to control how the document is downloaded.
kwargs – Other parameters to pass to self._download_file().
Raises – gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

download_revision_to_memory(entry, extra_params=None, **kwargs)[source]¶

Returns the contents of the given revision.

Parameters:	entry – gdata.docs.data.Revision whose contents to fetch. extra_params – dict (optional) A map of any further parameters to control how the document is downloaded/exported. kwargs – Other parameters to pass to self._get_content().
Return type:	Content of given revision after being downloaded. Raises: gdata.client.RequestError if the download URL is malformed or the server’s response was not successful.

get(uri=None, auth_token=None, http_request=None, **kwargs)¶: Performs a request using the GET method, returns an HTTP response.

get_access_token(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

Parameters:	request_token – An OAuth token which has been authorized by the user. url – (optional) The URL to which the upgrade request should be sent. to (Defaults) – https://www.google.com/accounts/OAuthAuthorizeToken

get_acl(entry, **kwargs)[source]¶

Retrieves an AclFeed for the given resource.

Parameters:	entry – gdata.docs.data.Resource to fetch AclFeed for. kwargs – Other args to pass to GetFeed().
Return type:	gdata.docs.data.AclFeed representing retrieved entries.

get_acl_entry(entry, **kwargs)[source]¶

Retrieves an AclEntry again.

This is useful if you need to poll for an ACL changing.

Parameters:	entry – gdata.docs.data.AclEntry to fetch and return. kwargs – Other args to pass to GetAclEntryBySelfLink().
Return type:	gdata.docs.data.AclEntry representing retrieved entry.

get_acl_entry_by_self_link(self_link, **kwargs)[source]¶

Retrieves a particular AclEntry by its self link.

Parameters:	self_link – URI at which to query for given ACL entry. This can be found using entry.GetSelfLink(). kwargs – Other parameters to pass to self.get_entry().
Return type:	gdata.docs.data.AclEntry representing the retrieved entry.

get_all_resources(uri=None, show_root=None, **kwargs)[source]¶

Retrieves all of a user’s non-collections or everything at the given URI.

Folders are not included in this by default. Pass in a custom URI to include collections in your query. The DocsQuery class is an easy way to generate such a URI.

This method makes multiple HTTP requests (by following the feed’s next links) in order to fetch the user’s entire document list.

Parameters:	uri – (optional) URI to query the doclist feed with. If None, then use DocsClient.RESOURCE_FEED_URI, which will retrieve all non-collections. show_root – (optional) True to include indications if a resource is in the root collection. kwargs – Other parameters to pass to self.GetResources().
Return type:	List of gdata.docs.data.Resource objects representing the retrieved entries.

get_archive(entry, **kwargs)[source]¶

Retrieves an archive again given its entry.

This is useful if you need to poll for an archive completing.

Parameters:	entry – gdata.docs.data.Archive to fetch and return. kwargs – Other args to pass to GetArchiveBySelfLink().
Return type:	gdata.docs.data.Archive representing retrieved archive.

get_archive_by_self_link(self_link, **kwargs)[source]¶

Retrieves a particular archive by its self link.

Parameters:	self_link – URI at which to query for given archive. This can be found using entry.GetSelfLink(). kwargs – Other parameters to pass to self.get_entry().
Return type:	gdata.docs.data.Archive representing the retrieved archive.

get_changes(changestamp=None, max_results=None, show_root=None, **kwargs)[source]¶

Retrieves changes to a user’s documents list.

Parameters:

changestamp – (optional) String changestamp value to query since. If provided, returned changes will have a changestamp larger than the given one.
max_results – (optional) Number of results to fetch. API will limit this number to 100 at most.
show_root – (optional) True to include indications if a resource is in the root collection.
kwargs – Other parameters to pass to self.get_feed().

Return type:

gdata.docs.data.ChangeFeed.

get_metadata(**kwargs)[source]¶

Retrieves the metadata of a user account.

Parameters:	kwargs – Other parameters to pass to self.get_entry().
Return type:	gdata.docs.data.Metadata representing metadata of user’s account.

get_next(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.

Return type:	A new feed object containing the next set of entries in this feed.

get_oauth_token(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

Parameters:

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
Google Calendar API, you would want to use scopes (the) –
[‘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.

get_resource(entry, **kwargs)[source]¶

Retrieves a resource again given its entry.

Parameters:	entry – gdata.docs.data.Resource to fetch and return. kwargs – Other args to pass to GetResourceBySelfLink().
Return type:	gdata.docs.data.Resource representing retrieved resource.

get_resource_acl(entry, **kwargs)[source]¶

Retrieves the ACL sharing permissions for the given entry.

Parameters:	entry – gdata.docs.data.Resource for which to get ACL. kwargs – Other parameters to pass to self.get_feed().
Return type:	gdata.docs.data.AclFeed representing the resource’s ACL.

get_resource_by_id(resource_id, **kwargs)[source]¶

Retrieves a resource again given its resource ID.

Parameters:	resource_id – Typed or untyped resource ID of a resource. kwargs – Other args to pass to GetResourceBySelfLink().
Return type:	gdata.docs.data.Resource representing retrieved resource.

get_resource_by_self_link(uri, etag=None, show_root=None, **kwargs)[source]¶

Retrieves a particular resource by its self link.

Parameters:

uri – str URI at which to query for given resource. This can be found using entry.GetSelfLink().
etag – str (optional) The document/item’s etag value to be used in a
GET. See http (conditional) – //code.google.com/apis/documents/docs/3.0/ developers_guide_protocol.html#RetrievingCached.
show_root – (optional) True to include indications if a resource is in the root collection.
kwargs – Other parameters to pass to self.get_entry().

Return type:

gdata.docs.data.Resource representing the retrieved resource.

get_resources(uri=None, limit=None, show_root=None, **kwargs)[source]¶

Retrieves the resources in a user’s docslist, or the given URI.

Parameters:

uri – (optional) URI to query for resources. If None, then gdata.docs.client.DocsClient.RESOURCE_FEED_URI is used, which will query for all non-collections.
limit – int (optional) A maximum cap for the number of results to return in the feed. By default, the API returns a maximum of 100 per page. Thus, if you set limit=5000, you will get <= 5000 documents (guarenteed no more than 5000), and will need to follow the feed’s next links (feed.GetNextLink()) to the rest. See get_everything(). Similarly, if you set limit=50, only <= 50
are returned. Note (documents) – if the max-results parameter is set in the uri parameter, it is chosen over a value set for limit.
show_root – (optional) True to include indications if a resource is in the root collection.
kwargs – Other parameters to pass to self.get_feed().

Return type:

gdata.docs.data.ResourceFeed feed.

get_revision(entry, **kwargs)[source]¶

Retrieves a revision again given its entry.

Parameters:	entry – gdata.docs.data.Revision to fetch and return. kwargs – Other args to pass to GetRevisionBySelfLink().
Return type:	gdata.docs.data.Revision representing retrieved revision.

get_revision_by_self_link(self_link, **kwargs)[source]¶

Retrieves a particular reivision by its self link.

Parameters:	self_link – URI at which to query for given revision. This can be found using entry.GetSelfLink(). kwargs – Other parameters to pass to self.get_entry().
Return type:	gdata.docs.data.Revision representing the retrieved revision.

get_revisions(entry, **kwargs)[source]¶

Retrieves the revision history for a resource.

Parameters:	entry – gdata.docs.data.Resource for which to get revisions. kwargs – Other parameters to pass to self.get_feed().
Return type:	gdata.docs.data.RevisionFeed representing the resource’s revisions.

modify_request(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.

move_resource(entry, collection=None, keep_in_collections=False, **kwargs)[source]¶

Moves an item into a different collection (or out of all collections).

Parameters:

entry – gdata.docs.data.Resource to move.
collection – gdata.docs.data.Resource (optional) An object representing the destination collection. If None, set keep_in_collections to False to remove the item from all collections.
keep_in_collections – boolean (optional) If True, the given entry is not removed from any existing collections it is already in.
kwargs – Other parameters to pass to self.post().

Return type:

gdata.docs.data.Resource of the moved entry.

publish_revision(entry, publish_auto=None, publish_outside_domain=False, **kwargs)[source]¶

Publishes the given revision.

This method can only be used for document revisions.

Parameters:

entry – Revision to update.
publish_auto – True to automatically publish future revisions of the document. False to not automatically publish future revisions. None to take no action and use the default value.
publish_outside_domain – True to make the published revision available outside of a Google Apps domain. False to not publish outside the domain. None to use the default value.
kwargs – Other parameters to pass to super(DocsClient, self).update().

Return type:

gdata.docs.data.Revision representing the updated revision.

put(uri=None, data=None, auth_token=None, http_request=None, **kwargs)¶: Sends data using the PUT method, returns an HTTP response.

request(method=None, uri=None, **kwargs)[source]¶

Add support for imitating other users via 2-Legged OAuth.

Parameters:	uri – (optional) URI of the request in which to replace default with self.xoauth_requestor_id.
Return type:	Result of super(DocsClient, self).request().

revoke_token(token=None, url=<atom.http_core.Uri object at 0x2692110>)¶

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).

Return type:	True if the server responded with a 200. Raises: A RequestError if the server responds with a non-200 status.

unpublish_revision(entry, **kwargs)[source]¶

Unpublishes the given revision.

This method can only be used for document revisions.

Parameters:	entry – Revision to update. kwargs – Other parameters to pass to super(DocsClient, self).update().
Return type:	gdata.docs.data.Revision representing the updated revision.

update(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.

Parameters:

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.

Return type:

A new Entry object of a matching type to the entry which was passed in.

update_acl_entry(entry, send_notifications=None, **kwargs)[source]¶

Updates the given AclEntry with new metadata.

Parameters:	entry – AclEntry to update. Make any metadata changes to this entry. send_notifications – True if users should be notified by email when this AclEntry is updated. kwargs – Other parameters to pass to super(DocsClient, self).update().
Return type:	gdata.docs.data.AclEntry representing the updated ACL entry.

update_archive(entry, **kwargs)[source]¶

Updates the given Archive with new metadata.

This method is really only useful for updating the notification email address of an archive that is being processed.

Parameters:	entry – Archive to update. Make any metadata changes to this entry. kwargs – Other parameters to pass to super(DocsClient, self).update().
Return type:	gdata.docs.data.Archive representing the updated archive.

update_resource(entry, media=None, update_metadata=True, new_revision=False, **kwargs)[source]¶

Updates an entry in Google Docs with new metadata and/or new data.

Parameters:

entry – Entry to update. Make any metadata changes to this entry.
media – (optional) gdata.data.MediaSource object containing the file with which to replace the entry’s data.
update_metadata – (optional) True to update the metadata from the entry itself. You might set this to False to only update an entry’s file content, and not its metadata.
new_revision – (optional) True to create a new revision with this update, False otherwise.
kwargs – Other parameters to pass to self.post().

Return type:

gdata.docs.data.Resource representing the updated entry.

upgrade_token(token=None, url=<atom.http_core.Uri object at 0x26920d0>)¶

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

Parameters:

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
request should be sent. Defaults to (upgrade) –
https – //www.google.com/accounts/AuthSubSessionToken

Return type:

The upgraded gdata.gauth.AuthSubToken object.

Data model classes for representing elements of the Documents List API.

class gdata.docs.data.AclEntry(atom_id=None, text=None, *args, **kwargs)[source]¶

Resource ACL entry.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindMediaLink()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

additional_role¶: alias of AclAdditionalRole

batch_id¶: alias of BatchId

batch_operation¶: alias of BatchOperation

batch_status¶: alias of BatchStatus

content¶: alias of Content

control¶: alias of Control

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_media_link()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

id¶: alias of Id

published¶: alias of Published

rights¶: alias of Rights

role¶: alias of AclRole

scope¶: alias of AclScope

source¶: alias of Source

summary¶: alias of Summary

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

updated¶: alias of Updated

with_key¶: alias of AclWithKey

class gdata.docs.data.AclFeed(atom_id=None, text=None, *args, **kwargs)[source]¶

Resource ACL feed.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

generator¶: alias of Generator

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

icon¶: alias of Icon

id¶: alias of Id

items_per_page¶: alias of ItemsPerPage

logo¶: alias of Logo

rights¶: alias of Rights

start_index¶: alias of StartIndex

subtitle¶: alias of Subtitle

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

total_results¶: alias of TotalResults

updated¶: alias of Updated

class gdata.docs.data.AdditionalRoleInfo(text=None, *args, **kwargs)[source]¶

The DocList docs:additionalRoleInfo element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.AdditionalRoleSet(text=None, *args, **kwargs)[source]¶

The DocList docs:additionalRoleSet element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.Archive(atom_id=None, text=None, *args, **kwargs)[source]¶

Archive entry.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindMediaLink()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

content¶: alias of Content

control¶: alias of Control

date_completed¶: alias of ArchiveComplete

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_media_link()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

id¶: alias of Id

notification_email¶: alias of ArchiveNotify

notify_status¶: alias of ArchiveNotifyStatus

num_complete_resources¶: alias of ArchiveTotalComplete

num_failed_resources¶: alias of ArchiveTotalFailure

num_resources¶: alias of ArchiveTotal

published¶: alias of Published

rights¶: alias of Rights

size¶: alias of QuotaBytesUsed

source¶: alias of Source

status¶: alias of ArchiveStatus

summary¶: alias of Summary

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

updated¶: alias of Updated

class gdata.docs.data.ArchiveComplete(text=None, *args, **kwargs)[source]¶

The DocList docs:archiveComplete element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ArchiveConversion(text=None, *args, **kwargs)[source]¶

The DocList docs:removed element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ArchiveFailure(text=None, *args, **kwargs)[source]¶

The DocList docs:archiveFailure element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ArchiveNotify(text=None, *args, **kwargs)[source]¶

The DocList docs:archiveNotify element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ArchiveNotifyStatus(text=None, *args, **kwargs)[source]¶

The DocList docs:archiveNotifyStatus element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ArchiveResourceId(text=None, *args, **kwargs)[source]¶

The DocList docs:removed element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ArchiveStatus(text=None, *args, **kwargs)[source]¶

The DocList docs:archiveStatus element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ArchiveTotal(text=None, *args, **kwargs)[source]¶

The DocList docs:archiveTotal element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ArchiveTotalComplete(text=None, *args, **kwargs)[source]¶

The DocList docs:archiveTotalComplete element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ArchiveTotalFailure(text=None, *args, **kwargs)[source]¶

The DocList docs:archiveTotalFailure element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.CategoryFinder[source]¶

Mixin to provide category finding functionality.

Analogous to atom.data.LinkFinder, but a simpler API, specialized for DocList categories.

AddCategory(scheme, term, label)¶

Add a category for a scheme, term and label.

Parameters:	scheme – The scheme for the category. term – The term for the category. label – The label for the category
Return type:	The newly created atom.data.Category.

AddLabel(label)¶

Add a label, if it is not present.

Parameters:	label – The str label to set

GetCategories(scheme)¶

Fetch the category elements for a scheme.

Parameters:	scheme – The scheme to fetch the elements for.
Return type:	Generator of atom.data.Category elements.

GetFirstCategory(scheme)¶

Fetch the first category element for a scheme.

Parameters:	scheme – The scheme of category to return.
Return type:	atom.data.Category if found or None.

GetLabels()¶

Extracts the labels for this Resource.

This method returns the labels as a set, for example: ‘hidden’, ‘starred’, ‘viewed’.

Return type:	Set of string labels.

GetResourceType()¶

Extracts the type of document this Resource is.

This method returns the type of document the Resource represents. Possible values are document, presentation, drawing, spreadsheet, file, folder, form, item, or pdf.

‘folder’ is a possible return value of this method because, for legacy support, we have not yet renamed the folder keyword to collection in the API itself.

Return type:	String representing the type of document.

HasLabel(label)¶

Whether this Resource has a label.

Parameters:	label – The str label to test for
Return type:	Boolean value indicating presence of label.

IsHidden()¶

Whether this Resource is hidden.

Return type:	Boolean value indicating that the resource is hidden.

IsMine()¶

Whether this resource is marked as mine.

Return type:	Boolean value indicating that the resource is marked as mine.

IsPrivate()¶

Whether this resource is private.

Return type:	Boolean value indicating that the resource is private.

IsRestrictedDownload()¶

Whether this resource is restricted download.

Return type:	Boolean value indicating whether the resource is restricted download.

IsSharedWithDomain()¶

Whether this resource is shared with the domain.

Return type:	Boolean value indicating that the resource is shared with the domain.

IsStarred()¶

Whether this Resource is starred.

Return type:	Boolean value indicating that the resource is starred.

IsTrashed()¶

Whether this resource is trashed.

Return type:	Boolean value indicating that the resource is trashed.

IsViewed()¶

Whether this Resource is viewed.

Return type:	Boolean value indicating that the resource is viewed.

RemoveCategories(scheme)¶

Remove category elements for a scheme.

Parameters:	scheme – The scheme of category to remove.

RemoveLabel(label)¶

Remove a label, if it is present.

Parameters:	label – The str label to remove

SetResourceType(label)¶

Set the document type for an entry, by building the appropriate atom.data.Category

Parameters:	label – str The value for the category entry. If None is passed the category is removed and not set.
Return type:	An atom.data.Category or None if label is None.

add_category(scheme, term, label)[source]¶

Add a category for a scheme, term and label.

Parameters:	scheme – The scheme for the category. term – The term for the category. label – The label for the category
Return type:	The newly created atom.data.Category.

add_label(label)[source]¶

Add a label, if it is not present.

Parameters:	label – The str label to set

get_categories(scheme)[source]¶

Fetch the category elements for a scheme.

Parameters:	scheme – The scheme to fetch the elements for.
Return type:	Generator of atom.data.Category elements.

get_first_category(scheme)[source]¶

Fetch the first category element for a scheme.

Parameters:	scheme – The scheme of category to return.
Return type:	atom.data.Category if found or None.

get_labels()[source]¶

Extracts the labels for this Resource.

This method returns the labels as a set, for example: ‘hidden’, ‘starred’, ‘viewed’.

Return type:	Set of string labels.

get_resource_type()[source]¶

Extracts the type of document this Resource is.

This method returns the type of document the Resource represents. Possible values are document, presentation, drawing, spreadsheet, file, folder, form, item, or pdf.

‘folder’ is a possible return value of this method because, for legacy support, we have not yet renamed the folder keyword to collection in the API itself.

Return type:	String representing the type of document.

has_label(label)[source]¶

Whether this Resource has a label.

Parameters:	label – The str label to test for
Return type:	Boolean value indicating presence of label.

is_hidden()[source]¶

Whether this Resource is hidden.

Return type:	Boolean value indicating that the resource is hidden.

is_mine()[source]¶

Whether this resource is marked as mine.

Return type:	Boolean value indicating that the resource is marked as mine.

is_private()[source]¶

Whether this resource is private.

Return type:	Boolean value indicating that the resource is private.

is_restricted_download()[source]¶

Whether this resource is restricted download.

Return type:	Boolean value indicating whether the resource is restricted download.

is_shared_with_domain()[source]¶

Whether this resource is shared with the domain.

Return type:	Boolean value indicating that the resource is shared with the domain.

is_starred()[source]¶

Whether this Resource is starred.

Return type:	Boolean value indicating that the resource is starred.

is_trashed()[source]¶

Whether this resource is trashed.

Return type:	Boolean value indicating that the resource is trashed.

is_viewed()[source]¶

Whether this Resource is viewed.

Return type:	Boolean value indicating that the resource is viewed.

remove_categories(scheme)[source]¶

Remove category elements for a scheme.

Parameters:	scheme – The scheme of category to remove.

remove_label(label)[source]¶

Remove a label, if it is present.

Parameters:	label – The str label to remove

set_resource_type(label)[source]¶

Set the document type for an entry, by building the appropriate atom.data.Category

Parameters:	label – str The value for the category entry. If None is passed the category is removed and not set.
Return type:	An atom.data.Category or None if label is None.

class gdata.docs.data.Change(type=None, title=None, **kwargs)[source]¶

Change feed entry.

AddCategory(scheme, term, label)¶

Add a category for a scheme, term and label.

Parameters:	scheme – The scheme for the category. term – The term for the category. label – The label for the category
Return type:	The newly created atom.data.Category.

AddLabel(label)¶

Add a label, if it is not present.

Parameters:	label – The str label to set

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindMediaLink()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclFeedLink()¶

Extracts the Resource’s ACL feed <gd:feedLink>.

Return type:	A gdata.data.FeedLink object.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetCategories(scheme)¶

Fetch the category elements for a scheme.

Parameters:	scheme – The scheme to fetch the elements for.
Return type:	Generator of atom.data.Category elements.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetFirstCategory(scheme)¶

Fetch the first category element for a scheme.

Parameters:	scheme – The scheme of category to return.
Return type:	atom.data.Category if found or None.

GetLabels()¶

Extracts the labels for this Resource.

This method returns the labels as a set, for example: ‘hidden’, ‘starred’, ‘viewed’.

Return type:	Set of string labels.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

GetResourceType()¶

Extracts the type of document this Resource is.

This method returns the type of document the Resource represents. Possible values are document, presentation, drawing, spreadsheet, file, folder, form, item, or pdf.

‘folder’ is a possible return value of this method because, for legacy support, we have not yet renamed the folder keyword to collection in the API itself.

Return type:	String representing the type of document.

GetResumableCreateMediaLink()¶

Extracts the Resource’s resumable create link.

Return type:	A gdata.data.FeedLink object.

GetResumableEditMediaLink()¶

Extracts the Resource’s resumable update link.

Return type:	A gdata.data.FeedLink object.

GetRevisionsFeedLink()¶

Extracts the Resource’s revisions feed <gd:feedLink>.

Return type:	A gdata.data.FeedLink object.

HasLabel(label)¶

Whether this Resource has a label.

Parameters:	label – The str label to test for
Return type:	Boolean value indicating presence of label.

InCollections()¶: Returns the parents link(s) (collections) of this entry.

IsHidden()¶

Whether this Resource is hidden.

Return type:	Boolean value indicating that the resource is hidden.

IsMine()¶

Whether this resource is marked as mine.

Return type:	Boolean value indicating that the resource is marked as mine.

IsPrivate()¶

Whether this resource is private.

Return type:	Boolean value indicating that the resource is private.

IsRestrictedDownload()¶

Whether this resource is restricted download.

Return type:	Boolean value indicating whether the resource is restricted download.

IsSharedWithDomain()¶

Whether this resource is shared with the domain.

Return type:	Boolean value indicating that the resource is shared with the domain.

IsStarred()¶

Whether this Resource is starred.

Return type:	Boolean value indicating that the resource is starred.

IsTrashed()¶

Whether this resource is trashed.

Return type:	Boolean value indicating that the resource is trashed.

IsViewed()¶

Whether this Resource is viewed.

Return type:	Boolean value indicating that the resource is viewed.

RemoveCategories(scheme)¶

Remove category elements for a scheme.

Parameters:	scheme – The scheme of category to remove.

RemoveLabel(label)¶

Remove a label, if it is present.

Parameters:	label – The str label to remove

SetResourceType(label)¶

Set the document type for an entry, by building the appropriate atom.data.Category

Parameters:	label – str The value for the category entry. If None is passed the category is removed and not set.
Return type:	An atom.data.Category or None if label is None.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

acl_feed¶: alias of AclFeed

add_category(scheme, term, label)¶

Add a category for a scheme, term and label.

Parameters:	scheme – The scheme for the category. term – The term for the category. label – The label for the category
Return type:	The newly created atom.data.Category.

add_label(label)¶

Add a label, if it is not present.

Parameters:	label – The str label to set

changestamp¶: alias of Changestamp

content¶: alias of Content

control¶: alias of Control

deleted¶: alias of Deleted

filename¶: alias of Filename

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_media_link()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

get_acl_feed_link()¶

Extracts the Resource’s ACL feed <gd:feedLink>.

Return type:	A gdata.data.FeedLink object.

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_categories(scheme)¶

Fetch the category elements for a scheme.

Parameters:	scheme – The scheme to fetch the elements for.
Return type:	Generator of atom.data.Category elements.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_first_category(scheme)¶

Fetch the first category element for a scheme.

Parameters:	scheme – The scheme of category to return.
Return type:	atom.data.Category if found or None.

get_labels()¶

Extracts the labels for this Resource.

This method returns the labels as a set, for example: ‘hidden’, ‘starred’, ‘viewed’.

Return type:	Set of string labels.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

get_resource_type()¶

Extracts the type of document this Resource is.

This method returns the type of document the Resource represents. Possible values are document, presentation, drawing, spreadsheet, file, folder, form, item, or pdf.

‘folder’ is a possible return value of this method because, for legacy support, we have not yet renamed the folder keyword to collection in the API itself.

Return type:	String representing the type of document.

get_resumable_create_media_link()¶

Extracts the Resource’s resumable create link.

Return type:	A gdata.data.FeedLink object.

get_resumable_edit_media_link()¶

Extracts the Resource’s resumable update link.

Return type:	A gdata.data.FeedLink object.

get_revisions_feed_link()¶

Extracts the Resource’s revisions feed <gd:feedLink>.

Return type:	A gdata.data.FeedLink object.

has_label(label)¶

Whether this Resource has a label.

Parameters:	label – The str label to test for
Return type:	Boolean value indicating presence of label.

id¶: alias of Id

in_collections()¶: Returns the parents link(s) (collections) of this entry.

is_hidden()¶

Whether this Resource is hidden.

Return type:	Boolean value indicating that the resource is hidden.

is_mine()¶

Whether this resource is marked as mine.

Return type:	Boolean value indicating that the resource is marked as mine.

is_private()¶

Whether this resource is private.

Return type:	Boolean value indicating that the resource is private.

is_restricted_download()¶

Whether this resource is restricted download.

Return type:	Boolean value indicating whether the resource is restricted download.

is_shared_with_domain()¶

Whether this resource is shared with the domain.

Return type:	Boolean value indicating that the resource is shared with the domain.

is_starred()¶

Whether this Resource is starred.

Return type:	Boolean value indicating that the resource is starred.

is_trashed()¶

Whether this resource is trashed.

Return type:	Boolean value indicating that the resource is trashed.

is_viewed()¶

Whether this Resource is viewed.

Return type:	Boolean value indicating that the resource is viewed.

last_modified_by¶: alias of LastModifiedBy

last_viewed¶: alias of LastViewed

published¶: alias of Published

quota_bytes_used¶: alias of QuotaBytesUsed

remove_categories(scheme)¶

Remove category elements for a scheme.

Parameters:	scheme – The scheme of category to remove.

remove_label(label)¶

Remove a label, if it is present.

Parameters:	label – The str label to remove

removed¶: alias of Removed

resource_id¶: alias of ResourceId

rights¶: alias of Rights

set_resource_type(label)¶

Set the document type for an entry, by building the appropriate atom.data.Category

Parameters:	label – str The value for the category entry. If None is passed the category is removed and not set.
Return type:	An atom.data.Category or None if label is None.

source¶: alias of Source

suggested_filename¶: alias of SuggestedFilename

summary¶: alias of Summary

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

updated¶: alias of Updated

writers_can_invite¶: alias of WritersCanInvite

class gdata.docs.data.ChangeFeed(atom_id=None, text=None, *args, **kwargs)[source]¶

DocList Changes feed.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

generator¶: alias of Generator

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

icon¶: alias of Icon

id¶: alias of Id

items_per_page¶: alias of ItemsPerPage

logo¶: alias of Logo

rights¶: alias of Rights

start_index¶: alias of StartIndex

subtitle¶: alias of Subtitle

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

total_results¶: alias of TotalResults

updated¶: alias of Updated

class gdata.docs.data.Changestamp(text=None, *args, **kwargs)[source]¶

The DocList docs:changestamp element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.Deleted(text=None, *args, **kwargs)[source]¶

The DocList gd:deleted element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ExportFormat(text=None, *args, **kwargs)[source]¶

The DocList docs:exportFormat element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.Feature(text=None, *args, **kwargs)[source]¶

The DocList docs:feature element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

name¶: alias of FeatureName

rate¶: alias of FeatureRate

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.FeatureName(text=None, *args, **kwargs)[source]¶

The DocList docs:featureName element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.FeatureRate(text=None, *args, **kwargs)[source]¶

The DocList docs:featureRate element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.Filename(text=None, *args, **kwargs)[source]¶

The DocList docs:filename element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.ImportFormat(text=None, *args, **kwargs)[source]¶

The DocList docs:importFormat element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.LastModifiedBy(text=None, *args, **kwargs)[source]¶

The DocList gd:lastModifiedBy element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

email¶: alias of Email

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

name¶: alias of Name

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

uri¶: alias of Uri

class gdata.docs.data.LastViewed(text=None, *args, **kwargs)[source]¶

The DocList gd:lastViewed element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

email¶: alias of Email

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

name¶: alias of Name

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

uri¶: alias of Uri

class gdata.docs.data.MaxUploadSize(text=None, *args, **kwargs)[source]¶

The DocList docs:maxUploadSize element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.Metadata(atom_id=None, text=None, *args, **kwargs)[source]¶

Metadata entry for a user.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindMediaLink()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

content¶: alias of Content

control¶: alias of Control

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_media_link()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

id¶: alias of Id

published¶: alias of Published

quota_bytes_total¶: alias of QuotaBytesTotal

quota_bytes_used¶: alias of QuotaBytesUsed

quota_bytes_used_in_trash¶: alias of QuotaBytesUsedInTrash

rights¶: alias of Rights

source¶: alias of Source

summary¶: alias of Summary

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

updated¶: alias of Updated

class gdata.docs.data.Publish(text=None, *args, **kwargs)[source]¶

The DocList docs:publish element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.PublishAuto(text=None, *args, **kwargs)[source]¶

The DocList docs:publishAuto element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.PublishOutsideDomain(text=None, *args, **kwargs)[source]¶

The DocList docs:publishOutsideDomain element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.QuotaBytesTotal(text=None, *args, **kwargs)[source]¶

The DocList gd:quotaBytesTotal element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.QuotaBytesUsed(text=None, *args, **kwargs)[source]¶

The DocList gd:quotaBytesUsed element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.QuotaBytesUsedInTrash(text=None, *args, **kwargs)[source]¶

The DocList docs:quotaBytesUsedInTrash element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.Removed(text=None, *args, **kwargs)[source]¶

The DocList docs:removed element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.Resource(type=None, title=None, **kwargs)[source]¶

DocList version of an Atom Entry.

AddCategory(scheme, term, label)¶

Add a category for a scheme, term and label.

Parameters:	scheme – The scheme for the category. term – The term for the category. label – The label for the category
Return type:	The newly created atom.data.Category.

AddLabel(label)¶

Add a label, if it is not present.

Parameters:	label – The str label to set

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindMediaLink()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclFeedLink()¶

Extracts the Resource’s ACL feed <gd:feedLink>.

Return type:	A gdata.data.FeedLink object.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetCategories(scheme)¶

Fetch the category elements for a scheme.

Parameters:	scheme – The scheme to fetch the elements for.
Return type:	Generator of atom.data.Category elements.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetFirstCategory(scheme)¶

Fetch the first category element for a scheme.

Parameters:	scheme – The scheme of category to return.
Return type:	atom.data.Category if found or None.

GetLabels()¶

Extracts the labels for this Resource.

This method returns the labels as a set, for example: ‘hidden’, ‘starred’, ‘viewed’.

Return type:	Set of string labels.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

GetResourceType()¶

Extracts the type of document this Resource is.

This method returns the type of document the Resource represents. Possible values are document, presentation, drawing, spreadsheet, file, folder, form, item, or pdf.

‘folder’ is a possible return value of this method because, for legacy support, we have not yet renamed the folder keyword to collection in the API itself.

Return type:	String representing the type of document.

GetResumableCreateMediaLink()¶

Extracts the Resource’s resumable create link.

Return type:	A gdata.data.FeedLink object.

GetResumableEditMediaLink()¶

Extracts the Resource’s resumable update link.

Return type:	A gdata.data.FeedLink object.

GetRevisionsFeedLink()¶

Extracts the Resource’s revisions feed <gd:feedLink>.

Return type:	A gdata.data.FeedLink object.

HasLabel(label)¶

Whether this Resource has a label.

Parameters:	label – The str label to test for
Return type:	Boolean value indicating presence of label.

InCollections()¶: Returns the parents link(s) (collections) of this entry.

IsHidden()¶

Whether this Resource is hidden.

Return type:	Boolean value indicating that the resource is hidden.

IsMine()¶

Whether this resource is marked as mine.

Return type:	Boolean value indicating that the resource is marked as mine.

IsPrivate()¶

Whether this resource is private.

Return type:	Boolean value indicating that the resource is private.

IsRestrictedDownload()¶

Whether this resource is restricted download.

Return type:	Boolean value indicating whether the resource is restricted download.

IsSharedWithDomain()¶

Whether this resource is shared with the domain.

Return type:	Boolean value indicating that the resource is shared with the domain.

IsStarred()¶

Whether this Resource is starred.

Return type:	Boolean value indicating that the resource is starred.

IsTrashed()¶

Whether this resource is trashed.

Return type:	Boolean value indicating that the resource is trashed.

IsViewed()¶

Whether this Resource is viewed.

Return type:	Boolean value indicating that the resource is viewed.

RemoveCategories(scheme)¶

Remove category elements for a scheme.

Parameters:	scheme – The scheme of category to remove.

RemoveLabel(label)¶

Remove a label, if it is present.

Parameters:	label – The str label to remove

SetResourceType(label)¶

Set the document type for an entry, by building the appropriate atom.data.Category

Parameters:	label – str The value for the category entry. If None is passed the category is removed and not set.
Return type:	An atom.data.Category or None if label is None.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

acl_feed¶: alias of AclFeed

add_category(scheme, term, label)¶

Add a category for a scheme, term and label.

Parameters:	scheme – The scheme for the category. term – The term for the category. label – The label for the category
Return type:	The newly created atom.data.Category.

add_label(label)¶

Add a label, if it is not present.

Parameters:	label – The str label to set

content¶: alias of Content

control¶: alias of Control

deleted¶: alias of Deleted

filename¶: alias of Filename

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_media_link()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

get_acl_feed_link()[source]¶

Extracts the Resource’s ACL feed <gd:feedLink>.

Return type:	A gdata.data.FeedLink object.

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_categories(scheme)¶

Fetch the category elements for a scheme.

Parameters:	scheme – The scheme to fetch the elements for.
Return type:	Generator of atom.data.Category elements.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_first_category(scheme)¶

Fetch the first category element for a scheme.

Parameters:	scheme – The scheme of category to return.
Return type:	atom.data.Category if found or None.

get_labels()¶

Extracts the labels for this Resource.

This method returns the labels as a set, for example: ‘hidden’, ‘starred’, ‘viewed’.

Return type:	Set of string labels.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

get_resource_type()¶

Extracts the type of document this Resource is.

This method returns the type of document the Resource represents. Possible values are document, presentation, drawing, spreadsheet, file, folder, form, item, or pdf.

‘folder’ is a possible return value of this method because, for legacy support, we have not yet renamed the folder keyword to collection in the API itself.

Return type:	String representing the type of document.

get_resumable_create_media_link()[source]¶

Extracts the Resource’s resumable create link.

Return type:	A gdata.data.FeedLink object.

get_resumable_edit_media_link()[source]¶

Extracts the Resource’s resumable update link.

Return type:	A gdata.data.FeedLink object.

get_revisions_feed_link()[source]¶

Extracts the Resource’s revisions feed <gd:feedLink>.

Return type:	A gdata.data.FeedLink object.

has_label(label)¶

Whether this Resource has a label.

Parameters:	label – The str label to test for
Return type:	Boolean value indicating presence of label.

id¶: alias of Id

in_collections()[source]¶: Returns the parents link(s) (collections) of this entry.

is_hidden()¶

Whether this Resource is hidden.

Return type:	Boolean value indicating that the resource is hidden.

is_mine()¶

Whether this resource is marked as mine.

Return type:	Boolean value indicating that the resource is marked as mine.

is_private()¶

Whether this resource is private.

Return type:	Boolean value indicating that the resource is private.

is_restricted_download()¶

Whether this resource is restricted download.

Return type:	Boolean value indicating whether the resource is restricted download.

is_shared_with_domain()¶

Whether this resource is shared with the domain.

Return type:	Boolean value indicating that the resource is shared with the domain.

is_starred()¶

Whether this Resource is starred.

Return type:	Boolean value indicating that the resource is starred.

is_trashed()¶

Whether this resource is trashed.

Return type:	Boolean value indicating that the resource is trashed.

is_viewed()¶

Whether this Resource is viewed.

Return type:	Boolean value indicating that the resource is viewed.

last_modified_by¶: alias of LastModifiedBy

last_viewed¶: alias of LastViewed

published¶: alias of Published

quota_bytes_used¶: alias of QuotaBytesUsed

remove_categories(scheme)¶

Remove category elements for a scheme.

Parameters:	scheme – The scheme of category to remove.

remove_label(label)¶

Remove a label, if it is present.

Parameters:	label – The str label to remove

resource_id¶: alias of ResourceId

rights¶: alias of Rights

set_resource_type(label)¶

Set the document type for an entry, by building the appropriate atom.data.Category

Parameters:	label – str The value for the category entry. If None is passed the category is removed and not set.
Return type:	An atom.data.Category or None if label is None.

source¶: alias of Source

suggested_filename¶: alias of SuggestedFilename

summary¶: alias of Summary

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

updated¶: alias of Updated

writers_can_invite¶: alias of WritersCanInvite

class gdata.docs.data.ResourceFeed(atom_id=None, text=None, *args, **kwargs)[source]¶

Main feed containing a list of resources.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

generator¶: alias of Generator

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

icon¶: alias of Icon

id¶: alias of Id

items_per_page¶: alias of ItemsPerPage

logo¶: alias of Logo

rights¶: alias of Rights

start_index¶: alias of StartIndex

subtitle¶: alias of Subtitle

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

total_results¶: alias of TotalResults

updated¶: alias of Updated

class gdata.docs.data.ResourceId(text=None, *args, **kwargs)[source]¶

The DocList gd:resourceId element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.Revision(atom_id=None, text=None, *args, **kwargs)[source]¶

Resource Revision entry.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindMediaLink()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindPublishLink()¶

Get the link that points to the published resource on the web.

Return type:	A str for the URL in the link with a rel ending in #publish.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

GetPublishLink()¶

Get the link that points to the published resource on the web.

Return type:	A gdata.data.Link for the link with a rel ending in #publish.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

content¶: alias of Content

control¶: alias of Control

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_media_link()¶: Returns the URL to the media content, if the entry is a media entry. Otherwise returns None.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_publish_link()[source]¶

Get the link that points to the published resource on the web.

Return type:	A str for the URL in the link with a rel ending in #publish.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

get_publish_link()[source]¶

Get the link that points to the published resource on the web.

Return type:	A gdata.data.Link for the link with a rel ending in #publish.

id¶: alias of Id

publish¶: alias of Publish

publish_auto¶: alias of PublishAuto

publish_outside_domain¶: alias of PublishOutsideDomain

published¶: alias of Published

rights¶: alias of Rights

source¶: alias of Source

summary¶: alias of Summary

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

updated¶: alias of Updated

class gdata.docs.data.RevisionFeed(atom_id=None, text=None, *args, **kwargs)[source]¶

A DocList Revision feed.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindHtmlLink()¶: Finds the first link with rel of alternate and type of text/html.

FindPostLink()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

FindSelfLink()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

FindUrl(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

GetAclLink()¶: Searches for a link or feed_link (if present) with the rel for ACL.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetLink(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

find_html_link()¶: Finds the first link with rel of alternate and type of text/html.

find_post_link()¶

Get the URL to which new entries should be POSTed.

The POST target URL is used to insert new entries.

Return type:	A str for the URL in the link with a rel matching the POST type.

find_self_link()¶

Find the first link with rel set to ‘self’

Return type:	A str containing the link’s href or None if none of the links had rel equal to ‘self’

find_url(rel)¶: Returns the URL (as a string) in a link with the desired rel value.

generator¶: alias of Generator

get_acl_link()¶: Searches for a link or feed_link (if present) with the rel for ACL.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

get_link(rel)¶

Returns a link object which has the desired rel value.

If you are interested in the URL instead of the link object, consider using find_url instead.

icon¶: alias of Icon

id¶: alias of Id

items_per_page¶: alias of ItemsPerPage

logo¶: alias of Logo

rights¶: alias of Rights

start_index¶: alias of StartIndex

subtitle¶: alias of Subtitle

title¶: alias of Title

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

total_results¶: alias of TotalResults

updated¶: alias of Updated

class gdata.docs.data.SuggestedFilename(text=None, *args, **kwargs)[source]¶

The DocList docs:suggestedFilename element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

class gdata.docs.data.WritersCanInvite(text=None, *args, **kwargs)[source]¶

The DocList docs:writersCanInvite element.

FindChildren(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

FindExtensions(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

GetAttributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

GetElements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

ToString(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

get_attributes(tag=None, namespace=None, version=1)¶

Find all attributes which match the tag and namespace.

To find all attributes in this object, call get_attributes with the tag and namespace both set to None (the default). This method searches through the object’s members and the attributes stored in _other_attributes which did not fit any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching attributes.
Return type:	A list of XmlAttribute objects for the matching attributes.

get_elements(tag=None, namespace=None, version=1)¶

Find all sub elements which match the tag and namespace.

To find all elements in this object, call get_elements with the tag and namespace both set to None (the default). This method searches through the object’s members and the elements stored in _other_elements which did not match any of the XML parsing rules for this class.

Parameters:	tag – str namespace – str version – int Specifies the version of the XML rules to be used when searching for matching elements.
Return type:	A list of the matching XmlElements.

to_string(version=1, encoding=None, pretty_print=None)¶: Converts this object to XML.

API¶

Previous topic

Next topic

This Page

Navigation

API¶

Previous topic

Next topic

This Page

Quick search

Navigation