Se cambiará el nombre de Retail a Vertex AI Search para la venta minorista. Estamos en proceso de actualizar el contenido para reflejar el nuevo desarrollo de la marca.

Se usó la API de Cloud Translation para traducir esta página.

Autentícate en Vertex AI Search for Retail

En este documento, se describe cómo autenticar de manera programática Vertex AI Search for Retail. Cómo que te autentiques en Vertex AI Search for Retail depende de la interfaz que uses para acceder a la API y el entorno en el que se ejecuta tu código.

Para obtener más información sobre la validación de Google Cloud, consulta la descripción general de la validación.

Acceso a la API

Vertex AI Search for Retail admite el acceso programático. Puedes acceder a la API de las siguientes maneras:

Bibliotecas cliente
REST

Bibliotecas cliente

Las bibliotecas cliente de Vertex AI Search para la venta minorista proporcionan compatibilidad de lenguaje de alto nivel para la autenticación en Vertex AI Search para la venta minorista de manera programática. Para autenticar las llamadas a las APIs de Google Cloud, las bibliotecas cliente admiten las credenciales predeterminadas de la aplicación (ADC). Las bibliotecas buscan credenciales en un conjunto de ubicaciones definidas y las usan para lo siguiente: autenticar solicitudes en la API. Con ADC, puedes hacer que las credenciales estén disponibles para tu aplicación en una variedad de entornos, como el de desarrollo o producción local, sin necesidad de modificar el código de la aplicación.

REST

Puedes autenticarte en la API de Vertex AI Search for retail con tus credenciales de gcloud CLI o con las credenciales predeterminadas de la aplicación. Para obtener más información sobre la autenticación en solicitudes de REST, consulta Autentícate para usar REST. Para obtener información sobre los tipos de credenciales, consulta Credenciales de la CLI de gcloud y credenciales de ADC.

Claves de API

Las claves de API proporcionan una forma de asociar una llamada a la API con un proyecto, que se usa para fines de facturación y cuota, sin determinar la identidad del emisor. Las claves de API solo se pueden usar con métodos de API que admitan claves de API.

Vertex AI Search for Retail admite claves de API para los siguientes métodos de API:

userEvents.collect

Para obtener más información sobre el uso de claves de API con Vertex AI Search for Retail, consulta Crea una clave de API. Para obtener información general sobre el uso de claves de API, consulta Autentica mediante claves de API.

Credenciales de usuario y ADC para Vertex AI Search para la venta minorista

Una forma de proporcionar credenciales a ADC es usar la CLI de gcloud para insertar las credenciales de los usuarios en un archivo de credenciales. Este archivo se ubica en tu sistema de archivos local, donde ADC lo pueda encontrar. Luego, ADC usa las credenciales del usuario proporcionadas para autenticar solicitudes. Este método se suele usar para el desarrollo local.

Si usas este método, es posible que aparezca un error de autenticación cuando intentes autenticarte en Vertex AI Search para la venta minorista. Para obtener más información sobre este error y cómo abordarlo, consulta Las credenciales de usuario no funcionan.

Configura la autenticación de Vertex AI Search for Retail

La forma de configurar la autenticación dependerá del entorno en el que se ejecuta tu código.

Las siguientes opciones para configurar la autenticación son las más utilizadas. Para obtener más información y opciones de autenticación, consulta Métodos de autenticación.

Antes de completar estas instrucciones, debes completar la configuración básica de Vertex AI Search for Retail, como se describe en Antes de comenzar.

Para un entorno de desarrollo local

Puedes configurar las credenciales de un entorno de desarrollo local de las siguientes maneras:

Credenciales de usuario para bibliotecas cliente o herramientas de terceros
Credenciales de usuario para solicitudes de REST desde la línea de comandos

Bibliotecas cliente o herramientas de terceros

Configura las credenciales predeterminadas de la aplicación (ADC) en tu entorno local:

Install the Google Cloud CLI, then initialize it by running the following command:
```
gcloud init
```
If you're using a local shell, then create local authentication credentials for your user account:
```
gcloud auth application-default login
```
You don't need to do this if you're using Cloud Shell.
Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:
```
gcloud auth application-default set-quota-project PROJECT_ID
```
Aparecerá una pantalla de acceso. Después de acceder, tus credenciales se almacenan en el archivo de credenciales local que usa ADC.

Para obtener más información sobre cómo trabajar con ADC en un entorno local, consulta Entorno de desarrollo local.

Solicitudes REST desde la línea de comandos

Cuando realizas una solicitud REST desde la línea de comandos, puedes usar tus credenciales de gcloud si incluyes gcloud auth print-access-token como parte del comando que envía la solicitud.

En el siguiente ejemplo, se enumeran las cuentas de servicio para el proyecto especificado. Puedes usar el mismo patrón para cualquier solicitud de REST.

Antes de usar cualquiera de los datos de solicitud a continuación, realiza los siguientes reemplazos:

PROJECT_ID es el ID del proyecto de Google Cloud.

Para enviar tu solicitud, expande una de estas opciones:

curl (Linux, macOS o Cloud Shell)

Ejecuta el siguiente comando:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts"

PowerShell (Windows)

Ejecuta el siguiente comando:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts" | Select-Object -Expand Content

Para obtener más información sobre la autenticación con REST y gRPC, consulta Autentica para usar REST. Si deseas obtener información sobre la diferencia entre tus credenciales locales de ADC y tus credenciales de la CLI de gcloud, consulta Credenciales de la CLI de gcloud y credenciales de ADC.

En Google Cloud

Para autenticar una carga de trabajo que se ejecuta en Google Cloud, debes usar las credenciales de la cuenta de servicio conectada al recurso de procesamiento en el que se ejecuta tu código, como una instancia de máquina virtual (VM) de Compute Engine. Este enfoque es el método de autenticación preferido para el código que se ejecuta en un recurso de procesamiento de Google Cloud.

En la mayoría de los servicios, debes conectar la cuenta de servicio cuando crees el recurso que ejecutará el código; no puedes agregar o reemplazar la cuenta de servicio más adelante. Compute Engine es una excepción: te permite conectar una cuenta de servicio a una instancia de VM en cualquier momento.

Usa gcloud CLI para crear una cuenta de servicio y conectarla a tu recurso:

Install the Google Cloud CLI, then initialize it by running the following command:
```
gcloud init
```
Set up authentication:
1. Create the service account:
```
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
```
  Replace SERVICE_ACCOUNT_NAME with a name for the service account.
2. To provide access to your project and your resources, grant a role to the service account:
```
gcloud projects add-iam-policy-binding PROJECT_ID --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" --role=ROLE
```
  Replace the following:
  - SERVICE_ACCOUNT_NAME: the name of the service account
  - PROJECT_ID: the project ID where you created the service account
  - ROLE: the role to grant
  Note: The --role flag affects which resources the service account can access in your project. You can revoke these roles or grant additional roles later. In production environments, do not grant the Owner, Editor, or Viewer roles. Instead, grant a predefined role or custom role that meets your needs.
3. To grant another role to the service account, run the command as you did in the previous step.
4. Grant the required role to the principal that will attach the service account to other resources.
```
gcloud iam service-accounts add-iam-policy-binding SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com --member="user:USER_EMAIL" --role=roles/iam.serviceAccountUser
```
  Replace the following:
  - SERVICE_ACCOUNT_NAME: the name of the service account
  - PROJECT_ID: the project ID where you created the service account
  - USER_EMAIL: the email address for a Google Account
Crea el recurso que ejecutará tu código y conecta la cuenta de servicio a ese recurso. Por ejemplo, si usas Compute Engine:
Create a Compute Engine instance. Configure the instance as follows:
- Reemplaza INSTANCE_NAME por el nombre de instancia que desees.
- Establece la marca --zone en la zona en la que deseas crear tu instancia.
- Establece la marca --service-account en la dirección de correo electrónico de la cuenta de servicio que creaste.

Para obtener más información acerca de la autenticación en las APIs de Google, consulta Métodos de autenticación.

Local o en un proveedor de servicios en la nube diferente

El método preferido para configurar la autenticación desde fuera de Google Cloud es usar la federación de identidades para cargas de trabajo. Para obtener más información, consulta Local u otro proveedor de servicios en la nube en la documentación de autenticación.

Control de acceso para Vertex AI Search for Retail

Después de autenticarte en Vertex AI Search para la venta minorista, debes tener autorización para acceder a los recursos de Google Cloud. Vertex AI Search para usos de venta minorista Identity and Access Management (IAM) para la autorización.

Para obtener más información sobre los roles de Vertex AI Search para venta minorista, consulta Identity and Access Management (IAM). Para obtener más información sobre IAM y la autorización, consulta Descripción general de IAM.

¿Qué sigue?

Obtén más información sobre los métodos de validación de Google Cloud.
Consulta una lista de casos de uso de autenticación.