Adding a Connection to GoogleContacts

To add a connection to GoogleContacts:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the GoogleContacts icon is not available, click the Add More icon to download and install the GoogleContacts connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to GoogleContacts

Authorize the Sync App to access Google APIs on behalf of individual users or on behalf of a domain.

Use the OAuth authentication standard to connect to Google APIs.

Authenticating to GoogleContacts

The Sync App supports using user accounts and GCP instance accounts for authentication.

The following sections discuss the available authentication schemes for GoogleContacts:

• User Accounts (OAuth)
• Service Account (OAuthJWT)
• GCP Instance Account

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows.

Web Applications

When connecting via a Web application, you need to create and register a custom OAuth application with GoogleContacts. You can then use the Sync App to acquire and manage the OAuth token values. See Creating a Custom OAuth App for more information about custom applications.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• OAuthClientId: Set this to the Client Id in your application settings.
• OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the Callback URL you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
2. Navigate to the URL that the stored procedure returned in Step 1. Log in to the custom OAuth application and authorize the web application. Once authenticated, the browser redirects you to the callback URL.
3. Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL.

Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: Set this to the Client Id in your application settings.
• OAuthClientSecret: Set this to the Client Secret in your application settings.
• OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
• OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
• OAuthSettingsLocation: Set this to the location where the Sync App saves the OAuth token values, which persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

• OAuthClientId: Set this to the Client Id in your application settings.
• OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

1. Choose one of two options:
   • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
   • Option 2: Install the Sync App on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
2. Then configure the Sync App to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

1. Choose one of these options:
   • If you are using the Embedded OAuth Application click GoogleContacts OAuth endpoint to open the endpoint in your browser.
   • If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
     • InitiateOAuth: Set to OFF.
     • OAuthClientId: Set to the client Id assigned when you registered your application.
     • OAuthClientSecret: Set to the client secret assigned when you registered your application.
     Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
2. Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

• InitiateOAuth: Set this to REFRESH.
• OAuthVerifier: Set this to the verifier code.
• OAuthClientId: (custom applications only) Set this to the Client Id in your custom OAuth application settings.
• OAuthClientSecret: (custom applications only) Set this to the Client Secret in the custom OAuth application settings.
• OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
• OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

• InitiateOAuth: Set this to REFRESH.
• OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
• OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

GCP Instance Accounts

When running on a GCP virtual machine, the Sync App can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

This section details a selection of advanced features of the GoogleContacts Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to GoogleContacts and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API objects and provides more information on executing SQL to GoogleContacts APIs.

Key Features

• The Sync App models GoogleContacts entities like documents, folders, and groups as relational views, allowing you to write SQL to query GoogleContacts data.
• Stored procedures allow you to execute operations to GoogleContacts.
• Live connectivity to these objects means any changes to your GoogleContacts account are immediately reflected when using the Sync App.
• INSERT support for ContactGroups, My Contacts, and Starred tables. Note that the latter two are generated dynamically so are not part of this documentation.

Tables

The Sync App models the GoogleContacts API as relational Tables.

Views

Views offer additional metadata information from GoogleContacts.

Stored Procedures

Stored Procedures are function-like interfaces to GoogleContacts. Stored procedures allow you to execute operations to GoogleContacts, including downloading documents and moving envelopes.

The Sync App models the data in GoogleContacts as a list of tables in a relational database that can be queried using standard SQL statements.

Google Contacts Connector for CData Sync Tables

Name	Description
ContactGroups	Create, update, delete and query Contact Groups.
Contacts	Set the name of this table to any of your ContactGroups(GroupName) to create, update, delete, and query Google contacts.

Create, update, delete and query Contact Groups.

Table Specific Information

Select

The ContactGroups table supports the Id and MemberCount columns in the WHERE clause. The supported operators are '=, in' for Id and '=' for MemberCount. For example:

SELECT * FROM [ContactGroups] WHERE Id = 'myContacts'

SELECT * FROM [ContactGroups] WHERE Id = '45a15a878be3580a'

SELECT * FROM [ContactGroups] WHERE Id = '4fe7dbbd0d26cc95' AND MemberCount = 10

INSERT

To create a new ContactGroup, the Name is required. You can also insert data to ClientData columns

INSERT INTO [ContactGroups] (Name) VALUES ('Contacts Group Test')

To insert ClientData for a contactGroup, you can use the #TEMP table or create the JSON structure to provide the values to insert.

INSERT INTO ClientData#TEMP (ClientDataKey, ClientDataValue) VALUES ('Client Data 1', 'sfsdfsds45rf')
INSERT INTO ClientData#TEMP (ClientDataKey, ClientDataValue) VALUES ('Client Data 2', '2jfk24g78w2jbdk')
INSERT INTO ContactGroups (Name, ClientData) VALUES ('Insert ClientData to a Contact Group 2', 'ClientData#TEMP')

INSERT INTO ContactGroups (Name, ClientData) VALUES ('Testing Insert ClientData in Contact Group via client data columns', '[{"key": "Client Data 1","value": "sdfjkbq36"},{"key": "Client Data 2","value": "df32jkbk"}]')

Update

You can update the Name, ClientData of a ContactGroups row (except for System Groups (GroupType As SYSTEM_CONTACT_GROUP) like My Contacts, Coworkers, and Friends) by specifying the Id column.

UPDATE [ContactGroups] SET Name = 'Salsa Friends' WHERE Id = '674ddb258de3ef81'

Delete

To delete a ContactGroup, the Id is required.

DELETE FROM [ContactGroups] WHERE Id = '674ddb258de3ef81'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the contact group.
ResourceName	String	True	The ResourceName of the contact group.
ETag	String	True	The HTTP entity tag of the resource.
Name	String	False	The name of the contact group.
GroupType	String	True	The contact group type.
FormattedName	String	True	The group name formatted in the viewer's account locale.
MemberCount	Integer	True	The total number of contacts in the group irrespective of max members in specified in the request.
MemberResourceNames	String	True	The list of contact person resource names that are members of the contact group.
MetadataUpdatedTime	Datetime	True	The metadata of the contact group.
MetadataDeleted	Boolean	True	The metadata of the contact group.
ClientData	String	False	The group's client data.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
ClientDataKey	String	The client specified key of the client data.
ClientDataValue	String	The client specified value of the client data.

Set the name of this table to any of your ContactGroups(GroupName) to create, update, delete, and query Google contacts.

Select

The Contacts table supports the Id in the WHERE clause. The supported operators are '=, IN' for Id. For example:

SELECT * FROM [My Contacts] WHERE Id = '567931ee88efc109'

SELECT * FROM [My Contacts] WHERE Id IN ('567931ee88efc109', '79733d1ee88efc109')

SELECT * FROM [My Contacts] WHERE SearchTerms = 'Yash' 

Insert

You can insert any field into the Contacts table that is not read-only. You can add multiple values for few specific fields separated by semi-colon.

INSERT INTO [My Contacts] (GivenName, FamilyName, HomeEmailAddresses, WorkEmailAddresses, WorkPhoneNumbers, HomePhoneNumbers, HomeAddresses) VALUES ('Elizabeth', 'Bennet', '[email protected]', '[email protected]', '(206)555-1212', '(206)555-1213', '1600 Amphitheatre Pkwy Mountain View')

To insert organization details for a contact, Use the #TEMP table to insert the fields of the organization. The fields of the organization is present in ContactOrganizations view. For Example:

INSERT INTO ContactOrganizations#TEMP (Current, Department, Domain, JobDescrption, Location, Name, StartDate) VALUES (true, 'Engineering', 'QA', 'Big Data Engineer', 'Bangalore', 'Tech Mahindra', '2021-03-01')
INSERT INTO ContactOrganizations#TEMP (Current, Department, Domain, JobDescrption, Location, Name, StartDate, EndDate) VALUES (false, 'Engineering', 'QA', 'Software Consultant', 'Bangalore', 'CData', '2019-05-23', '2020-02-17')
INSERT INTO [My Contacts] (GivenName, Organizations) VALUES ('Karan', 'ContactOrganizations#TEMP')

To insert multiple contacts at once, use the #TEMP table to insert. For Example:

INSERT INTO MyContacts#TEMP (GivenName, FamilyName, HomeAddresses) VALUES ('Ankit', 'Singh', 'Bangalore India; Indore India')
INSERT INTO MyContacts#TEMP (GivenName, MiddleName, HomeAddresses) VALUES ('Aman', '', 'Bangalore India; Indore India')
INSERT INTO [My Contacts] (GivenName, HomeAddresses) SELECT GivenName, HomeAddresses FROM MyContacts#TEMP

Update

You can update any field in the Contacts table that is not read-only. You can add multiple values for few specific fields separated by semi-colon.

UPDATE [My Contacts] SET GivenName = 'Elizabeth', FamilyName = 'Bennet', MobilePhoneNumbers = '+355696969999;+355676555001' WHERE Id = '48b8b9158b1db34d'

UPDATE [My Contacts] SET HomeAddresses = 'Electronic City Bangalore India; Brilliant Solitaire Indore India' WHERE Id = 'c6545017396039868174'

To update details of multiple contacts at once, use the #TEMP table. For Example:

INSERT INTO MyContacts#TEMP (Id, GivenName, HomeAddresses) VALUES ('c9197613024342508599', 'Ankit', 'Bangalore India; Indore India')
INSERT INTO MyContacts#TEMP (Id, GivenName, HomeAddresses) VALUES ('c2042847992816525584', 'Aman', 'Bangalore India; Indore India')
UPDATE [My Contacts] (Id, GivenName, HomeAddresses) SELECT Id, GivenName, HomeAddresses FROM MyContacts#TEMP

Delete

To delete a Contact, the Id is required.

DELETE FROM [My Contacts] WHERE Id = '567931ee88efc109'

To delete multiple contacts at once, use the #TEMP table. For Example:

INSERT INTO MyContacts#TEMP (Id) VALUES ('c9197613024342508599')
INSERT INTO MyContacts#TEMP (Id) VALUES ('c2042847992816525584')
DELETE FROM [My Contacts] WHERE EXISTS SELECT Id FROM MyContacts#TEMP

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the contact.
ResourceName	String	True	The ResourceName of the contact.
Etag	String	True	The ETag of the resource. (Note that the quotation marks are part of the ETag.)
NamePrefix	String	True	The honorific prefixes, such as Mrs. or Dr.
FullName	String	True	The display name formatted according to the locale specified by the viewer's account
GivenName	String	False	The given name of the contact.
MiddleName	String	False	The middle name of the contact.
FamilyName	String	False	The family name of the contact.
NameSuffix	String	False	The honorific suffixes, such as Jr.
PhoneticNamePrefix	String	True	The Phonetic honorific prefixes, such as Mrs. or Dr.
PhoneticFullName	String	False	The Phonetic display name formatted according to the locale specified by the viewer's account.
PhoneticGivenName	String	False	The Phonetic given name of the contact.
PhoneticMiddleName	String	False	The Phonetic middle name of the contact.
PhoneticFamilyName	String	False	The Phonetic family name of the contact.
PhoneticNameSuffix	String	False	The Phonetic honorific suffixes, such as Jr.
NickNames	String	False	The nickname of the contact.
Birthday	Date	False	The birthday of the contact. The format of the date is yyyy-mm-dd.
GenderAddressMeAs	String	False	The type of pronoun that should be used to address the contact.
Gender	String	False	The gender for the contact.
Photos	String	True	The contact's photo.
UnlabeledEmailAddresses	String	False	The unlabeled email addresses of the contact. Multiple email addresses should be separated by semi-colon.
HomeEmailAddresses	String	False	The home email addresses of the contact. Multiple email addresses should be separated by semi-colon.
WorkEmailAddresses	String	False	The work email addresses of the contact. Multiple email addresses should be separated by semi-colon.
OtherEmailAddresses	String	False	The other email addresses of the contact. Multiple email addresses should be separated by semi-colon.
CustomEmailAddressTypes	String	False	The custom type of the email address. This attribute should be used along with CustomEmailAddresses. Multiple custom types should be separated by semi-colon.
CustomEmailAddresses	String	False	The custom value of the email address. This attribute should be used along with CustomEmailAddressTypes. Multiple custom emailAddresses should be separated by semi-colon.
UnlabeledPhoneNumbers	String	False	The unlabeled phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
HomePhoneNumbers	String	False	The home phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkPhoneNumbers	String	False	The work phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
MobilePhoneNumbers	String	False	The mobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
OtherPhoneNumbers	String	False	The homeFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
HomeFaxes	String	False	The workFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkFaxes	String	False	The otherFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
OtherFaxes	String	False	The pager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
Pagers	String	False	The workMobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkMobilePhoneNumbers	String	False	The workPager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkPagers	String	False	The main phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
MainPhoneNumbers	String	False	The googleVoice phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
GoogleVoicePhoneNumbers	String	False	The other phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
CustomPhoneNumberTypes	String	False	The custom type of the phone number. This attribute should be used along with CustomPhoneNumbers. Multiple custom types should be separated by semi-colon.
CustomPhoneNumbers	String	False	The custom value of the phone number. This attribute should be used along with CustomPhoneNumberTypes. Multiple custom phone numbers should be separated by semi-colon.
UnlabeledAddresses	String	False	The unlabeled addresses of the contact. Multiple addresses should be separated by semi-colon.
HomeAddresses	String	False	The home addresses of the contact. Multiple addresses should be separated by semi-colon.
WorkAddresses	String	False	The work addresses of the contact. Multiple addresses should be separated by semi-colon.
OtherAddresses	String	False	The other addresses of the contact. Multiple addresses should be separated by semi-colon.
CustomAddressTypes	String	False	The custom type of the address. This attribute should be used along with CustomAddresses. Multiple custom types should be separated by semi-colon.
CustomAddresses	String	False	The custom value of the address. This attribute should be used along with CustomAddressTypes. Multiple custom emailAddresses should be separated by semi-colon.
AgeRanges	String	True	An age range of a contact.
Biography	String	False	The short biography of the contact.
BiographyContentType	String	False	The content type of the biography of the contact.
HomeCalendarUrls	String	True	The home calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.
FreeBusyCalendarUrls	String	True	The freeBusy calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.
WorkCalendarUrls	String	True	The work calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.
CustomCalendarUrlTypes	String	True	The custom type of the address. This attribute should be used along with CustomCalendarUrls. Multiple custom types should be separated by semi-colon.
CustomCalendarUrls	String	True	The custom value of the address. This attribute should be used along with CustomCalendarUrlTypes. Multiple custom calendar urls should be separated by semi-colon.
ClientData	String	False	The group's client data.
CoverPhotos	String	True	A contact's cover photo.
UnlabeledEvents	String	False	The dates of unlabeled events. Multiple dates should be separated by semi-colon.
AnniversaryEvents	String	False	The dates of anniversary events. Multiple dates should be separated by semi-colon.
OtherEvents	String	False	The dates of other events. Multiple dates should be separated by semi-colon.
CustomEventTypes	String	False	The custom type of an event. Multiple types should be separated by semi-colon.
CustomEvents	String	False	The custom value of an event. Multiple custom event dates should be separated by semi-colon.
AccountExternalIds	String	False	The account externalIds of the contact. Multiple externalIds should be separated by semi-colon.
CustomerExternalIds	String	False	The customer externalIds of the contact. Multiple externalIds should be separated by semi-colon.
LoginIdExternalIds	String	False	The loginId externalIds of the contact. Multiple externalIds should be separated by semi-colon.
NetworkExternalIds	String	False	The network externalIds of the contact. Multiple externalIds should be separated by semi-colon.
OrganizationExternalIds	String	False	The organization externalIds of the contact. Multiple externalIds should be separated by semi-colon.
CustomExternalIdTypes	String	False	The custom type of the externalId. This attribute should be used along with CustomExternalIds. Multiple types should be separated by semi-colon.
CustomExternalIds	String	False	The custom value of the externalId. This attribute should be used along with CustomExternalIdTypes. Multiple externalIds should be separated by semi-colon.
FileAses	String	True	The name that should be used to sort the contact in a list.
ImClientsProtocols	String	True	The semi-colon separated list of ImClients Protocols. Multiple protocols should be separated by semi-colon.
ImClientsUsernames	String	True	The semi-colon separated list of ImClients Usernames. Multiple usernames should be separated by semi-colon.
Interests	String	False	The contact's interests.
Locales	String	False	The contact's locales.
DeskLocations	String	False	The desk locations of the contact. Multiple locations should be separated by semi-colon.
GrewUpLocations	String	False	The grewUp locations of the contact. Multiple locations should be separated by semi-colon.
CustomLocationTypes	String	False	The custom types of the location. The attribute should be used along with CustomLocations. Multiple locations should be separated by semi-colon.
CustomLocations	String	False	The custom value of the location. The attribute should be used along with CustomLocationsTypes. Multiple locations should be separated by semi-colon.
Memberships	String	True	The resource name for the contact group, assigned by the server. Only contactGroupResourceName can be used for modifying memberships. Any contact group membership can be removed, but only user group or 'myContacts' or 'starred' system groups memberships can be added. A contact must always have at least one contact group membership.
MiscKeywordTypes	String	False	The miscellaneous keyword types. Multiple types should be separated by semi-colon. Allowed Values are : TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER The allowed values are TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER.
MiscKeywordValues	String	False	The miscellaneous keywords. Multiple miscellaneous keywords should be separated by semi-colon.
Occupations	String	False	The contact's occupations
Organizations	String	False	The organizations of the contact.
RelationshipTypes	String	True	The contact's relation to the other person. This attribute should be used along with RelationValues. Multiple types should be separated by semi-colon.
RelationshipValues	String	True	The name of the other person this relation refers to. This attribute should be used along with RelationTypes. Multiple names should be separated by semi-colon.
UnlabeledSipAddresses	String	False	The dates of anniversary events. Multiple dates should be separated by semi-colon.
HomeSipAddresses	String	False	The home sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
WorkSipAddresses	String	False	The work sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
MobileSipAddresses	String	False	The mobile sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
OtherSipAddresses	String	False	The other sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
CustomSipAddressTypes	String	False	The custom type of the sipAddress. This attribute should be used along with CustomSipAddresses. Multiple types should be separated by semi-colon.
CustomSipAddresses	String	False	The custom value of the sipAddress. This attribute should be used along with CustomSipAddressTypes. Multiple sipAddresses should be separated by semi-colon.
Skills	String	True	The skills that the contact has.
UnlabeledUrls	String	False	The unlabeled website urls of the contact. Multiple urls should be separated by semi-colon.
HomeUrls	String	False	The home website urls of the contact. Multiple urls should be separated by semi-colon.
WorkUrls	String	False	The work website urls of the contact. Multiple urls should be separated by semi-colon.
BlogUrls	String	False	The blog website urls of the contact. Multiple urls should be separated by semi-colon.
ProfileUrls	String	False	The profile website urls of the contact. Multiple urls should be separated by semi-colon.
HomePageUrls	String	False	The homePage website urls of the contact. Multiple urls should be separated by semi-colon.
FtpUrls	String	False	The ftp website urls of the contact. Multiple urls should be separated by semi-colon.
ReservationsUrls	String	False	The reservations website urls of the contact. Multiple urls should be separated by semi-colon.
OtherUrls	String	False	The appInstall Page website urls of the contact. Multiple urls should be separated by semi-colon.
AppInstallPageUrls	String	False	The other website urls of the contact. Multiple urls should be separated by semi-colon.
CustomUrlTypes	String	False	The custom type of the website url. This attribute values should be used along with CustomUrls. Multiple urls should be separated by semi-colon.
CustomUrls	String	False	The custom value of the website url. This attribute values should be used along with CustomUrlTypes. Multiple urls should be separated by semi-colon.
UnlabeledCountry	String	True	The unlabeled country of the contact. Multiple addresses should be separated by semi-colon.
UnlabeledCity	String	True	The unlabeled city of the contact. Multiple addresses should be separated by semi-colon.
UnlabeledCountryCode	String	True	The unlabeled country code of the contact. Multiple addresses should be separated by semi-colon.
UnlabeledExtendedAddress	String	True	The unlabeled extended address of the contact. Multiple addresses should be separated by semi-colon.
UnlabeledPostalCode	String	True	The unlabeled postal code of the contact. Multiple addresses should be separated by semi-colon.
UnlabeledRegion	String	True	The unlabeled region of the contact. Multiple addresses should be separated by semi-colon.
UnlabeledStreetAddress	String	True	The unlabeled street address of the contact. Multiple addresses should be separated by semi-colon.
HomeCountry	String	True	The home country of the contact. Multiple addresses should be separated by semi-colon.
HomeCity	String	True	The home city of the contact. Multiple addresses should be separated by semi-colon.
HomeCountryCode	String	True	The home country code of the contact. Multiple addresses should be separated by semi-colon.
HomeExtendedAddress	String	True	The home extended address of the contact. Multiple addresses should be separated by semi-colon.
HomePostalCode	String	True	The home postal code of the contact. Multiple addresses should be separated by semi-colon.
HomeRegion	String	True	The home region of the contact. Multiple addresses should be separated by semi-colon.
HomeStreetAddress	String	True	The home street address of the contact. Multiple addresses should be separated by semi-colon.
WorkCountry	String	True	The work country of the contact. Multiple addresses should be separated by semi-colon.
WorkCity	String	True	The work city of the contact. Multiple addresses should be separated by semi-colon.
WorkCountryCode	String	True	The work country code of the contact. Multiple addresses should be separated by semi-colon.
WorkExtendedAddress	String	True	The work extended address of the contact. Multiple addresses should be separated by semi-colon.
WorkPostalCode	String	True	The work postal code of the contact. Multiple addresses should be separated by semi-colon.
WorkRegion	String	True	The work region of the contact. Multiple addresses should be separated by semi-colon.
WorkStreetAddress	String	True	The work street address of the contact. Multiple addresses should be separated by semi-colon.
OtherCountry	String	True	The other country of the contact. Multiple addresses should be separated by semi-colon.
OtherCity	String	True	The other city of the contact. Multiple addresses should be separated by semi-colon.
OtherCountryCode	String	True	The other country code of the contact. Multiple addresses should be separated by semi-colon.
OtherExtendedAddress	String	True	The other extended address of the contact. Multiple addresses should be separated by semi-colon.
OtherPostalCode	String	True	The other postal code of the contact. Multiple addresses should be separated by semi-colon.
OtherRegion	String	True	The other region of the contact. Multiple addresses should be separated by semi-colon.
OtherStreetAddress	String	True	The other street address of the contact. Multiple addresses should be separated by semi-colon.
CustomCountry	String	True	The custom country of the contact. Multiple addresses should be separated by semi-colon.
CustomCity	String	True	The custom city of the contact. Multiple addresses should be separated by semi-colon.
CustomCountryCode	String	True	The custom country code of the contact. Multiple addresses should be separated by semi-colon.
CustomExtendedAddress	String	True	The custom extended address of the contact. Multiple addresses should be separated by semi-colon.
CustomPostalCode	String	True	The custom postal code of the contact. Multiple addresses should be separated by semi-colon.
CustomRegion	String	True	The custom region of the contact. Multiple addresses should be separated by semi-colon.
CustomStreetAddress	String	True	The custom street address of the contact. Multiple addresses should be separated by semi-colon.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SearchTerms	String	The query matches on a contact's names, nickNames, emailAddresses, phoneNumbers, and organizations fields that are from the CONTACT source. Maximum 10 matching rows will be returned.
ClientDataKey	String	The client specified key of the client data.
ClientDataValue	String	The client specified value of the client data.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Google Contacts Connector for CData Sync Views

Name	Description
ContactOrganizations	This view specifies all the details of the Contact's Organizations
GroupMembers	Query contact group resource names
OtherContacts	The view specifies all the details of Other Contacts
PeopleConnections	This view specifies all the details of People Connections

This view specifies all the details of the Contact's Organizations

Select

The ContactOrganizations view supports the Id in the WHERE clause. The supported operators are '=, IN' for Id. For example:

SELECT * FROM [ContactOrganizations] WHERE Id = '567931ee88efc109'

SELECT * FROM [ContactOrganizations] WHERE Id IN ('567931ee88efc109', '79733d1ee88efc109')

Columns

Name	Type	Description
Id	String	The Id of the contact.
ResourceName	String	The resource name of the contact.
Current	Boolean	True if organization is the person's current organization
Department	String	The person's department at the organization.
Domain	String	The domain name associated with the organization
FormattedType	String	The type of the organization translated and formatted in the viewer's account locale
JobDescription	String	The person's job description at the organization.
Location	String	The location of the organization office the person works at.
Name	String	The name of the organization.
PhoneticName	String	The phonetic name of the organization.
StartDate	Date	The start date when the person joined the organization.
EndDate	Date	The end date when the person left the organization.
Symbol	String	The symbol associated with the organization.
Title	String	The contact's job title at the organization.
Type	String	The type of the organization.

Query contact group resource names

Table Specific Information

Select

The GroupMembers view supports the Id and MemberCount columns in the WHERE clause. Id is required for this view. For example:

SELECT * FROM [GroupMembers] WHERE Id = '4fe7dbbd0d26cc95'

Columns

Name	Type	Description
Id	String	The Id of the contact group.
MemberCount	Integer	The total number of contacts in the group irrespective of max members in specified in the request.
ContactId	String	The list of contact person resource names that are members of the contact group.

The view specifies all the details of Other Contacts

Table Specific Information

Select

For example:

SELECT * FROM [OtherContacts] WHERE SearchTerms = 'Yash'

Columns

Name	Type	Description
Id [KEY]	String	The Id of the contact.
ResourceName	String	The ResourceName of the contact.
Etag	String	The ETag of the resource. (Note that the quotation marks are part of the ETag.)
NamePrefix	String	The honorific prefixes, such as Mrs. or Dr.
FullName	String	The display name formatted according to the locale specified by the viewer's account
GivenName	String	The given name of the contact.
MiddleName	String	The middle name of the contact.
FamilyName	String	The family name of the contact.
NameSuffix	String	The honorific suffixes, such as Jr.
PhoneticNamePrefix	String	The Phonetic honorific prefixes, such as Mrs. or Dr.
PhoneticFullName	String	The Phonetic display name formatted according to the locale specified by the viewer's account.
PhoneticGivenName	String	The Phonetic given name of the contact.
PhoneticMiddleName	String	The Phonetic middle name of the contact.
PhoneticFamilyName	String	The Phonetic family name of the contact.
PhoneticNameSuffix	String	The Phonetic honorific suffixes, such as Jr.
UnlabeledEmailAddresses	String	The unlabeled email addresses of the contact. Multiple email addresses should be separated by comma.
HomeEmailAddresses	String	The home email addresses of the contact. Multiple email addresses should be separated by comma.
WorkEmailAddresses	String	The work email addresses of the contact. Multiple email addresses should be separated by comma.
OtherEmailAddresses	String	The other email addresses of the contact. Multiple email addresses should be separated by comma.
CustomEmailAddressTypes	String	The custom type of the email address. This attribute should be used along with CustomEmailAddresses. Multiple custom types should be separated by comma.
CustomEmailAddresses	String	The custom value of the email address. This attribute should be used along with CustomEmailAddressTypes. Multiple custom emailAddresses should be separated by comma.
UnlabeledPhoneNumbers	String	The unlabeled phone numbers of the contacts. Multiple phone numbers should be separated by comma.
HomePhoneNumbers	String	The home phone numbers of the contacts. Multiple phone numbers should be separated by comma.
WorkPhoneNumbers	String	The work phone numbers of the contacts. Multiple phone numbers should be separated by comma.
MobilePhoneNumbers	String	The mobile phone numbers of the contacts. Multiple phone numbers should be separated by comma.
HomeFaxes	String	The homeFax phone numbers of the contacts. Multiple phone numbers should be separated by comma.
WorkFaxes	String	The workFax phone numbers of the contacts. Multiple phone numbers should be separated by comma.
OtherFaxes	String	The otherFax phone numbers of the contacts. Multiple phone numbers should be separated by comma.
Pagers	String	The pager phone numbers of the contacts. Multiple phone numbers should be separated by comma.
WorkMobilePhoneNumbers	String	The workMobile phone numbers of the contacts. Multiple phone numbers should be separated by comma.
WorkPagers	String	The workPager phone numbers of the contacts. Multiple phone numbers should be separated by comma.
MainPhoneNumbers	String	The main phone numbers of the contacts. Multiple phone numbers should be separated by comma.
GoogleVoicePhoneNumbers	String	The googleVoice phone numbers of the contacts. Multiple phone numbers should be separated by comma.
OtherPhoneNumbers	String	The other phone numbers of the contacts. Multiple phone numbers should be separated by comma.
CustomPhoneNumberTypes	String	The custom type of the phone number. This attribute should be used along with CustomPhoneNumbers. Multiple custom types should be separated by comma.
CustomPhoneNumbers	String	The custom value of the phone number. This attribute should be used along with CustomPhoneNumberTypes. Multiple custom phone numbers should be separated by comma.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SearchTerms	String	The query matches on a contact's names, emailAddresses, and phoneNumbers fields that are from the OTHER_CONTACT source. Maximum 10 matching rows will be returned.

This view specifies all the details of People Connections

Columns

Name	Type	Description
Id [KEY]	String	The Id of the contact.
ResourceName	String	The ResourceName of the contact.
Etag	String	The ETag of the resource. (Note that the quotation marks are part of the ETag.)
NamePrefix	String	The honorific prefixes, such as Mrs. or Dr.
FullName	String	The display name formatted according to the locale specified by the viewer's account
GivenName	String	The given name of the contact.
MiddleName	String	The middle name of the contact.
FamilyName	String	The family name of the contact.
NameSuffix	String	The honorific suffixes, such as Jr.
PhoneticNamePrefix	String	The Phonetic honorific prefixes, such as Mrs. or Dr.
PhoneticFullName	String	The Phonetic display name formatted according to the locale specified by the viewer's account.
PhoneticGivenName	String	The Phonetic given name of the contact.
PhoneticMiddleName	String	The Phonetic middle name of the contact.
PhoneticFamilyName	String	The Phonetic family name of the contact.
PhoneticNameSuffix	String	The Phonetic honorific suffixes, such as Jr.
NickNames	String	The nickname of the contact.
Birthday	Date	The birthday of the contact. The format of the date is yyyy-mm-dd.
GenderAddressMeAs	String	The type of pronoun that should be used to address the contact.
Gender	String	The gender for the contact.
Photos	String	The contact's photo.
UnlabeledEmailAddresses	String	The unlabeled email addresses of the contact. Multiple email addresses should be separated by semi-colon.
HomeEmailAddresses	String	The home email addresses of the contact. Multiple email addresses should be separated by semi-colon.
WorkEmailAddresses	String	The work email addresses of the contact. Multiple email addresses should be separated by semi-colon.
OtherEmailAddresses	String	The other email addresses of the contact. Multiple email addresses should be separated by semi-colon.
CustomEmailAddressTypes	String	The custom type of the email address. This attribute should be used along with CustomEmailAddresses. Multiple custom types should be separated by semi-colon.
CustomEmailAddresses	String	The custom value of the email address. This attribute should be used along with CustomEmailAddressTypes. Multiple custom emailAddresses should be separated by semi-colon.
UnlabeledPhoneNumbers	String	The unlabeled phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
HomePhoneNumbers	String	The home phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkPhoneNumbers	String	The work phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
MobilePhoneNumbers	String	The mobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
OtherPhoneNumbers	String	The homeFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
HomeFaxes	String	The workFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkFaxes	String	The otherFax phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
OtherFaxes	String	The pager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
Pagers	String	The workMobile phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkMobilePhoneNumbers	String	The workPager phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
WorkPagers	String	The main phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
MainPhoneNumbers	String	The googleVoice phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
GoogleVoicePhoneNumbers	String	The other phone numbers of the contacts. Multiple phone numbers should be separated by semi-colon.
CustomPhoneNumberTypes	String	The custom type of the phone number. This attribute should be used along with CustomPhoneNumbers. Multiple custom types should be separated by semi-colon.
CustomPhoneNumbers	String	The custom value of the phone number. This attribute should be used along with CustomPhoneNumberTypes. Multiple custom phone numbers should be separated by semi-colon.
UnlabeledAddresses	String	The unlabeled addresses of the contact. Multiple addresses should be separated by semi-colon.
HomeAddresses	String	The home addresses of the contact. Multiple addresses should be separated by semi-colon.
WorkAddresses	String	The work addresses of the contact. Multiple addresses should be separated by semi-colon.
OtherAddresses	String	The other addresses of the contact. Multiple addresses should be separated by semi-colon.
CustomAddressTypes	String	The custom type of the address. This attribute should be used along with CustomAddresses. Multiple custom types should be separated by semi-colon.
CustomAddresses	String	The custom value of the address. This attribute should be used along with CustomAddressTypes. Multiple custom emailAddresses should be separated by semi-colon.
AgeRanges	String	An age range of a contact.
Biography	String	The short biography of the contact.
BiographyContentType	String	The content type of the biography of the contact.
HomeCalendarUrls	String	The home calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.
FreeBusyCalendarUrls	String	The freeBusy calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.
WorkCalendarUrls	String	The work calendar urls of the contact. Multiple calendar urls should be separated by semi-colon.
CustomCalendarUrlTypes	String	The custom type of the address. This attribute should be used along with CustomCalendarUrls. Multiple custom types should be separated by semi-colon.
CustomCalendarUrls	String	The custom value of the address. This attribute should be used along with CustomCalendarUrlTypes. Multiple custom calendar urls should be separated by semi-colon.
ClientData	String	The group's client data.
CoverPhotos	String	A contact's cover photo.
UnlabeledEvents	String	The dates of unlabeled events. Multiple dates should be separated by semi-colon.
AnniversaryEvents	String	The dates of anniversary events. Multiple dates should be separated by semi-colon.
OtherEvents	String	The dates of other events. Multiple dates should be separated by semi-colon.
CustomEventTypes	String	The custom type of an event. Multiple types should be separated by semi-colon.
CustomEvents	String	The custom value of an event. Multiple custom event dates should be separated by semi-colon.
AccountExternalIds	String	The account externalIds of the contact. Multiple externalIds should be separated by semi-colon.
CustomerExternalIds	String	The customer externalIds of the contact. Multiple externalIds should be separated by semi-colon.
LoginIdExternalIds	String	The loginId externalIds of the contact. Multiple externalIds should be separated by semi-colon.
NetworkExternalIds	String	The network externalIds of the contact. Multiple externalIds should be separated by semi-colon.
OrganizationExternalIds	String	The organization externalIds of the contact. Multiple externalIds should be separated by semi-colon.
CustomExternalIdTypes	String	The custom type of the externalId. This attribute should be used along with CustomExternalIds. Multiple types should be separated by semi-colon.
CustomExternalIds	String	The custom value of the externalId. This attribute should be used along with CustomExternalIdTypes. Multiple externalIds should be separated by semi-colon.
FileAses	String	The name that should be used to sort the contact in a list.
ImClientsProtocols	String	The custom type of the imClient. This attribute should be used along with CustomImClients. Multiple custom types should be separated by semi-colon.
ImClientsUsernames	String	The custom value of the imClient. This attribute should be used along with CustomImClientTypes. Multiple custom imClients should be separated by semi-colon.
Interests	String	The contact's interests.
Locales	String	The contact's locales.
DeskLocations	String	The desk locations of the contact. Multiple locations should be separated by semi-colon.
GrewUpLocations	String	The grewUp locations of the contact. Multiple locations should be separated by semi-colon.
CustomLocationTypes	String	The custom types of the location. The attribute should be used along with CustomLocations. Multiple locations should be separated by semi-colon.
CustomLocations	String	The custom value of the location. The attribute should be used along with CustomLocationsTypes. Multiple locations should be separated by semi-colon.
Memberships	String	The resource name for the contact group, assigned by the server. Only contactGroupResourceName can be used for modifying memberships. Any contact group membership can be removed, but only user group or 'myContacts' or 'starred' system groups memberships can be added. A contact must always have at least one contact group membership.
MiscKeywordTypes	String	The miscellaneous keyword types. Multiple types should be separated by semi-colon. Allowed Values are : TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER The allowed values are TYPE_UNSPECIFIED, OUTLOOK_BILLING_INFORMATION, OUTLOOK_DIRECTORY_SERVER, OUTLOOK_KEYWORD, OUTLOOK_MILEAGE, OUTLOOK_PRIORITY, OUTLOOK_SENSITIVITY, OUTLOOK_SUBJECT, OUTLOOK_USER, HOME, WORK, OTHER.
MiscKeywordValues	String	The miscellaneous keywords. Multiple miscellaneous keywords should be separated by semi-colon.
Occupations	String	The contact's occupations
Organizations	String	The organizations of the contact.
RelationshipTypes	String	The contact's relation to the other person. This attribute should be used along with RelationValues. Multiple types should be separated by semi-colon.
RelationshipValues	String	The name of the other person this relation refers to. This attribute should be used along with RelationTypes. Multiple names should be separated by semi-colon.
UnlabeledSipAddresses	String	The unlabeled sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
HomeSipAddresses	String	The home sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
WorkSipAddresses	String	The work sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
MobileSipAddresses	String	The mobile sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
OtherSipAddresses	String	The other sipAddresses of the contact. Multiple sipAddresses should be separated by semi-colon.
CustomSipAddressTypes	String	The custom type of the sipAddress. This attribute should be used along with CustomSipAddresses. Multiple types should be separated by semi-colon.
CustomSipAddresses	String	The custom value of the sipAddress. This attribute should be used along with CustomSipAddressTypes. Multiple sipAddresses should be separated by semi-colon.
Skills	String	The skills that the contact has.
UnlabeledUrls	String	The unlabeled website urls of the contact. Multiple urls should be separated by semi-colon.
HomeUrls	String	The home website urls of the contact. Multiple urls should be separated by semi-colon.
WorkUrls	String	The work website urls of the contact. Multiple urls should be separated by semi-colon.
BlogUrls	String	The blog website urls of the contact. Multiple urls should be separated by semi-colon.
ProfileUrls	String	The profile website urls of the contact. Multiple urls should be separated by semi-colon.
HomePageUrls	String	The homePage website urls of the contact. Multiple urls should be separated by semi-colon.
FtpUrls	String	The ftp website urls of the contact. Multiple urls should be separated by semi-colon.
ReservationsUrls	String	The reservations website urls of the contact. Multiple urls should be separated by semi-colon.
OtherUrls	String	The appInstall Page website urls of the contact. Multiple urls should be separated by semi-colon.
AppInstallPageUrls	String	The other website urls of the contact. Multiple urls should be separated by semi-colon.
CustomUrlTypes	String	The custom type of the website url. This attribute values should be used along with CustomUrls. Multiple urls should be separated by semi-colon.
CustomUrls	String	The custom value of the website url. This attribute values should be used along with CustomUrlTypes. Multiple urls should be separated by semi-colon.

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to GoogleContacts.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	Specify scope to obtain the initial access and refresh token.

JWT OAuth

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The type of authentication to use when connecting to GoogleContacts.

The type of authentication to use when connecting to GoogleContacts.

Remarks

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• OAuth: Set this to perform OAuth authentication using a standard user account.
• OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.
• GCPInstanceAccount: Set this to get Access Token from Google Cloud Platform instance.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	Specify scope to obtain the initial access and refresh token.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

Specify scope to obtain the initial access and refresh token.

Remarks

Specify scope to obtain the initial access and refresh token.

Specify scope to obtain the initial access and refresh token.

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

The JWT Certificate store.

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:

USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.

The password for the OAuth JWT certificate.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

The subject of the OAuth JWT certificate.

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

The issuer of the Java Web Token.

Remarks

The issuer of the Java Web Token. Enter the value of a delegated user Email Address.

The issuer of the Java Web Token. Enter the value of a delegated user Email Address.

The user subject for which the application is requesting delegated access.

Remarks

The user subject for which the application is requesting delegated access. Enter the value of the Service Account Email.

The user subject for which the application is requesting delegated access. Enter the value of the Service Account Email.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to GoogleContacts and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\GoogleContacts Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM [My Contacts] WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.