• Documentation >
• Apps >
• CRM and Sales tools >
• Google Contacts

Google Contacts

Getting Started with Google Contacts

The Google Contacts modules allow you to monitor, create, update, search, and delete your Google Contacts.

• See the changelog for the Google Contacts App

Prerequisites

• A Google account

In order to use Google Contacts with Ibexa Connect, it is necessary to have a Google account. If you do not have one, you can create a Google account at contacts.google.com.

The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!

Connecting Google Contacts to Ibexa Connect

1. Go to Ibexa Connect, and open the Google Contacts module's Create a connection dialog. In the Connection name field, enter a name for the connection, and click Continue.

2. Select the Google account you want to connect to Ibexa Connect.

3. Grant Ibexa Connect access to your Google Contacts by clicking the Allow button.

The connection has been established.

Contact

Watch Contacts

Retrieves contact details when a new contact is added or an existing contact is updated.

Limit	Set the maximum number of contacts Ibexa Connect will return during one scenario execution cycle.

List My Contacts

Retrieves the list of your contacts.

Sort order by date	Select the order to sort the returned contacts.
Limit	Set the maximum number of contacts Ibexa Connect will return during one scenario execution cycle.

Search Directory Contacts

Returns a list of domain profiles and domain contacts in the authenticated user's domain directory that match the search query.

Requires GSuite account.

Query Search	Enter the search term you want to search the organization's directory for.
Limit	Set the maximum number of contacts Ibexa Connect will return during one scenario execution cycle.

List Other Contacts

List all "Other contacts," that are not in a contact group. "Other contacts" are typically auto-created contacts from interactions.

Limit	Set the maximum number of contacts Ibexa Connect will return during one scenario execution cycle.

Get a Contact

Retrieves contact details.

Contact ID	Select or enter (map) the ID of the contact you want to retrieve details for.

Create a Contact

Creates a new contact.

Name Prefix	Enter the honorific prefix, such as Mrs. or Dr.
First name	Enter the first name of the contact.
First name Yomi	Enter the phonetically equivalent name, if this name is Japanese.
Middle Name	Enter any middle name for the contact.
Middle Name Yomi	Enter the phonetically equivalent middle name, if the family name is Japanese.
Family Name	Enter the family name of the contact.
Family Name Yomi	Enter the phonetically equivalent name, if the family name is Japanese.
Name Suffix	Enter the honorific suffix, such as Jr.
Nickname	Enter the person's nickname.
Source File	Map the file you want to upload from the previous module (e.g., HTTP > Get a File or Google Drive > Download a File), or enter the file data manually.
Name	Enter the company name to which the contact belongs.
Job Title	Enter the job title of the contact.
Department	Enter the department name to which the contact belongs.
Job description	Enter the job details of the contact.
Symbol	Enter the symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
Type	Select the type.
Domain	Enter the domain name associated with the organization; for example, make.com.
Location	Enter the location of the organization office where the person works.
Emails	Add the email address: Email Enter the email address. Display Name Enter a display name for the email address. Type Select the email address type.
Phones Numbers	Add the phone number: Phone Add the phone number. Type Select or enter the type of phone number.
Addresses	Enter the person's physical address. This may be a P.O. box or street address. All fields are optional. Street Enter the street name. PO Box Enter the P.O. box number. City Enter the city name. Region Enter the area name. Postal Code Enter the area's post code. Country Enter the country name.
Birthday	Enter the birthday of the contact. Please consult the list of supported day and time formats.
Events	Specify events related to the person, such as an anniversary.
URL	Add the person's associated URLs. URL Add the website URL. Type Select or enter the type of the URL.
IM Clients	Add the Instant Messaging client for the contact: Username Enter the contact's user name used in the IM client. Type Select or enter the type of the IM client. Protocol Select the protocol of the IM client.
Notes	Enter the person's short biography.
Relations	Specify the person's relation to another person.
User-defined fields	Add custom fields: key Enter the field name. Value Enter the value for the field.

Update a Contact

Updates an existing contact.

Contact ID	Select or map the ID of the contact you want to update.
Name Prefix	Enter the honorific prefix, such as Mrs. or Dr.
First name	Enter the first name of the contact.
First name Yomi	Enter the phonetically equivalent name, if this name is Japanese.
Middle Name	Enter any middle name for the contact.
Middle Name Yomi	Enter the phonetically equivalent middle name, if the family name is Japanese.
Family Name	Enter the family name of the contact.
Family Name Yomi	Enter the phonetically equivalent name, if the family name is Japanese.
Name Suffix	Enter the honorific suffix, such as Jr.
Nickname	Enter the person's nickname.
Source File	Map the file you want to upload from the previous module (e.g., HTTP > Get a File or Google Drive > Download a File), or enter the file data manually.
Name	Enter the company name to which the contact belongs.
Job Title	Enter the job title of the contact.
Department	Enter the department name to which the contact belongs.
Job description	Enter the job details of the contact.
Symbol	Enter the symbol associated with the organization; for example, a stock ticker symbol, abbreviation, or acronym.
Type	Select the type.
Domain	Enter the domain name associated with the organization; for example, make.com.
Location	Enter the location of the organization office where the person works.
Emails	Add the email address: Email Enter the email address. Display Name Enter a display name for the email address. Type Select the email address type.
Phones Numbers	Add the phone number: Phone Add the phone number. Type Select or enter the type of the phone number.
Addresses	Enter a person's physical address. This may be a P.O. box or street address. All fields are optional. Street Enter the street name. PO Box Enter the P.O. box number. City Enter the city name. Region Enter the area name. Postal Code Enter the area's post code. Country Enter the country name.
Birthday	Enter the birthday of the contact. Please consult the list of supported day and time formats.
Events	Specify events related to the person, such as an anniversary.
URL	Add the person's associated URLs. URL Add the website URL. Type Select or enter the type of the URL.
IM Clients	Add the Instant Messaging client for the contact: Username Enter the contact's user name used in the IM client. Type Select or enter the type of the IM client. Protocol Select the protocol of the IM client.
Notes	Enter the person's short biography.
Relations	Specify the person's relation to another person.
User-defined fields	Add custom fields: key Enter the field name. Value Enter the value for the field.

Delete a Contact

Deletes a contact.

Contact ID	Select or enter the ID of the contact you want to delete.

Contact Group

Watch Contact Groups

Retrieves contact group details when a group is created or updated.

Limit	Set the maximum number of contact groups Ibexa Connect will return during one execution cycle.

List Contact Groups

Retrieves all contact groups in your account.

Limit	Set the maximum number of contact groups Ibexa Connect will return during one execution cycle.

Get a Contact Group

Retrieves contact group details.

Contact Group ID	Enter (map) or select the contact group you want to retrieve details for.
Maximum Number of Members	Set the maximum number of members to return.

Create a Contact Group

Creates a new contact group.

Contact Group's Name	Enter the name for the new contact group.

Update a Contact Group

Updates the name of the specified contact group.

Contact Group ID	Enter (map) or select the contact group you want to update.
Contact Group's Name	Enter the new name for the contact group specified above.

Delete a Contact Group

Deletes a contact group.

Contact Group ID	Enter (map) or select the contact group you want to delete.

Other

Make an API Call

Allows you to perform a custom API call.

URL

Enter a path relative to https://people.googleapis.com, e.g. /v1/contactGroups.

Note

For the list of available endpoints, refer to the Google Contacts API Documentation.

Method

Select the HTTP method you want to use:

• GET:to retrieve information for an entry.

• POST: to create a new entry.

• PUT: to update/replace an existing entry.

• PATCH: to make a partial entry update.

• DELETE: to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we've already added those for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List Contacts

The following API call returns all contacts of the authenticated user in your Google Contacts:

URL:

/v1/people/me/connections/

Method:

GET

Query String:

Key: personFields

Value: names,emailAddresses (depends on what fields you want to return)

The result can be found in the module's Output under Bundle > Body > connections.

In our example, 2 contacts were returned:

Change Log Between Google Contacts [v4] and Google Contacts [3]

New modules:

• Watch Contact Groups

• Get a Contact Group

• Create a Contact Group

• Update a Contact Group

• Delete a Contact Group

• Add/Remove Contact from a Group

• List My Contacts

• List Other Contacts

Deprecated:

• Get Labels

• Create a Label

• Update a Label

• Delete a Label

• Retrieve Emails

• Retrieve Phone Numbers

• Retrieve Addresses

• Retrieve Websites

• Retrieve Relations

• Retrieve IM Contacts