Google Notebook Data API Reference Guide

This document provides detailed reference documentation for the Google Notebook data API.

Contents

Audience

This document is intended for programmers who want to write client applications that can interact with Google Notebook.

It's a reference document; it assumes that you understand the concepts presented in the developer's guide, and the general ideas behind the Google data APIs protocol.

Google Notebook feed types

Google Notebook provides two different types of feeds to access public notebook data: user-based feeds and notebook-based feeds.

A user-based feed is a "metafeed" listing all of the notebooks published by the specified user. Each entry corresponds to a notebook. The URI of a user-based feed takes the following form:

GET http://www.google.com/notebook/feeds/userID

A notebook-based feed contains entries that represent the notes in a given notebook, including all the metadata associated with that note (the URL of the note attribution, the time that the note was made, and so on). The URI of a notebook-based feed takes the following form:

GET http://www.google.com/notebook/feeds/userID/notebooks/notebookID   

Google Notebook query parameters reference

Google Notebook supports the following standard GData query parameters in both metafeeds and notebook-based feeds:

• updated-min, updated-max
• alt
• start-index
• max-results
• entryID

In addition, notebook-based feeds support standard GData category queries, using the syntax described in the GData Protocol Reference document. The Google Notebook equivalent of a category is a section heading in a notebook. For example, you might use the following URL to request the notes from a notebook section titled "Netherfield Park":

http://www.google.com/notebook/feeds/userID/notebooks/notebookID/-/Netherfield%20Park

Notebook does not support entry author (author) queries or full-text search queries (q). Although notebooks can be shared with other users, only the owner's name is associated with the published notebook, so an entry author query wouldn't make sense; all the entries in a given notebook have the same author.

For more information about the standard parameters, see the GData Protocol Reference document.

In addition to the standard GData query parameters, the Notebook data API uses one other parameter:

Parameter	Meaning	Notes
orderby	Sort order	This query parameter applies only to notebook-based feeds, not user-based feeds. By default, the entries in a feed are sorted with the most recently updated note first. To sort entries in the same order as the corresponding notes in the notebook, set the value of the orderby parameter to position.

Google Notebook elements reference

The Google Notebook data API uses only standard GData elements. For information about the standard GData elements, see the Atom specification and the Common Elements document.

Back to top