Interact Marketplace integration can be used to search Google Drive, Task and Calendars.
Configuring Google Cloud Platform API & Services
-
Within the Google Cloud Platform navigate to the API & Services Dashboard https://console.cloud.google.com/apis/dashboard.
-
Create a new Project.
- Enable required APIs
- Navigate to the newly created project via Project Dashboard;
- Click 'Enable APIs And Services';
- Search for and enable the APIs that are intended to be accessed from Interact. The table below shows the APIs that you are able to use with Marketplace.
| Google API & Services | Integration Capability | Required Scopes |
|---|---|---|
| Google Drive API | Provides the ability to search Google Drive directly using Interact's search feature. | DriveService.Scope.DriveFile, DriveService.Scope.Drive, DriveService.Scope.DriveScripts |
| Google Calendar API | Offers an Interact user the ability to access and manage their calendar directly from within Interact. | CalendarService.Scope.CalendarReadonly |
| Google Tasks API | Offers an Interact user the ability to access and manage their tasks directly from within Interact. | TasksService.Scope.Tasks |
Enabling Google API & Services
It is recommended that you only enable the APIs which you intended to use within Interact.
- Specify User Type
- Navigate back to the APIs & Services dashboard;
- Go to the OAuth consent screen;
- Specify the the User Type for the targeted audience of the integration. If you are unsure, you should choose 'Internal';
- Enter your information for the fields provided for the steps 'OAuth consent screen', 'Scopes' and 'Summary'. Once this is done, navigate back to the dashboard. (By default, no scopes are needed)
- Configure OAuth Settings
From the Credentials tab, click 'Create Credentials' followed by 'OAuth client ID'. Specify the details outlined in the table below.
| Fields | Value | Example |
|---|---|---|
| Application type | Web application | |
| Name | Specify an appropriate name. | Interact Software Marketplace |
| Authorized JavaScript origins | Your Intranet URL | https://intranet.acme.com |
| Authorized redirect URIs | Add the following URL: https://[YourIntranetURL]/marketplace/gsuite/account/sign-in/oauth2 | https://intranet.acme.com/marketplace/gsuite/account/sign-in/oauth2 |
The Google Client Id is not generated and displayed until you save this screen. You can enter a dummy URLs and return to edit them after the Id has been generated. When they are shown, make a note of the Google client id and the secret for configuring the Interact Marketplace.
Redirect URL Deprecation
From 24th March 2021, Interact deprecated the use of the following Redirect URL -https://[YourIntranetURL]/google/signin-[Google_Client_ID]
Configuring Interact Marketplace
- From Application Settings > Control Panel > Marketplace, select Google
- Specify the Client ID and Client Secret from the Google API Project.
- Click Save.
- If planning to use the Google Search Connector, you must enable Google Drive in Application Settings > Control Panel > Manage Application Variables > Integrations.
Editing Marketplace Configuration
The editing of existing Marketplace Configuration options, will forcibly purge authentication tokens of all users who have used the integration requiring them to re-authenticate before being able to use the integration again, so that any scope changes can be immediately applied to the new access tokens (existing service provider access tokens won't automatically pick up changes until re-authentication.)
Guidance
- Interact uses the following API versions: Google Drive API v3, Google Calendar API v3
- Google API Quotas can be reviewed and configured with Quotas tab within the Project Dashboard (API & Services)
- The Interact Google Drive search is performed within the context of the user, so users will not be able to find documents or see documents that they don't have permission to see. Interact respects the permissions that are used within your Google Drive and Workspace environment'
Common Errors
Updated about 1 year ago