Web Services for Google Apps

Google Web Services Library

Google Apps Provisioning API Web Services

    The Provisioning API Web Services provides a mechanism to programmatically create and manage Google Apps user accounts, nicknames, and groups. Using this API you can minimize disruption to your organization's current processes by synchronizing user data between Google Apps and your existing user management system. This API is only available in Google Apps Premier, Education and Partner Editions.

    Available Web Services

      User Accounts

    • Creating a User Account
    • Retrieving a User Account
    • Retrieving all Users in a Domain
    • Retrieving List of 100 Users
    • Updating a User Account
    • Suspending a User Account
    • Restoring a User Account
    • Deleting a User Account

      Nicknames

    • Creating a Nickname
    • Retrieving a Nickname
    • Retrieving all Nicknames for a User
    • Retrieving all Nicknames in a Domain
    • Retrieving List of 100 Nicknames
    • Deleting a Nickname

      Groups

    • Creating a Group
    • Retrieving a Group
    • Updating a Group
    • Retrieving all Groups for a Member
    • Retrieving all Groups in a Domain
    • Deleting a Group

      Group Members

    • Adding a Member to a Group
    • Retrieving All Members of a Group
    • Deleting a Member from a Group

      Groups Owners

    • Adding a Owner to a Group
    • Querying if a User or Group is Owner
    • Querying for All Owners of a Group
    • Deleting an Owner from a Group

Google Documents List Data API Web Services

  • Discovery

    Retrieve documents that match specific keywords, categories, or metadata.

  • Download

    export documents in common formats such as pdf, rtf, doc, xls, ppt, and more.

  • Sharing (ACLs)

    Modify the sharing permissions of documents and folders. Sharing to individuals, group emails, Domain

  • Create/upload/copy documents

    Create online backups of local word processor documents, spreadsheets, presentations, and PDFs.

  • File documents

    Create folders and move documents/folders in and out of folders.

  • Revisions

    Review, download, or publish a document's complete revision history.

    • Available Web Services

      Retrieving Documents

    • Retrieving a list of documents
    • Searching the documents feed
    • Category queries
    • Performing title queries
    • Performing a full text query
    • Retrieving folder contents

      Create, Update, Delete

    • Creating an empty document
    • Uploading documents with content
    • Creating/uploading documents to folders
    • Updating metadata
    • Replacing a document's content
    • Updating a document's content and metadata
    • Trashing a document or folder
    • Deleting a document or folder

      Downlading Documents

    • Exporting word processor documents
    • Exporting presentations
    • Exporting spreadsheets
    • Exporting spreadsheets using AuthSub/OAuth
    • Exporting spreadsheets using ClientLogin
    • Downloading PDFs

      Folder management

    • Creating folders
    • Creating a subfolder
    • Moving documents/folders
    • Moving a resource into a folder
    • Moving a resource out of a folder

      Sharing Permissions

    • Retrieving the ACL feed
    • Modifying the ACL feed
    • Group/Domain-level sharing
    • Updating sharing permissions
    • Removing sharing permissions

      Document Revisions

    • Retrieving document revisions
    • Downloading a revision

Google Spreadsheets API Web Services

    The Google Spreadsheets Data Web Services allows client applications to view and update Spreadsheets content in the form of Google Data API feeds.

    Your client application can request a list of a user's spreadsheets, edit or delete content in an existing Spreadsheets worksheet, and query the content in an existing Spreadsheets worksheet.

    Available Web Services

      Create, Retrieve

    • Create a spreadsheet
    • Get a list of spreadsheets

      Worksheet-Based Feeds

    • Get a worksheet-based feed
    • Add a worksheet
    • Update a worksheet's metadata
    • Remove a worksheet

      List-Based Feeds

    • Get a list-based feed
    • Reverse-sort rows
    • Send a structured query
    • Add a row
    • Edit a row
    • Remove a row

      Cell-Based Feeds

    • Get a cell-based feed
    • Send a cell range query
    • Change contents of a cell
    • Update multiple cells with a batch request

Google Calendar APIs Web Services

    The Google Calendar Data API allows client applications to view and update calendar events in the form of Google Data API feeds.

    Your client application can use the Calendar Data API to create new events, edit or delete existing events, and query for events that match particular criteria.

    Available Web Services

      Calendar Lists

    • Retrieving all calendars
    • Retrieving only calendars that a user owns

      Managing Calendars

    • Creating new calendars
    • Updating existing calendars
    • Deleting calendars

      Managing Subscriptions

    • Creating new calendars
    • Adding new subscriptions
    • Updating calendar subscriptions
    • Deleting subscriptions

      Retrieving Events

    • Without query parameters
    • For a specified date range
    • Matching a full text query

      Create, Update, Delete

    • Creating single-occurrence events
    • Creating quick add events
    • Creating Calendar Event GadgetsNew!
    • Creating recurring events
    • Updating events
    • Deleting events

      Sharing Calendars

    • Retrieving access control lists
    • Adding a user to an access control list
    • Updating a user's role in an access control list
    • Removing a user from an access control list

      Additional Operations

    • Extended properties
    • Reminders and Notifications
    • Performing multiple operations with a batch request

Google Sites Data API Web Services

    The Google Sites Data API Web Services allows client applications to access, publish, and modify content within a Google Site. The API is available to both Google Account and Google Apps users.

    Here are some of the things you can do with the API:

    Retrieve, create, modify, move, and delete pages, comments, attachments, and other content. Review the revision history across the Site.  Monitor all add, modify, and delete activity for a Site.  Upload/download attachments and files.

    Available Web Services

      Retrieving Content

    • Retrieving the content feed
    • Retrieving the Activity Feed
    • Retrieving Revision History
    • Retrieving specific entry kinds
    • Retrieving a page by path
    • Retrieving all entries under a parent page

      Manage Content

    • Create items/pages under custom URL paths
    • Create subpages
    • Uploade attachments
    • Uploade an attachment to a folder
    • Upload Web attachments
    • Delete Content
    • Download Attachments

      Updating Content

    • Page's metadata and/or html content
    • Attachment file contents
    • Attachment metadata + content

Google Apps Reporting API Web Services

    The Google Apps Reporting API lets you retrieve usage reports for your domain's hosted accounts.

    Available Web Services

      Reports

    • Accounts Report
    • Activity Report
    • Disk Space Report
    • Email Clients Report
    • Quota Limit Accounts Report
    • Summary Report
    • Suspended Accounts Report

Google Apps Shared Contacts API Web Services

    The Shared Contacts API allows client applications to retrieve and update external contacts that are shared to all users in a Google Apps domain. Shared contacts are visible to all users of an Apps domain and all Google services have access to the contact list

    Available Web Services

      Shared Contacts

    • Creating shared contacts
    • Retrieve all shared contacts
    • Retrieve shared contacts using query parameters
    • Retrieve a single shared contact
    • Retrieve a photo for a contact
    • Updating shared contacts
    • Photo management
    • Deleting shared contacts
    • Batch processing

Google Apps Profiles API Web Services

    The Profiles Data API allows client applications to retrieve and update profile information for users in a Google Apps domain. Each user profile is stored in the owning user's Google Account, but it can be modified only by an administrator of the user's domain.

    Your client application can use the Profiles Data API to retrieve the profiles of users in a Google Apps domain and to modify them on behalf of an administrator.

    Profiles cannot be inserted or deleted, since every user is considered to have a profile, even if it is blank. Your client can populate a profile using an update operation. It can send an update operation with no content to clear existing profiles.

    Available Web Services

      User Profiles

    • Retrieving profiles
    • Retrieving all profiles
    • Retrieving profiles using query parameters
    • Retrieving a single profile
    • Updating a profile
    • Batch processing

Google Contacts Data API Web Services

    The Contacts Data API allows client applications to view and update a user's contacts. Contacts are stored in the user's Google Account; most Google services have access to the contact list. Your client application can use the Contacts Data API to create new contacts, edit or delete existing contacts, and query for contacts that match particular criteria.

    Available Web Services

      Contacts

    • Creating contacts
    • Adding a photo for a contact
    • Photo management
    • Creating contact groups
    • System groups

      Retrieving

    • Retrieving all contacts
    • Retrieving contacts using query parameters
    • Retrieving a photo for a contact
    • Retrieving all contact groups
    • Retrieving contact groups using query parameters

      Update, Delete

    • Updating contacts
    • Deleting contacts
    • Updating contact groups
    • Deleting contact groups

Email Settings API Web Services

    Email Settings API Web Services enables developers to programmatically manipulate most user-level Google Mail settings.

    Available Web Services

      Email Settings

    • Creating a Label
    • Creating a Filter
    • Creating a Send-as Alias
    • Updating Web Clip Settings
    • Updating Forwarding Settings
    • Updating POP Settings
    • Updating IMAP Settings

      Email Settings

    • Updating Vacation-Responder Settings
    • Updating Signature
    • Updating Language Settings
    • Language Tags
    • Updating General Settings

Google Apps Admin Settings API Web Services

    The Google Apps Admin Settings API Web Services allows developers of Google Apps to retrieve and change the settings of their domains in the form of Google Data API feeds. These domain settings include many of the features available in the Google Apps control panel. Example users of this API include creating a custom control panel or integrate Google Apps domains into an existing legacy environment.

    Available Web Services

      Domain Settings

    • Retrieving a domain's default language
    • Updating a domain's default language
    • Retrieving the organization name
    • Updating an organization name
    • Retrieving the maximum number of users
    • Retrieving the current number of users

      Account Settings

    • Retrieving the domain's verification status
    • Retrieving the domain's support PIN
    • Retrieving the domain's edition
    • Retrieving the domain's customer PIN
    • Retrieving the domain's creation time
    • Retrieving the domain's country code
    • Retrieving the administrator's secondary email address
    • Changing the administrator's secondary email address

      Appearance Settings

    • Changing the domain's logo

      Verification Settings

    • Managing the verification settings
    • Retrieving the CNAME verification status
    • Changing the CNAME verification status
    • Retrieving the MX record verification status
    • Changing the MX record verification status

      Single Sign-On Settings

    • Retrieving a Single Sign-On settings
    • Updating a Single Sign-On settings
    • Retrieving the Single Sign-On signing key
    • Updating the Single Sign-On signing key

      Email Migration, Gateway, Routing

    • Retrieving migration access settings
    • Updating migration access settings
    • Retrieving outbound email gateway settings
    • Updating outbound email gateway settings
    • Managing email routing settings