At a glance
- Availability: Experimental (how to enable).
- Auth: OAuth 2.0.
- Connection: A user authorizes the connection in the provider’s consent screen.
- Scopes:
https://www.googleapis.com/auth/contacts.readonly. - Optional scopes:
https://www.googleapis.com/auth/contacts. - Docs: https://developers.google.com/people/api/rest
Credentials
Set these per environment. See Connect an integration. With a managed OAuth app, Connect works without these variables; set them to use your own OAuth app instead.Setup
- Create or reuse a Google Cloud project: Go to https://console.cloud.google.com and create a project, or reuse the project that already hosts your shared Google OAuth app. Any free Google account works for testing - add a few contacts at https://contacts.google.com to have data to query.
- Enable the People API: Open https://console.cloud.google.com/apis/library/people.googleapis.com, select your project, and click Enable. Google Contacts data is served by the People API.
- Configure the OAuth consent screen and client: Under APIs & Services > Credentials, create (or reuse) an OAuth 2.0 Client ID of type Web application and add your app’s redirect URI ending in /api/auth/google-contacts/callback. The same Google OAuth client can be shared across all Google connectors.
- Set environment variables: Set GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET from the OAuth client you created. These are shared with other Google integrations.
- The default scope is read-only (contacts.readonly); creating or updating contacts requires granting the optional https://www.googleapis.com/auth/contacts scope.
- Contact resource names look like ‘people/c123’; tools take just the ID portion after ‘people/’ as the personId parameter.
- Updates are etag-guarded: fetch the contact (including metadata) first and send its etag and metadata.sources back, plus an updatePersonFields mask naming the changed fields.
- Search uses a prefix-match cache; send a warmup search with an empty query before the real query for fresh results.
Tools
Example prompts
- Search my Google Contacts for a person and show their email address and phone number.
- Create a new contact in my Google Contacts with name, email, and phone number.
- Find a contact and update their email address or phone number in Google Contacts.