Clear search
Close search
Google apps
Main menu

Google Apps is now G Suite. Same service, new name. More about the name change.

G Suite Gmail APIs

Warning: For current documentation for the Gmail API, see the Developer's Guide. Most newer Google APIs are not Google Data APIs. The Google Data APIs documentation applies only to the older APIs that are listed in the Google Data APIs directory. For information about a specific new API, see that API's documentation. For information about authorizing requests with a newer API, see Google Accounts Authentication and Authorization.

Several APIs are used to set up, manage, and migrate legacy messages to your G Suite Gmail account. When getting started with these these APIs, become familiar with the Google Data protocol basics and the many resources available to API developers.

Getting Started with G Suite APIs

Tasks APIs
Learn the Google Data protocol The G Suite services provide external access to Gmail data and functionality through APIs that utilize the Google Data Protocol, a RESTful technology for reading, writing, and modifying information on the Web.
Key Google Data resources Depending upon your project's requirements, your client application can start in several ways. Important key resources for your project are:
G Suite API prerequisites The G Suite API documentation assumes that you understand the basics of client applications, XML, name spaces, syndicated feeds, and the GET, POST, PUT, and DELETE requests in HTTP, as well as the HTTP concept of a "resource." For more information, see the Google Data Resources to learn about AtomPub publishing and editing model, how to work with the REST protocol, and an introduction to XML.

Setting Up and Managing G Suite Gmail

Tasks APIs
Manage your email settings The Email Settings API modifies user-level Gmail settings for any of the users at your domain. With this API, you can create labels, filters, and send-as aliases. You can update settings for web clips, forwarding, POP, IMAP, vacation-responder, signatures, and languages. And, you can manage the general settings such as maximum page size, shortcuts, arrow usage, snippets, and Unicode activation. Currently, the retrieval and delete operations are not supported.
Verify your MX record configuration The Admin Settings API verifies your MX record status to confirm your Gmail domain's MX records have been configured and your account has mail flow.
Set your recovery email address The Admin Settings API manages your domain administrator's email recovery address. For more information about recovery tasks, see recovery email address.
Confirm your SSO authentication settings The Admin Settings API lets you control how users access the email by adjusting the Single Sign-On (SSO) settings.
Customize your mailbox The Admin Settings API lets you set the default language for your users, and the API lets you personalize your mailbox by changing your domain logo.
Set your group email subscription permissions The Provisioning API manages a new group's subscription permissions. Group membership can be restricted to the group's owners, members, or any user in the group's domain. You can also set the group's subscribers be anyone.
Set your email clients report The Reporting API generates an email clients report showing how users in your domain access their hosted accounts on a day-by-day basis. For each day, the report lists the total number of accounts in your domain as well as the number users in your domain who have accessed email using WebMail.
Set new message alerts The Gmail Atom feeds, when used with an aggregator (also known as a news reader, feed reader, or RSS/Atom reader), receives new message alerts. Each alert will include a preview of the message and a link to Gmail.

Migrating to a G Suite Gmail Account

Tasks APIs
Migrate legacy email to your hosted Gmail account Use the Gmail API to import messages from your previous email system into your domain's hosted Gmail account. You can write extraction code, which operates against an email server data store, interface protocol, or email client data store. Using the Gmail API, upload the email messages to a target mailbox, specifying the correct labels, date, and status.
Control your users' ability to migrate email The Admin Settings API lets domain administrators control whether the domain's users can upload email using the Gmail API.
Set your email routing to an email server If you are using the IMAP email migration and email routing services, use the Admin Settings API to let administrators specify the domain-level email routing to another email server. This is similar to the Admin console's email routing settings. This can also be used with a dual delivery configuration to allow users continuous mail flow while their email is being migrated.
Set your outbound email routing The Admin Settings API configures outbound routing of email from users in your domain.
Was this article helpful?
How can we improve it?
Sign in to your account

Get account-specific help by signing in with your G Suite account email address, or learn how to get started with G Suite.