This page provides a guide to Establishing a Connection to GoogleContacts in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to GoogleContacts

Establishing a Connection shows how to authenticate to GoogleContacts and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from GoogleContacts through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to GoogleContacts by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to GoogleContacts

Authorize the Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud 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 Cloud. 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 Cloud 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 Cloud to enable the automatic refreshing of the access token.

GCP Instance Accounts

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

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to GoogleContacts via a desktop application or a headless machine.

(For information on getting and setting the OAuthAccessToken and other configuration parameters, see the Desktop Authentication section of "Connecting to GoogleContacts".)

However, you must create a custom OAuth application to connect to GoogleContacts via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

• control branding of the authentication dialog
• control the redirect URI that the application redirects the user to after the user authenticates
• customize the permissions that you are requesting from the user

The following sections describe how to enable the Directory API and create custom OAuth applications for user accounts (OAuth) and Service Accounts (OAuth/JWT).

Enable the People API

Follow these steps to enable the People API:

1. Navigate to the Google Cloud Console.
2. Select Library from the left-hand navigation menu. This opens the Library page.
3. In the search field, enter "People API" and select People API from the search results.
4. On the People API page, click ENABLE.

Create an OAuth Application

To create custom OAuth applications that retrieve the necessary OAuth connection properties, follow these procedures.

User Accounts (OAuth)

For users whose AuthScheme is OAuth and who need to authenticate over a web application, you must always create a custom OAuth application. (For desktop and headless flows, creating a custom OAuth application is optional.)

Do the following:

1. Navigate to the Google Cloud Console.
2. Create a new project or select an existing project.
3. At the left-hand navigation menu, select Credentials.
4. If this project does not already have a consent screen configured, click CONFIGURE CONSENT SCREEN to create one. If you are not using a Google Workspace account, you are restricted to creating an External-type Consent Screen, which requires specifying a support email and developer contact email. Additional info is optional.
5. On the Credentials page, select Create Credentials > OAuth Client ID.
6. In the Application Type menu, select Web application.
7. Specify a name for your custom OAuth application.
8. Under Authorized redirect URIs, click ADD URI and enter a redirect URI.
9. Click Enter, then CREATE. The Cloud Console returns you to the Credentials page.
   A window opens that displays your client Id and client secret.
10. Record the client Id and Client Secret for later use as the OAuthClientId and OAuthClientSecret connection properties.

Note: The client secret remains accessible from from the Google Cloud Console.

Service Accounts (OAuthJWT)

Service accounts (AuthScheme OAuthJWT) can be used in an OAuth flow to access Google APIs on behalf of users in a domain. A domain administrator can delegate domain-wide access to the service account.

To create a new service account:

1. Navigate to the Google Cloud Console.
2. Create a new project or select an existing project.
3. At the left-hand navigation menu, select Credentials.
4. Select Create Credentials > Service account.
5. On the Create service account page, enter the Service account name, the Service account ID, and, optionally, a description.
6. Click DONE. The Cloud Console redisplays the Credentials page.
7. In the Service Accounts section, select the service account you just created.
8. Click the KEYS tab.
9. Click ADD KEY > Create new key.
10. Select any supported Key type (see OAuthJWTCert and OAuthJWTCertType).
11. Click CREATE. The key is automatically downloaded to your device, and any additional information specific to the key is displayed.
12. Record the additional information for future use.

To complete the service account flow, generate a private key in the Google Cloud Console. In the service account flow, the driver exchanges a JSON Web token (JWT) for the OAuthAccessToken. The private key is required to sign the JWT. The driver will have the same permissions granted to the service account.

Customizing the SSL Configuration

By default, the Cloud 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 Cloud 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 Cloud.
• 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 Cloud 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 Cloud models the data in GoogleContacts as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Google Contacts 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.

CData Cloud - Google Contacts 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.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with GoogleContacts.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from GoogleContacts, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Google Contacts Stored Procedures

Name	Description
CopyOtherContactsToMyContacts	Copies an 'Other contact' to a new contact in the user's 'myContacts' group
ModifyContactGroupMembers	Modify the members of a contact group owned by the authenticated user.
UpdateOrDeleteContactPhoto	Update or Delete a contact's photo.

Copies an 'Other contact' to a new contact in the user's 'myContacts' group

Stored Procedure Specific Information

Process of Copy Other Contacts To My Contacts

GoogleContacts allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The available columns for CopyOtherContactsToMyContacts are Id, FieldsToCopy and Sources. For example:

EXECUTE CopyOtherContactsToMyContacts Id = 'c2583603548064626314', FieldsToCopy = 'emailAddresses, names, phoneNumbers', Sources = 'READ_SOURCE_TYPE_CONTACT'

Input

Name	Type	Required	Description
Id	String	True	The Id of the 'Other contact' to copy.
FieldsToCopy	String	True	The fields to restrict which fields are copied into the new contact. Valid values are: emailAddresses,names,phoneNumbers
Sources	String	True	A mask of what source types to return. Valid values are: READ_SOURCE_TYPE_UNSPECIFIED, READ_SOURCE_TYPE_PROFILE, READ_SOURCE_TYPE_CONTACT, READ_SOURCE_TYPE_DOMAIN_CONTACT

Result Set Columns

Name	Type	Description
Success	String	Returns True if contact group has been modified.

Modify the members of a contact group owned by the authenticated user.

Stored Procedure Specific Information

Process of Modify Contact Group Members

GoogleContacts allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The available columns for ModifyContactGroupMembers are Id, ResourceIdsToAdd and ResourceIdsToRemove.

Note: The only system contact groups that can have members added are contactGroups/myContacts and contactGroups/starred. Other system contact groups are deprecated and can only have contacts removed. For example:

EXECUTE ModifyContactGroupMembers Id = 'starred', ResourceIdsToAdd = 'c8493601355484697130, c8493601355484697130', ResourceIdsToRemove = ''

Input

Name	Type	Required	Description
Id	String	True	The Id of the contact group to modify.
ResourceIdsToAdd	String	False	A comma separated list of ids of the contact people to add.
ResourceIdsToRemove	String	False	A comma separated list of ids of the contact people to remove.

Result Set Columns

Name	Type	Description
Success	String	Returns True if contact group has been modified.

Update or Delete a contact's photo.

Stored Procedure Specific Information

Process of Update or Delete Contact Photo

GoogleContacts allows only a small subset of columns to be used in the EXEC query. These columns can typically be used with only = comparison. The available columns for UpdateOrDeleteContactPhoto are Id, Action, FileSource and Url.

Note: Id is required column. The Action attribute defines the operation to perform. The supported operators are 'UPDATE, Delete' for Action. You need to specify either FileSource or URL to update the contact photo. For example:

EXECUTE UpdateOrDeleteContactPhoto Id = 'c2845916184580148264', Action = 'Update', FileSource = 'D:\GooglePeople_API_Outputs\contactphoto.png'

EXECUTE UpdateOrDeleteContactPhoto Id = 'c2845916184580148264', Action = 'Update', Url = 'https://play-lh.googleusercontent.com/-Xqd3k7aJqZY/AAAAAAAAAAI/AAAAAAAAAAA/AMZuuckWFzqX627ygMhiilKbqmIA-T_AsQ/photo.jpg'

EXECUTE UpdateOrDeleteContactPhoto Id = 'c2845916184580148264', Action = 'Delete'

Input

Name	Type	Required	Description
Id	String	True	The Id of the contact.
Action	String	True	Update or Delete operation you want to perform on Contact Photo. Possible values: Update, Delete
FileSource	String	False	The complete filepath of the photo to be uploaded. You need to specify either this field or URL.
URL	String	False	An accessible URL the image will be downloaded from and then posted to the target. You need to specify either this field or FileSource.

Result Set Columns

Name	Type	Description
Success	String	Returns True if contact group has been modified.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for GoogleContacts:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the [My Contacts] table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='[My Contacts]' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the ModifyContactGroupMembers stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='ModifyContactGroupMembers' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the [My Contacts] table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='[My Contacts]' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:googlecontacts:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

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
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.

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

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

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.
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.

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.

Possible Values

Auto, OAuth, OAuthJWT

Data Type

string

Default Value

"Auto"

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
Scope	Specify scope to obtain the initial access and refresh token.

Specify scope to obtain the initial access and refresh token.

Data Type

string

Default Value

"https://www.googleapis.com/auth/contacts.other.readonly https://www.googleapis.com/auth/contacts.readonly https://www.googleapis.com/auth/user.gender.read https://www.googleapis.com/auth/user.emails.read https://www.googleapis.com/auth/user.birthday.read https://www.googleapis.com/auth/user.addresses.read https://www.googleapis.com/auth/profile.language.read https://www.googleapis.com/auth/profile.agerange.read https://www.googleapis.com/auth/user.organization.read https://www.googleapis.com/auth/user.phonenumbers.read"

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.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

"PEMKEY_BLOB"

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.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

"*"

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.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

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 Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

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

---

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

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

Data Type

string

Default Value

""

Remarks

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

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.
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.

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

Data Type

int

Default Value

-1

Remarks

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

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

Data Type

string

Default Value

""

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.

Data Type

int

Default Value

60

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 Cloud throws an exception.