Configura el acceso a la API de Google Cloud Search
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Debes configurar el acceso a la API de Google Cloud Search antes de que puedas usarla directamente o a través de un SDK. En este documento, se describen los pasos necesarios para usar la API de REST de la API de Google Cloud Search.
1. Crea un proyecto de API
Para habilitar la API, primero debes crear un proyecto de Google Cloud. Este proyecto constituye la base para crear, habilitar y usar todos los servicios de Google Cloud, que incluyen administrar las APIs, habilitar la facturación, agregar o quitar colaboradores y administrar los permisos.
En la parte superior de la página, haz clic en arrow_drop_down a la derecha de "Consola de Google Cloud". Aparecerá un diálogo en el que se enumeran los proyectos actuales.
Haz clic en PROYECTO NUEVO. Aparecerá la pantalla "Proyecto nuevo".
Ingresa un nombre de proyecto en el campo Nombre del proyecto.
(opcional) Haz clic en Editar para editar el ID del proyecto. El ID del proyecto no se puede cambiar luego de que se crea el proyecto. Por lo tanto, elige un ID que abarque tus necesidades durante todo el ciclo de vida del proyecto.
Para explorar las ubicaciones del proyecto, haz clic en EXPLORAR.
Haz clic en una ubicación para tu proyecto y, luego, en Seleccionar.
Haz clic en Crear. La consola navega a la página Panel. El proyecto se crea en unos minutos.
Debes habilitar la API de Google Cloud Search y crear una cuenta de servicio para obtener las credenciales.
Para asegurarte de que estás en el proyecto creado recientemente, haz clic en el ícono arrow_drop_down a la derecha del banner de la consola de Google Cloud y selecciona el proyecto que acabas de crear.
Haz clic en HABILITAR API Y SERVICIOS. Aparecerá la página "Bienvenido a la Biblioteca de APIs".
En la consola de Google Cloud, haz clic en Credenciales en el menú de navegación de la izquierda. Aparecerá la página Credencial.
En la lista desplegable Crear credenciales, selecciona Cuenta de servicio. Aparecerá la página "Crear cuenta de servicio".
Ingresa un nombre en el campo Nombre de cuenta de servicio.
(opcional) Edita el ID de cuenta de servicio.
Haz clic en Crear. Aparecerá una pantalla de "Permisos de la cuenta de servicio".
Haz clic en Continuar. Aparecerá la pantalla "Otorga a los usuarios acceso a esta cuenta de servicio".
Haz clic en CREAR CLAVE y, luego, en Listo. Aparecerá el diálogo “Clave privada guardada en tu computadora” y se descargará una copia de la clave privada a tu computadora.
En la consola de Google Cloud, selecciona el proyecto que creaste en la parte superior de la página.
Haz clic en el menú de navegación a la izquierda del banner de la consola de Google Cloud.
Haz clic en IAM y Administrador > Cuentas de servicio.
En la lista, bajo "ID de cuenta de servicio", toma nota de la dirección de correo electrónico generada que identifica la cuenta de servicio que configuraste. Esta dirección de correo electrónico se usa cuando se agrega una fuente de datos a Cloud Search.
5. Inicializa la asistencia de terceros
Antes de llamar a cualquier otra API de Cloud Search, debes inicializar la compatibilidad con terceros para Google Cloud Search.
Sigue estos pasos para inicializar la compatibilidad con terceros en Cloud Search:
Tu proyecto de la plataforma de Cloud Search contiene credenciales de cuentas de servicio.
Sin embargo, para inicializar la compatibilidad con terceros, debes crear credenciales de aplicación web. Para obtener instrucciones sobre cómo crear credenciales de aplicaciones web, consulta Crea credenciales.
Después de completar este paso, deberías tener un archivo de ID de cliente y secreto de cliente.
Haz clic en Configuración y marca la opción Usar tus propias credenciales de autenticación.
Ingresa el ID de cliente y el secreto del cliente del paso 1.
Haz clic en Cerrar.
En el campo de permisos, escribe https://www.googleapis.com/auth/cloud_search.settings y haz clic en Autorizar. OAuth 2 Playground devuelve un código de autorización.
Haz clic en Intercambiar código de autorización para tokens. Se devuelve un token.
Para inicializar la compatibilidad con terceros para Cloud Search, usa el siguiente comando curl. Asegúrate de reemplazar [YOUR_ACCESS_TOKEN] por el token que obtuviste en el paso 2.
Si planeas usar Google Cloud Search con un repositorio de datos que no es de Google, como Microsoft® SharePoint®, debes crear una fuente de datos. Para obtener instrucciones sobre cómo agregar una fuente de datos, consulta Agrega una fuente de datos a la búsqueda.
Cuando hayas configurado tu fuente de datos, podrás crear y registrar un esquema para identificar cómo Google Cloud Search debe representar los datos del repositorio.
[null,null,["Última actualización: 2025-08-29 (UTC)"],[],[],null,["# Configure access to the Google Cloud Search API\n\nYou must configure access to the Google Cloud Search API before you can\nuse this API either directly or through an SDK. This document\ncovers the steps required to use the Google Cloud Search API REST API.\n\n1. Create an API project\n------------------------\n\nTo enable the API, you must first create an Google Cloud project. This\nproject forms the basis for creating, enabling, and using all Google Cloud\nservices, including managing APIs, enabling billing, adding and\nremoving collaborators, and managing permissions.\n\n1. Open the [Google Cloud console](https://console.cloud.google.com/apis/dashboard).\n\n2. At the top of the page, click\n arrow_drop_down\n to the right of \"Google Cloud Console.\" A dialog listing current projects\n appears.\n\n3. Click **NEW PROJECT**. The \"New Project\" screen appears.\n\n4. Enter a project name in the **Project Name** field.\n\n5. (optional) Click **Edit** to edit the Project ID. The project ID can't be\n changed after the project is created, so choose an\n ID that meets your needs for the lifetime of the project.\n\n6. To browse locations for the project, click **BROWSE**.\n\n7. Click on a location for your project and click **Select**.\n\n8. Click **Create**. The console navigates to the Dashboard page. The project\n is created within a few minutes.\n\nFor further information on creating and managing projects, refer to\n[Creating and Managing Projects](https://support.google.com/cloud#topic=6158848).\n\n2. Enable the API\n-----------------\n\nYou need to enable the Google Cloud Search API and create a service account to\nobtain credentials.\n\n1. To ensure you are on the newly created project, click the arrow_drop_down icon to the right of the Google Cloud console banner and select your newly-created project.\n2. Click **ENABLE APIS AND SERVICES**. The \"Welcome to API Library\" page appears.\n3. Navigate to the [Google Cloud Search API](https://console.cloud.google.com/apis/api/cloudsearch.googleapis.com).\n4. Click **Enable**. The \"Overview\" page appears.\n\nFor further information on enabling and disabling APIs, refer to\n[Manage APIs in the Google Cloud console](https://support.google.com/cloud/answer/6326510)\n| **Note:** Different Cloud Search APIs require different accounts to execute (admin, service, and user). For further information, refer to the [reference documentation](/workspace/cloud-search/docs/reference) for the method you want to call.\n\n3. Create service account credentials\n-------------------------------------\n\n1. In the [Google Cloud console](https://console.cloud.google.com/apis/library), click **Credentials** in the left navigation. The Credential page appears.\n2. From the **Create credentials** drop-down list, select **Service account**. The \"Create service account\" page appears.\n3. Enter a name in the **Service account name** field.\n4. (optional) Edit the service account ID.\n5. Click **Create**. A \"Service account permissions\" screen appears.\n6. Click **Continue**. A \"Grant users access to this service account\" screen appears.\n7. Click **CREATE KEY** and click **Done**. A \"Private key saved to your computer\" dialog appears and a copy of the private key downloads to your computer.\n8. Click **Close**.\n\nFor further information on service accounts, refer to\n[Service accounts, web applications, and installed applications](https://support.google.com/cloud/answer/6158849#serviceaccounts)\n\n4. Identify email address\n-------------------------\n\n1. From the [Google Cloud console](https://console.cloud.google.com/apis/dashboard), select the project you created at the top of the page.\n2. Click the Navigation menu to the left of the Google Cloud console banner.\n3. Click **IAM and Admin** \\\u003e **Service accounts**.\n4. In the list, under \"Service account ID,\" make note of the generated email address that identifies the service account you configured. This email address is used when adding a data source to Cloud Search.\n\n5. Initialize third-party support\n---------------------------------\n\nBefore you can call any other Cloud Search APIs, you must initialize third-party\nsupport for Google Cloud Search.\n| **Note:** If you successfully executed the Cloud Search tutorial, you have already initialized third-party support for Cloud Search and can skip this step.\n\nTo initialize third-party support for Cloud Search:\n\n1. Your Cloud Search platform project contains service account credentials.\n However, for the sake of initializing third-party support, you must create web\n application credentials. For instructions on how to create web application\n credentials, refer to\n [Create credentials](/workspace/guides/create-credentials).\n Upon completing this step, you should have a client ID and client secret file.\n\n2. Use\n [Google's OAuth 2 playground](https://developers.google.com/oauthplayground/)\n to obtain an access token:\n\n 1. Click settings and check **User your own auth credentials**.\n 2. Enter the client ID and client secret from step 1.\n 3. Click **Close**.\n 4. In the scopes field, type `https://www.googleapis.com/auth/cloud_search.settings` and click **Authorize**. The OAuth 2 playground returns an authorization code.\n 5. Click **Exchange authorization code for tokens**. A token is returned.\n3. To initialize third-party support for Cloud Search, use the following curl\n command. Be sure to substitute `[YOUR_ACCESS_TOKEN]` with the token obtained in\n step 2.\n\n curl --request POST \\\n 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \\\n --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: application/json' \\\n --data '{}' \\\n --compressed\n\n If successful, the response body contains an instance of\n [`operation`](/workspace/cloud-search/docs/reference/rest/v1/operations#Operation). For\n example: \n\n {\n name: \"operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY\"\n }\n\n If unsuccessful, contact Cloud Search support.\n4. Use [operations.get](/workspace/cloud-search/docs/reference/rest/v1/operations/get) to verify that\n third-party support is initialized:\n\n curl \\\n 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=\n [YOUR_API_KEY]' \\\n --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \\\n --header 'Accept: application/json' \\\n --compressed\n\n When the third-party initialization is complete, it contains the\n field `done` set to `true`. For example: \n\n {\n name: \"operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY\"\n done: true\n }\n\nNext Steps\n----------\n\nHere are few next steps you might take:\n\n1. If you plan on using Google Cloud Search with a non-Google data repository,\n such as Microsoft® SharePoint®, you\n must create a data source. For instructions on\n adding a data source, refer to\n [Add a data source to search](https://support.google.com/a/answer/7056471).\n\n2. Once you set up your data source, you can\n [create and register schema](/workspace/cloud-search/docs/guides/schema-guide) to identify\n how Google Cloud Search should represent the data in the repository."]]
