Programmer's Reference Guide

Table of Contents

1. Zend_Gdata

1.1. Introduction

1.1.1. Structure of Zend_Gdata

1.1.2. Interacting with Google Services

1.1.3. Obtaining instances of Zend_Gdata classes

1.1.4. Google Data Client Authentication

1.1.5. Dependencies

1.1.6. Creating a new Gdata client

1.1.7. Common Query Parameters

1.1.8. Fetching a Feed

1.1.9. Working with Multi-page Feeds

1.1.10. Working with Data in Feeds and Entries

1.1.11. Updating Entries

1.1.12. Posting Entries to Google Servers

1.1.13. Deleting Entries on Google Servers

1.2. Authenticating with AuthSub

1.2.1. Creating an AuthSub authenticated Http Client

1.2.2. Revoking AuthSub authentication

1.3. Authenticating with ClientLogin

1.3.1. Creating a ClientLogin authenticated Http Client

1.3.2. Terminating a ClientLogin authenticated Http Client

1.4. Using Google Calendar

1.4.1. Connecting To The Calendar Service

1.4.1.1. Authentication

1.4.1.2. Creating A Service Instance

1.4.2. Retrieving A Calendar List

1.4.3. Retrieving Events

1.4.3.1. Queries

1.4.3.2. Retrieving Events In Order Of Start Time

1.4.3.3. Retrieving Events In A Specified Date Range

1.4.3.4. Retrieving Events By Fulltext Query

1.4.3.5. Retrieving Individual Events

1.4.4. Creating Events

1.4.4.1. Creating Single-Occurrence Events

1.4.4.2. Event Schedules and Reminders

1.4.4.3. Creating Recurring Events

1.4.4.4. Using QuickAdd

1.4.5. Modifying Events

1.4.6. Deleting Events

1.4.7. Accessing Event Comments

1.5. Using Google Documents List Data API

1.5.1. Get a List of Documents

1.5.2. Upload a Document

1.5.3. Searching the documents feed

1.5.3.1. Get a List of Word Processing Documents

1.5.3.2. Get a List of Spreadsheets

1.5.3.3. Performing a text query

1.6. Using Google Spreadsheets

1.6.1. Create a Spreadsheet

1.6.2. Get a List of Spreadsheets

1.6.3. Get a List of Worksheets

1.6.4. Interacting With List-based Feeds

1.6.4.1. Get a List-based Feed

1.6.4.2. Reverse-sort Rows

1.6.4.3. Send a Structured Query

1.6.4.4. Add a Row

1.6.4.5. Edit a Row

1.6.4.6. Delete a Row

1.6.5. Interacting With Cell-based Feeds

1.6.5.1. Get a Cell-based Feed

1.6.5.2. Send a Cell Range Query

1.6.5.3. Change Contents of a Cell

1.7. Using Google Apps Provisioning

1.7.1. Setting the current domain

1.7.1.1. Setting the domain for the service class

1.7.1.2. Setting the domain for query classes

1.7.2. Interacting with users

1.7.2.1. Creating a user account

1.7.2.2. Retrieving a user account

1.7.2.3. Retrieving all users in a domain

1.7.2.4. Updating a user account

1.7.2.4.1. Resetting a user's password

1.7.2.4.2. Forcing a user to change their password

1.7.2.4.3. Suspending a user account

1.7.2.4.4. Granting administrative rights

1.7.2.5. Deleting user accounts

1.7.3. Interacting with nicknames

1.7.3.1. Creating a nickname

1.7.3.2. Retrieving a nickname

1.7.3.3. Retrieving all nicknames for a user

1.7.3.4. Retrieving all nicknames in a domain

1.7.3.5. Deleting a nickname

1.7.4. Interacting with email lists

1.7.4.1. Creating an email list

1.7.4.2. Retrieving all email lists to which a recipient is subscribed

1.7.4.3. Retrieving all email lists in a domain

1.7.4.4. Deleting an email list

1.7.5. Interacting with email list recipients

1.7.5.1. Adding a recipient to an email list

1.7.5.2. Retrieving the list of subscribers to an email list

1.7.5.3. Removing a recipient from an email list

1.7.6. Handling errors

1.8. Using Google Base

1.8.1. Connect To The Base Service

1.8.1.1. Authentication

1.8.1.2. Create A Service Instance

1.8.2. Retrieve Items

1.8.2.1. Send a Structured Query

1.8.2.1.1. Query Customer Items Feed

1.8.2.1.2. Query Snippets Feed

1.8.2.2. Iterate through the Items

1.8.3. Insert, Update, and Delete Customer Items

1.8.3.1. Insert an Item

1.8.3.2. Modify an Item

1.8.3.3. Delete an Item

1.9. Using Picasa Web Albums

1.9.1. Connecting To The Service

1.9.1.1. Authentication

1.9.1.2. Creating A Service Instance

1.9.2. Understanding and Constructing Queries

1.9.3. Retrieving Feeds And Entries

1.9.3.1. Retrieving A User

1.9.3.2. Retrieving An Album

1.9.3.3. Retrieving A Photo

1.9.3.4. Retrieving A Comment

1.9.3.5. Retrieving A Tag

1.9.4. Creating Entries

1.9.4.1. Creating An Album

1.9.4.2. Creating A Photo

1.9.4.3. Creating A Comment

1.9.4.4. Creating A Tag

1.9.5. Deleting Entries

1.9.5.1. Deleting An Album

1.9.5.2. Deleting A Photo

1.9.5.3. Deleting A Comment

1.9.5.4. Deleting A Tag

1.9.5.5. Optimistic Concurrency (Notes On Deletion)

1.10. Using the YouTube Data API

1.10.1. Authentication

1.10.2. Developer Keys and Client ID

1.10.3. Retrieving public video feeds

1.10.3.1. Searching for videos by metadata

1.10.3.2. Searching for videos by categories and tags/keywords

1.10.3.3. Retrieving standard feeds

1.10.3.4. Retrieving videos uploaded by a user

1.10.3.5. Retrieving videos favorited by a user

1.10.3.6. Retrieving video responses for a video

1.10.4. Retrieving video comments

1.10.5. Retrieving playlist feeds

1.10.5.1. Retrieving the playlists of a user

1.10.5.2. Retrieving a specific playlist

1.10.6. Retrieving a list of a user's subscriptions

1.10.7. Retrieving a user's profile

1.10.8. Uploading Videos to YouTube

1.10.9. Browser-based upload

1.10.10. Checking upload status

1.10.11. Other Functions

1.11. Catching Gdata Exceptions

A.

Index