Usar OAuth

La API de Places Insights admite el uso de OAuth 2.0 para la autenticación. Google admite situaciones comunes de OAuth 2.0, como las de un servidor web.

En este documento, se describe cómo pasar un token de OAuth a la llamada a la API de Places Insights en tu entorno de desarrollo. Si deseas obtener instrucciones para usar OAuth en un entorno de producción, consulta Autenticación en Google.

Antes de comenzar

Antes de comenzar a usar la API de Places Insights, debes tener un proyecto con una cuenta de facturación y la API de Places Insights habilitada. Recomendamos crear varios propietarios de proyecto y administradores de facturación para que tu equipo siempre tenga a alguien disponible con estos roles. Si deseas obtener más información, consulta Set up in Cloud Console.

Información acerca de OAuth

Existen muchas formas de crear y administrar tokens de acceso con OAuth según tu entorno de implementación.

Por ejemplo, el sistema Google OAuth 2.0 admite interacciones de servidor a servidor, como las que se realizan entre tu aplicación y un servicio de Google. En este caso, necesitas una cuenta de servicio, que es una cuenta que pertenece a tu aplicación en lugar de a un usuario final individual. Tu aplicación llama a las APIs de Google en nombre de la cuenta de servicio, de modo que los usuarios no estén involucrados de manera directa. Para obtener más información sobre los métodos de autenticación, consulta Autenticación en Google.

Como alternativa, puedes usar la API de Places Insights como parte de una app para dispositivos móviles de Android o iOS. Para obtener información general sobre el uso de OAuth con la API de Places Insights, incluida la información sobre la administración de tokens de acceso para diferentes entornos de implementación, consulta Usa OAuth 2.0 para acceder a las APIs de Google.

Información acerca de los permisos de OAuth

Para usar OAuth con la API de Places Insights, se debe asignar el siguiente permiso al token de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Ejemplo: Prueba las llamadas a la API de REST en tu entorno de desarrollo local

Si deseas probar la API de Places Insights con un token de OAuth, pero no tienes configurado un entorno para generar tokens, puedes usar el procedimiento que se indica en esta sección para realizar la llamada.

En este ejemplo, se describe cómo usar el token de OAuth que proporcionan las Credenciales predeterminadas de la aplicación (ADC) para realizar la llamada. Si deseas obtener información sobre el uso de ADC para llamar a las APIs de Google mediante bibliotecas cliente, consulta Autentícate mediante bibliotecas cliente.

Requisitos previos

Antes de realizar una solicitud REST con ADC, usa Google Cloud CLI para proporcionar credenciales a ADC:

  1. Si aún no lo hiciste, crea un proyecto y habilita la facturación siguiendo los pasos que se indican en Configuración en la consola de Google Cloud.
  2. Instala e inicializa gcloud CLI
  3. Ejecuta el siguiente comando gcloud en tu máquina local para crear tu archivo de credenciales:

    gcloud auth application-default login
  4. Se muestra 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, consulta la sección Entorno de desarrollo local de la documentación Proporciona credenciales para las credenciales predeterminadas de la aplicación.

Realiza una solicitud REST

En este ejemplo, pasas dos encabezados de solicitud:

  • Pasa el token de OAuth en el encabezado Authorization con el siguiente comando para generarlo:

    gcloud auth application-default print-access-token

    El token que se muestra tiene un alcance de https://www.googleapis.com/auth/cloud-platform..

  • Pasa el ID o el nombre de tu proyecto de Google Cloud que tiene habilitada la facturación en el encabezado X-Goog-User-Project. Para obtener más información, consulta Configuración en la consola de Cloud.

En el siguiente ejemplo, se realiza una llamada a la API de Places Insights con un token de OAuth:

curl -X POST 'https://areainsights.googleapis.com/v1:computeInsights' \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_NUMBER_OR_ID" \
-H "Authorization: Bearer $TOKEN" \
--data '{
   "insights":[
      "INSIGHT_COUNT"
   ],
   "filter":{
      "location_filter":{
         "region":{
            "place":"places/ChIJIQBpAG2ahYAR_6128GcTUEo"
         }
      },
      "type_filter":{
         "included_types":[
            "restaurant"
         ]
      },
      "price_levels":[
         "PRICE_LEVEL_INEXPENSIVE"
      ]
   }
}'

Solución de problemas

Si tu solicitud muestra un mensaje de error sobre la compatibilidad de las credenciales del usuario final con la API, consulta Las credenciales de usuario no funcionan.