Important: Versions 1 and 2 of the Google Documents List API have been officially deprecated as of April 20, 2012. They will continue to work as per our deprecation policy, but we encourage you to move to the Google Drive API.
This document provides detailed reference documentation for the Google Documents List Data API.
This document is intended for programmers who want to write client applications that can interact with Docs.
Document List feed
Google Documents List feed URI takes the following form:
The visibility parameter has two possible values:
public. In almost all cases, your client should use
private. For more information, see Visibility values, below.
The projection parameter indicates what information is
included in the representation. For example, if your client specifies a projection of
basic, it's requesting an Atom feed without any Google Data extension elements. For a list of values, see Projection values, below.
Currently, in the Documents List feed, only the
private/full combination for visibility and projection is available.
Documents list feed
documents feed lists all the documents for
the Google Account that's associated with the authenticated user:
When the URI includes a id value, then the feed contains only the entry for the document associated with the provided id:
The following table describes the supported visibility values:
||For use whenever you can authenticate the request.||Read/write access if the authenticated user has edit privileges; otherwise, read-only.||Requires authentication.|
The following table describes the supported projection values:
||Full-fidelity feed; contains all spreadsheet data including formulas.||Full read/write access.|
Documents List query parameters reference
Documents List supports the following standard Google Data query parameters:
For more information about the standard parameters, see the Google Data protocol reference document.
In addition to the standard Google Data query parameters, the Documents List Data API uses the following parameters.
||Specifies the search terms for the title of a document.||This parameter used without
||Specifies whether the
The Documents List data API supports the following categories.
||All documents of the corresponding type in the requesting users document list. Type is currently one of (document|spreadsheet|presentation)|
||All documents that have been starred by the requesting user|
||All documents inside the given folder for the requesting user|
Note that category queries can have name conflicts (eg: starred could mean a starred document or a document in a folder named starred). To ensure the desired results, it is best to use scheme qualification for your category terms when there may be a conflict. For more information about category queries see the Google Data protocol reference document query documentation.