This document provides detailed reference documentation for the raw protocol (XML and HTTP) for the Google Apps Profiles Data API.
This document doesn't contain information about the programming-language client libraries. For client-library reference information, see the links from the programming-language-specific sections of the developer's guide.
Note: This API is only available to Google Apps Premier, Education, and Partner Edition domains, and cannot be used for accessing or editing the Google Apps for free edition or Gmail profiles.
This document is intended for programmers who want to write client applications that can interact with the Profiles Data API.
Profiles Data API feed types
The Profiles Data API provides one type of feed: the profiles feed.
The feed is a private read/write feed that can be used to view and manage profiles of users in a Google Apps organization. Since they are private, a programmer can access them only by using an authenticated request. That is, the request must contain an authentication token for a user in the domain whose profiles you want to retrieve. For more information about authenticating, see the developer's guide.
The URL for a feed of profiles takes the following form:
For example, the profiles feed for example.com would have the following URI:
Profiles query parameters reference
The Profiles Data API supports the following standard Google Data API query parameters:
||The maximum number of entries to return.|
For more information about the standard parameters, see the Google Data APIs protocol reference document.
In addition to the standard query parameters, the Profiles Data API supports the following parameters:
||Opaque key of the first element to retrieve. Present in the
Profiles elements reference
The Profiles Data API uses the standard Google Data API elements. A profile entry takes the form of an extended Profile kind. The Profile kind appears in XML as an
<atom:entry> element that contains various extension elements from the Google Data namespace. For information about the standard Google Data API elements, see the Atom specification and the Kinds document.
category element indicating that the entry is a profile looks like this:
<atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/contact/2008#profile"/>
Extra restrictions on the standard Profile kind's extension elements
The Profiles Data API has the same restrictions on certain elements as the Contacts Data API does. Additionally, a profile entry cannot be marked as deleted (that is, it cannot contain a
gd:deleted element). Also note that the Profile kind, unlike the Contact kind, does not support
Additional extensions of the Profile kind
In addition, the Profiles Data API supports the following extensions:
Stores information about the user profile's status. Currently, the API only supports the
||Whether or not the user profile's contact information should be shared when contacts sharing is enabled for the domain.|