My favorites | English | Sign in

Google Documents List Data API

Documents List Data API - Frequently Asked Questions

Main Google Data API FAQ

The questions below are specifically targeted for the Google Documents List Data API. There are, however, many questions that are applicable to all of the Google Data APIs. Visit the Google Data APIs FAQ if you do not find the question you are looking for below.

Getting Started

What is the Google Documents List data API?
 
Do I need a Google Documents account to use the API?
 
Who should use the Google Documents List API?
 
Who should use the Google Spreadsheets data API?
 
Do you have any tips or short sample code for common issues?
 
What are the available client libraries supported by Google?
 
Where can I find a Developer Guide in each language?
 
What kinds of files can I upload to the Documents List API?
 
What is the AuthSub/OAuth scope?
 
When is a document's ETag updated?
 
When does the <updated> timestamp change?
 
When does the <app:edited> timestamp change?
 
I have a feature request or bug report. Where should I post?
 


Getting Started

What is the Google Documents List data API?

See http://code.google.com/apis/documents/

Do I need a Google Documents account to use the API?

Yes, in order to retrieve a list of documents or upload documents to the Google Documents service, you will need to sign up for an account at http://docs.google.com.

Who should use the Google Documents List API?

The API is designed to help anyone interested in uploading their existing documents to their Google Documents account programmatically and for developers wishing to integrate their applications with Google Documents.

If you have not created a Google Documents account please visit http://docs.google.com.

If you wish to create an application which can programmatically upload to or access your list of documents, then the Google Documents List API can enable you to do so. Developers should be familiar with XML and the HTTP protocol. Further information on how to begin can be found here:

http://code.google.com/apis/documents/

Who should use the Google Spreadsheets data API?

The API is designed to help anyone interested in publishing their Google Spreadsheets' data with other users through mash-ups and developers wishing to integrate their applications with Google Spreadsheets.

If you're a new or casual user of Google Spreadsheets, we suggest you start or continue using Google Spreadsheets through the online editor. To get started, go to http://spreadsheets.google.com/.

If you need to develop a more sophisticated application, you might want to consider the Google Spreadsheets data API. This method will allow you to programmatically manage spreadsheets in Google Spreadsheets. Developers should be familiar with the HTTP protocol. You can start here:

http://code.google.com/apis/spreadsheets/

Do you have any tips or short sample code for common issues?
You should browse the Google Data API Tips Blog for help with both our client libraries and making raw requests. The Client Libraries and Sample Code page also lists some additional resources.
What are the available client libraries supported by Google?

Java, .NET, PHP, Python and Objective-C client libraries are officially supported by Google. Using these libraries, you can construct Google Data requests, send them to a service, and process server responses.

Where can I find a Developer Guide in each language?

Developer Guides for the HTTP XML Protocol, .NET, Java, PHP, and Python can be found at: http://code.google.com/apis/documents/developers_guide.html

What kinds of files can I upload to the Documents List API?
The following file types can be uploaded via the Google Documents List API:
File extensionMIME type
CSVtext/csv
TSVtext/tab-separated-values
TABtext/tab-separated-values
HTMLtext/html
HTMtext/html
DOCapplication/msword
DOCXapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
ODSapplication/x-vnd.oasis.opendocument.spreadsheet
ODTapplication/vnd.oasis.opendocument.text
RTFapplication/rtf
SXWapplication/vnd.sun.xml.writer
TXTtext/plain
XLSapplication/vnd.ms-excel
XLSXapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet
PDFapplication/pdf
PPTapplication/vnd.ms-powerpoint
PPSapplication/vnd.ms-powerpoint
What is the AuthSub/OAuth scope?

The Documents List API uses the following scope: http(s)://docs.google.com/feeds/.

In addition to this scope, to download Spreadsheets and PDFs you'll need to request a token valid for http(s)://spreadsheets.google.com/feeds/ and http://docs.googleusercontent.com. Thus, it is recommended to use scope=http://docs.google.com/feeds/%20http://spreadsheets.google.com/feeds/%20http://docs.googleusercontent.com when requesting a new token.

I have a feature request or bug report. Where should I post?

To report a bug, post a detailed description on our issue tracker, here

To report a feature request, post a detailed description here

When is a document's ETag updated?

ETags updates reflect changes to both content and metadata. The <app:edited> node also reflects this timestamp.

When does the <updated> timestamp change?

The atom <updated> timestamp reflects changes to content only.

When does the <app:edited> timestamp change?

The <app:edited> timestamp reflects changes to both content and metadata.