Configura el acceso a la API de Google Cloud Search

Debes configurar el acceso a la API de Google Cloud Search antes de poder usar esta API directamente o a través de un SDK. En este documento, se abordan 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 API, habilitar la facturación, agregar y quitar colaboradores, y administrar los permisos.

  1. Abre la consola de Google Cloud

  2. En la parte superior de la página, haz clic en a la derecha de “Google Cloud Console”. Aparecerá un diálogo en el que se enumeran los proyectos actuales.

  3. Haz clic en PROYECTO NUEVO. Aparecerá la pantalla "New Project".

  4. Ingresa un nombre de proyecto en el campo Nombre del proyecto.

  5. (Opcional) Haz clic en Editar para editar el ID del proyecto. El ID del proyecto no se puede cambiar después de que se crea el proyecto; por lo tanto, elige uno que cumpla con tus necesidades durante todo el ciclo de vida del proyecto.

  6. Para explorar las ubicaciones del proyecto, haz clic en EXPLORAR.

  7. Haz clic en una ubicación para tu proyecto y, luego, en Seleccionar.

  8. Haz clic en Crear. La consola navega a la página Panel. El proyecto se crea en unos minutos.

Para obtener más información sobre crear y administrar proyectos, consulta Cómo crear y administrar proyectos.

2. Habilita la API

Debes habilitar la API de Google Cloud Search y crear una cuenta de servicio para obtener las credenciales.

  1. Para asegurarte de que estás en el proyecto recién creado, haz clic en el ícono a la derecha del banner de la consola de Google Cloud y selecciona el proyecto que acabas de crear.
  2. Haz clic en HABILITAR API Y SERVICIOS. Aparecerá la página "Te damos la bienvenida a la biblioteca de API".
  3. Navega a la API de Google Cloud Search.
  4. Haz clic en Habilitar. Aparecerá la página "Resumen".

Si deseas obtener más información para inhabilitar y habilitar las APIs, consulta Administra APIs en la consola de Google Cloud.

3. Crea credenciales de cuenta de servicio

  1. En la consola de Google Cloud, haz clic en Credenciales en el panel de navegación izquierdo. Aparecerá la página Credencial.
  2. En la lista desplegable Crear credenciales, selecciona Cuenta de servicio. Aparecerá la página “Crear cuenta de servicio”.
  3. Ingresa un nombre en el campo Nombre de cuenta de servicio.
  4. (opcional) Edita el ID de cuenta de servicio.
  5. Haz clic en Crear. Aparecerá la pantalla "Permisos de cuenta de servicio".
  6. Haz clic en Continuar. Aparecerá la pantalla “Otorgar a los usuarios acceso a esta cuenta de servicio”.
  7. Haz clic en CREAR CLAVE y, luego, en Listo. Aparecerá el diálogo "Se guardó la clave privada en tu computadora" y se descargará una copia de la clave privada en tu computadora.
  8. Haz clic en Cerrar.

Para obtener más información sobre las cuentas de servicio, consulta Cuentas de servicio, aplicaciones web y aplicaciones instaladas

4. Identifica la dirección de correo electrónico

  1. En la consola de Google Cloud, selecciona el proyecto que creaste en la parte superior de la página.
  2. Haz clic en el menú de navegación a la izquierda del banner de la consola de Google Cloud.
  3. Haz clic en IAM y Administrador > Cuentas de servicio.
  4. En la lista, en “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 de terceros para Google Cloud Search.

Para inicializar la compatibilidad de terceros con Cloud Search, sigue estos pasos:

  1. Tu proyecto de la plataforma de Cloud Search contiene credenciales de cuenta de servicio. Sin embargo, para inicializar la asistencia de terceros, debes crear credenciales de aplicaciones web. Si quieres obtener instrucciones para crear credenciales de aplicaciones web, consulta Crea credenciales. Después de completar este paso, deberías tener un ID de cliente y un archivo de secreto del cliente.

  2. Usa OAuth 2 Playground de Google para obtener un token de acceso:

    1. Haz clic en Configuración y marca la opción Usa tus propias credenciales de autenticación.
    2. Ingresa el ID de cliente y el secreto del cliente del paso 1.
    3. Haz clic en Cerrar.
    4. En el campo de permisos, escribe https://www.googleapis.com/auth/cloud_search.settings y haz clic en Autorizar. OAuth 2 Playground muestra un código de autorización.
    5. Haz clic en Intercambiar código de autorización para tokens. Se muestra un token.

  3. Para inicializar la asistencia de terceros para Cloud Search, usa el siguiente comando curl. Asegúrate de sustituir [YOUR_ACCESS_TOKEN] por el token que obtuviste en el paso 2.

    curl --request POST \
'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed

    Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de operation. Por ejemplo:

    {
name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
}

    Si el problema persiste, comunícate con el equipo de asistencia de Cloud Search.

  4. Usa operations.get para verificar que se inicializó la asistencia de terceros:

    curl \
'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
[YOUR_API_KEY]' \
--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
--header 'Accept: application/json' \
--compressed

    Cuando se completa la inicialización del tercero, contiene el campo done establecido en true. Por ejemplo:

    {
name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
done: true
}

Próximos pasos

Aquí hay algunos pasos que puedes seguir:

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

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