Enable the Conversational Analytics API

Private preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

This page describes the steps for enabling the Conversational Analytics API (accessed through geminidataanalytics.googleapis.com) for your Google Cloud project. The Conversational Analytics API is the first capability under the Data Analytics API with Gemini in the Google Cloud console.

Note: To use the Conversational Analytics API, you must be part of the private preview. To express interest, fill out the preview interest form.

Before you begin

To work with the Conversational Analytics API, you must fulfill the following prerequisites and have the required Identity and Access Management (IAM) roles on your Google Cloud project.

Prerequisites

1. Identify the data that you want to use with the Conversational Analytics API. You can use data sources like BigQuery tables, Looker Explores, and Looker Studio reports.

2. In the Google Cloud console, on the project selector page, create a Google Cloud project that can access the data that you want to use with the Conversational Analytics API.

   Note: There is no billing for the Conversational Analytics API at this time.

   Go to project selector

Required roles

Ensure that you have the following IAM roles on the Google Cloud project that you will use with the Conversational Analytics API:

Go to Roles

• Gemini for Google Cloud (roles/cloudaicompanion.user)
• BigQuery User (roles/bigquery.user)
• BigQuery Studio User (roles/bigquery.studioUser) (if you are using BigQuery Studio and data canvas)

Enable the required APIs

To use the Conversational Analytics API, you must enable the required APIs in your Google Cloud project. When you enable an API, you might need to refresh the page to confirm that the API has been enabled.

Note: If you don't have permission to enable the APIs, ask your project administrator to enable the APIs for you from the APIs & Services dashboard. Alternatively, your project administrator can grant you the Service Usage Admin (roles/serviceusage.serviceUsageAdmin) role in the Google Cloud console, which lets you enable and disable APIs for the current project.

Enable the Gemini Data Analytics API

To use the Conversational Analytics API, enable the Gemini Data Analytics API by using the Google Cloud console or the Google Cloud CLI.

console

Enable the Gemini Data Analytics API in the Google Cloud console.

• Enable the Gemini Data Analytics API

gcloud

To enable the Gemini Data Analytics API with the Google Cloud CLI, run the gcloud services enable command as follows:

gcloud services enable geminidataanalytics.googleapis.com --project=project_id

In the previous example, replace project_id with your Google Cloud project ID.

Enable additional required APIs

In addition, to use the Conversational Analytics API, you must enable the following APIs in the Google Cloud project that you will use with the Conversational Analytics API:

• Enable the Cloudaicompanion API

• Enable the BigQuery API

Enable APIs for Colab Enterprise

If you plan to use the Conversational Analytics API from a Colab Enterprise environment, enable the following APIs:

• Enable the Dataform API

• Enable the Compute Engine API

• Enable the Vertex AI API

Additional configuration for VPC Service Controls

If VPC Service Controls is enabled for your organization or for the Google Cloud project that you're using, add the following APIs, which are used by the Conversational Analytics API, to the allowlist:

• From geminidataanalytics.googleapis.com, allow the following API:
  • projects.locations.chat
• From aiplatform.googleapis.com, allow the following API:
  • projects.locations.endpoints.generateContent
• From datacatalog.googleapis.com, allow the following APIs:
  • entries.lookup
  • catalog.search
• From bigquery.googleapis.com, allow the following APIs:
  • jobs.query
  • jobs.insert
  • jobs.getQueryResults