Stay organized with collections
Save and categorize content based on your preferences.
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.
Before you begin
Before you can use the Conversational Analytics API, you must have a Google Cloud project that can access the data that you want to work with. To set up your project, complete the following steps:
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.
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.
To use the Conversational Analytics API, you must enable a set of required APIs in your Google Cloud project. If you plan to use the Conversational Analytics API from a Colab Enterprise environment, you must also enable additional APIs.
Required APIs
console
Enable the following APIs in the Google Cloud console for the Google Cloud project that you will use with the Conversational Analytics API.
With the Google Cloud CLI, run the following gcloud services enable commands to enable the Gemini Data Analytics API, the Gemini for Google Cloud API, and the BigQuery API, respectively:
To use the Conversational Analytics API, grant the following Identity and Access Management (IAM) roles in the Google Cloud console to the principals (such as users or service accounts) that need to interact with the API:
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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Enable the Conversational Analytics API\n\n| This product or feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA products and features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nThis 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](https://console.cloud.google.com/apis/library/geminidataanalytics.googleapis.com) in the Google Cloud console.\n\nBefore you begin\n----------------\n\nTo 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.\n\n### Prerequisites\n\n1. 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.\n2. In the Google Cloud console, on the project selector page, [create a Google Cloud project](/resource-manager/docs/creating-managing-projects) that can access the data that you want to use with the Conversational Analytics API.\n\n | **Note:** There is no billing for the Conversational Analytics API at this time.\n\n [Go to project selector](https://console.cloud.google.com/projectselector2/home/dashboard)\n\n### Required roles\n\nEnsure that you have the following IAM roles on the Google Cloud project that you will use with the Conversational Analytics API:\n\n[Go to Roles](https://console.cloud.google.com/iam-admin/roles)\n\n\u003cbr /\u003e\n\n- [Gemini for Google Cloud (`roles/cloudaicompanion.user`)](/iam/docs/roles-permissions/cloudaicompanion#cloudaicompanion.user)\n- [BigQuery User (`roles/bigquery.user`)](/iam/docs/roles-permissions/bigquery#bigquery.user)\n- [BigQuery Studio User (`roles/bigquery.studioUser`)](/iam/docs/roles-permissions/bigquery#bigquery.studioUser) (if you are using BigQuery Studio and data canvas)\n\nEnable the required APIs\n------------------------\n\nTo 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.\n| **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](https://console.cloud.google.com/apis/dashboard). Alternatively, your project administrator can grant you the [Service Usage Admin (`roles/serviceusage.serviceUsageAdmin`)](/service-usage/docs/access-control) role in the Google Cloud console, which lets you enable and disable APIs for the current project.\n\n### Enable the Gemini Data Analytics API\n\nTo use the Conversational Analytics API, enable the Gemini Data Analytics API by using the Google Cloud console or the Google Cloud CLI. \n\n### console\n\nEnable the Gemini Data Analytics API in the Google Cloud console.\n\n- [Enable the Gemini Data Analytics API](https://console.cloud.google.com/flows/enableapi?apiid=geminidataanalytics.googleapis.com)\n\n### gcloud\n\nTo enable the Gemini Data Analytics API with the [Google Cloud CLI](/sdk/docs/install-sdk), run the [`gcloud services enable`](/sdk/gcloud/reference/services/enable) command as follows: \n\n```\ngcloud services enable geminidataanalytics.googleapis.com --project=project_id\n```\n\nIn the previous example, replace \u003cvar class=\"readonly\" translate=\"no\"\u003eproject_id\u003c/var\u003e with your Google Cloud project ID.\n\n### Enable additional required APIs\n\nIn 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:\n\n- [Enable the Cloudaicompanion API](https://console.cloud.google.com/flows/enableapi?apiid=cloudaicompanion.googleapis.com)\n\n- [Enable the BigQuery API](https://console.cloud.google.com/flows/enableapi?apiid=bigquery.googleapis.com)\n\n### Enable APIs for Colab Enterprise\n\nIf you plan to use the Conversational Analytics API from a Colab Enterprise environment, enable the following APIs:\n\n- [Enable the Dataform API](https://console.cloud.google.com/flows/enableapi?apiid=dataform.googleapis.com)\n\n- [Enable the Compute Engine API](https://console.cloud.google.com/flows/enableapi?apiid=compute.googleapis.com)\n\n- [Enable the Vertex AI API](https://console.cloud.google.com/flows/enableapi?apiid=aiplatform.googleapis.com)\n\nAdditional configuration for VPC Service Controls\n-------------------------------------------------\n\nIf [VPC Service Controls](https://cloud.google.com/security/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:\n\n- From `geminidataanalytics.googleapis.com`, allow the following API:\n - `projects.locations.chat`\n- From [`aiplatform.googleapis.com`](/vertex-ai/docs/reference/rest), allow the following API:\n - [`projects.locations.endpoints.generateContent`](/vertex-ai/docs/reference/rest/v1/projects.locations.endpoints/generateContent)\n- From [`datacatalog.googleapis.com`](/data-catalog/docs/reference/rest), allow the following APIs:\n - [`entries.lookup`](/data-catalog/docs/reference/rest#rest-resource:-v1beta1.entries)\n - [`catalog.search`](/data-catalog/docs/reference/rest/v1/catalog/search)\n- From [`bigquery.googleapis.com`](/bigquery/docs/reference/rest), allow the following APIs:\n - [`jobs.query`](/bigquery/docs/reference/rest/v2/jobs/query)\n - [`jobs.insert`](/bigquery/docs/reference/rest/v2/jobs/insert)\n - [`jobs.getQueryResults`](/bigquery/docs/reference/rest/v2/jobs/getQueryResults)"]]
