Connectors Reference

Google Contacts

Google Contacts is an online address book, integrated across your Google products and more.

 

Status: Production

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

ListContacts ()

Get my contacts

CreateContact (CreateContactParameterBody body)

Create a contact

ListContactsV2 ()

Get my contacts V2

ListGroups ()

Get my groups

PeopleApiListContactsV3 ()

Get my contacts V3

PeopleApiCreateContactV2 (PeopleApiCreateContactV2ParameterBody body)

Create a contact V2

PeopleApiListGroupsV2 ()

Get my groups V2

PeopleApiListContactsV4 ()

Get my contacts V4

PeopleApiCreateContactV3 (PeopleApiCreateContactV3ParameterBody body)

Create a contact V3

 

Triggers:

Name

Summary

OnContactUpdated ()

When a contact changes

PeopleApiOnContactUpdatedV2 ()

When a contact changes V2

PeopleApiOnContactUpdatedV3 ()

When a contact changes V3

 

Objects:

Name

Summary

CreateContactParameterBody

 

CreateContactResponse

 

Entry

 

ListContactsResponse

 

ListContactsV2Response

 

ListGroupsResponseItem

 

OnContactUpdatedResponse

 

PeopleApiConnection

 

PeopleApiConnectionV2

 

PeopleApiCreateContactV2ParameterBody

 

PeopleApiCreateContactV3ParameterBody

 

PeopleApiListContactsV3Response

 

PeopleApiListContactsV4Response

 

PeopleApiListGroupsV2Response

 

PeopleApiOnContactUpdatedV2Response

 

PeopleApiOnContactUpdatedV3Response

 

 

Actions:

ListContacts

Summary: Get my contacts

Description: Get my contacts.

 

Syntax:

GoogleContacts.ListContacts ()

 

Returns:

          Type:ListContactsResponse

 

CreateContact

Summary: Create a contact

Description: Create a contact within Google Contacts

 

Syntax:

GoogleContacts.CreateContact (CreateContactParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

CreateContactParameterBody

 

 

True

 

Returns:

          Type:CreateContactResponse

 

ListContactsV2

Summary: Get my contacts V2

Description: Get my contacts V2.

 

Syntax:

GoogleContacts.ListContactsV2 ()

 

Returns:

          Type:ListContactsV2Response

 

ListGroups

Summary: Get my groups

Description:

 

Syntax:

GoogleContacts.ListGroups ()

 

Returns:

          Type:array of (ListGroupsResponseItem)

 

PeopleApiListContactsV3

Summary: Get my contacts V3

Description: Get my contacts V3.

 

Syntax:

GoogleContacts.PeopleApiListContactsV3 ()

 

Returns:

          Type:PeopleApiListContactsV3Response

 

PeopleApiCreateContactV2

Summary: Create a contact V2

Description: Create a contact within Google Contacts V2

 

Syntax:

GoogleContacts.PeopleApiCreateContactV2 (PeopleApiCreateContactV2ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

PeopleApiCreateContactV2ParameterBody

 

 

True

 

Returns:

          Type:PeopleApiConnection

 

PeopleApiListGroupsV2

Summary: Get my groups V2

Description:

 

Syntax:

GoogleContacts.PeopleApiListGroupsV2 ()

 

Returns:

          Type:PeopleApiListGroupsV2Response

 

PeopleApiListContactsV4

Summary: Get my contacts V4

Description: Get my contacts V4.

 

Syntax:

GoogleContacts.PeopleApiListContactsV4 ()

 

Returns:

          Type:PeopleApiListContactsV4Response

 

PeopleApiCreateContactV3

Summary: Create a contact V3

Description: Create a contact within Google Contacts V3

 

Syntax:

GoogleContacts.PeopleApiCreateContactV3 (PeopleApiCreateContactV3ParameterBody body)

 

Parameters:

Name

Type

Summary

Required

Related Action

body

PeopleApiCreateContactV3ParameterBody

 

 

True

 

Returns:

          Type:PeopleApiConnectionV2

 

Triggers:

Trigger OnContactUpdated

Summary: When a contact changes

Description: When a contact changes in Google Contacts.

 

Syntax:

GoogleContacts.OnContactUpdated ()

 

Returns:

          Type:OnContactUpdatedResponse

 

Trigger PeopleApiOnContactUpdatedV2

Summary: When a contact changes V2

Description: When a contact changes in Google Contacts V2.

 

Syntax:

GoogleContacts.PeopleApiOnContactUpdatedV2 ()

 

Returns:

          Type:PeopleApiOnContactUpdatedV2Response

 

Trigger PeopleApiOnContactUpdatedV3

Summary: When a contact changes V3

Description: When a contact changes in Google Contacts V3.

 

Syntax:

GoogleContacts.PeopleApiOnContactUpdatedV3 ()

 

Returns:

          Type:PeopleApiOnContactUpdatedV3Response

 


 

CreateContactParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Display Name

Display name for the contact.

workEmail

string

Work Email Address

 

group

string

Group

Group to add the contact to.

company

string

Company

 

workPhoneNumber

string

Work Phone Number

 

mobilePhoneNumber

string

Mobile Phone Number

 

homeEmail

string

Home Email Address

Home Email address for the contact.

otherEmail

string

Other Email Address

 

nickName

string

Nickname

 

homeAddress

string

Home Address

 

workAddress

string

Work Address

 

otherAddress

string

Other Address

 

jobTitle

string

Job Title

 

homePhoneNumber

string

Home Phone Number

 

otherPhoneNumber

string

Other Phone Number

 

notes

string

Notes

 


 

CreateContactResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

entry

Entry

 

 


 

Entry

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

Id

 

 

updated

Updated

 

 

title

Title

 

 

gd$name

Gd$name

 

 

gContact$nickname

GContact$nickname

 

 

gd$organization

array of (Gd$organizationItem)

 

 

workEmail

string

Work Email

The work email address of the contact.

homeEmail

string

Home Email

The home address of the contact.

otherEmail

string

Other Email

The other address of the contact.

workPhoneNumber

string

Work Phone Number

The work phone number of the contact.

homePhoneNumber

string

Home Phone Number

The home phone number of the contact.

otherPhoneNumber

string

Other Phone Number

The other phone number of the contact.

mobilePhoneNumber

string

Mobile Phone Number

The mobile phone number of the contact.

workAddress

string

Work Address

The work address of the contact.

homeAddress

string

Home Address

The home address of the contact.

otherAddress

string

Other Address

The other address of the contact.

 

Id

Summary:

Description:

 

          Properties:

Name

Type

Summary

$t

string

Id

The id of the contact.

 

Updated

Summary:

Description:

 

          Properties:

Name

Type

Summary

$t

string(date-time)

Updated DateTime

The datetime the contact was last updated, in yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:59.000Z).

 

Title

Summary:

Description:

 

          Properties:

Name

Type

Summary

$t

string

Title

The job title of the contact.

 

Gd$name

Summary:

Description:

 

          Properties:

Name

Type

Summary

gd$fullName

Gd$fullName

 

 

gd$givenName

Gd$givenName

 

 

gd$familyName

Gd$familyName

 

 

 

Gd$fullName

Summary:

Description:

 

          Properties:

Name

Type

Summary

$t

string

Full Name

The full name of the contact.

 

Gd$givenName

Summary:

Description:

 

          Properties:

Name

Type

Summary

$t

string

Given Name

The given name of the contact.

 

Gd$familyName

Summary:

Description:

 

          Properties:

Name

Type

Summary

$t

string

Last Name

The family name of the contact.

 

GContact$nickname

Summary:

Description:

 

          Properties:

Name

Type

Summary

$t

string

Nickname

The nickname of the contact.

 

Gd$organizationItem

Summary: Organization

Description:

 

          Properties:

Name

Type

Summary

gd$orgName

Gd$orgName

 

 

gd$orgTitle

Gd$orgTitle

 

 

 

Gd$orgName

Summary:

Description:

 

          Properties:

Name

Type

Summary

$t

string

Name

The origanization name.

 

Gd$orgTitle

Summary:

Description:

 

          Properties:

Name

Type

Summary

$t

string

Title

The organization title.

 


 

ListContactsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

feed

Feed

 

 

 

Feed

Summary:

Description:

 

          Properties:

Name

Type

Summary

entry

array of (Entry)

Contact

 

 


 

ListContactsV2Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

array of (Entry)

Contact

 


 

ListGroupsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

 

title

string

 

 


 

OnContactUpdatedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

feed

Feed

 

 

 

Feed

Summary:

Description:

 

          Properties:

Name

Type

Summary

entry

array of (Entry)

 

 

 


 

PeopleApiConnection

Summary:

Description:

 

          Properties:

Name

Type

Summary

metadata

Metadata

 

 

name

Name

 

 

nickname

Nickname

 

 

organizations

array of (OrganizationsItem)

 

 

addressesObject

AddressesObject

 

 

emailAddressesObject

EmailAddressesObject

 

 

phoneNumbersObject

PhoneNumbersObject

 

 

 

Metadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

source

Source

 

 

 

Source

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

The id of the contact.

updatedTime

string(date-time)

Updated DateTime

The datetime the contact was last updated, in yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:59.000Z).

 

Name

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Full Name

The full name of the contact.

givenName

string

Given Name

The given name of the contact.

familyName

string

Family Name

The family name of the contact.

 

Nickname

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Nickname

The nickname of the contact.

 

OrganizationsItem

Summary: Organization

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

The origanization name.

title

string

Title

The organization title.

 

AddressesObject

Summary:

Description:

 

          Properties:

Name

Type

Summary

work

Work

 

 

home

Home

 

 

other

Other

 

 

 

Work

Summary:

Description:

 

          Properties:

Name

Type

Summary

formattedValue

string

Work Address

The work address of the contact.

 

Home

Summary:

Description:

 

          Properties:

Name

Type

Summary

formattedValue

string

Home Address

The home address of the contact.

 

Other

Summary:

Description:

 

          Properties:

Name

Type

Summary

formattedValue

string

Other Address

The other address of the contact.

 

EmailAddressesObject

Summary:

Description:

 

          Properties:

Name

Type

Summary

work

Work

 

 

home

Home

 

 

other

Other

 

 

 

Work

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Work Email

The work email address of the contact.

 

Home

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Home Email

The home email address of the contact.

 

Other

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Other Email

The other email address of the contact.

 

PhoneNumbersObject

Summary:

Description:

 

          Properties:

Name

Type

Summary

work

Work

 

 

home

Home

 

 

mobile

Mobile

 

 

other

Other

 

 

 

Work

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Work Phone Number

The work phone number of the contact.

 

Home

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Home Phone Number

The home phone number of the contact.

 

Mobile

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Mobile Phone Number

The mobile phone number of the contact.

 

Other

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Other Phone Number

The other phone number of the contact.

 


 

PeopleApiConnectionV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

metadata

Metadata

 

 

name

Name

 

 

nickname

Nickname

 

 

organizations

array of (OrganizationsItem)

 

 

addresses

array of (AddressesItem)

 

 

emailAddresses

array of (EmailAddressesItem)

 

 

phoneNumbers

array of (PhoneNumbersItem)

 

 

 

Metadata

Summary:

Description:

 

          Properties:

Name

Type

Summary

source

Source

 

 

 

Source

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

The id of the contact.

updatedTime

string(date-time)

Updated DateTime

The datetime the contact was last updated, in yyyy-MM-ddTHH:mm:ss.fffZ (2016-07-20T08:00:59.000Z).

 

Name

Summary:

Description:

 

          Properties:

Name

Type

Summary

displayName

string

Full Name

The full name of the contact.

givenName

string

Given Name

The given name of the contact.

familyName

string

Family Name

The family name of the contact.

 

Nickname

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Nickname

The nickname of the contact.

 

OrganizationsItem

Summary: Organization

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

The origanization name.

title

string

Title

The organization title.

 

AddressesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

formattedValue

string

Address

The address of the contact.

 

EmailAddressesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Email

The email address of the contact.

formattedType

string

Type

The type of email address of the contact.

 

PhoneNumbersItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

string

Phone Number

The phone number of the contact.

formattedType

string

Type

The phone number of the contact.

 


 

PeopleApiCreateContactV2ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

givenName

string

Given Name

Given name for the contact.

familyName

string

Family Name

Family name for the contact.

workEmail

string

Work Email Address

 

group

string

Group

Group to add the contact to.

company

string

Company

 

workPhoneNumber

string

Work Phone Number

 

mobilePhoneNumber

string

Mobile Phone Number

 

homeEmail

string

Home Email Address

Home Email address for the contact.

otherEmail

string

Other Email Address

 

nickName

string

Nickname

 

homeAddress

string

Home Address

 

workAddress

string

Work Address

 

otherAddress

string

Other Address

 

jobTitle

string

Job Title

 

homePhoneNumber

string

Home Phone Number

 

otherPhoneNumber

string

Other Phone Number

 


 

PeopleApiCreateContactV3ParameterBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

givenName

string

Given Name

Given name for the contact.

familyName

string

Family Name

Family name for the contact.

workEmail

string

Work Email Address

 

group

string

Group

Group to add the contact to.

company

string

Company

 

workPhoneNumber

string

Work Phone Number

 

mobilePhoneNumber

string

Mobile Phone Number

 

homeEmail

string

Home Email Address

Home Email address for the contact.

otherEmail

string

Other Email Address

 

nickName

string

Nickname

 

homeAddress

string

Home Address

 

workAddress

string

Work Address

 

otherAddress

string

Other Address

 

jobTitle

string

Job Title

 

homePhoneNumber

string

Home Phone Number

 

otherPhoneNumber

string

Other Phone Number

 


 

PeopleApiListContactsV3Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

connections

array of (PeopleApiConnection)

 

 


 

PeopleApiListContactsV4Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

connections

array of (PeopleApiConnectionV2)

 

 


 

PeopleApiListGroupsV2Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

contactGroups

array of (ContactGroupsItem)

 

 

 

ContactGroupsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

resourceName

string

 

 

formattedName

string

 

 

 


 

PeopleApiOnContactUpdatedV2Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

connections

array of (PeopleApiConnection)

 

 


 

PeopleApiOnContactUpdatedV3Response

Summary:

Description:

 

          Properties:

Name

Type

Summary

connections

array of (PeopleApiConnectionV2)