Configura la API de Time Zone

En este documento, se describen los pasos que debes seguir para comenzar a usar la API de zona horaria.

Requisitos previos

Este procedimiento te guiará para configurar una cuenta de Google Cloud y un proyecto de Google Cloud con la facturación habilitada. También debes conocer cómo se te cobra por usar la API de zona horaria.

  1. Revisa la facturación y el costo por uso en Uso y facturación de la API de zona horaria.
  2. Verifica que tengas una Cuenta de Google Cloud.

    Accede a la consola de Google Cloud
  3. Verifica que tengas un proyecto de Google Cloud con la facturación habilitada.

    Ir a la página Facturación
    1. Selecciona tu proyecto para abrir la página Facturación.
    2. En la página Facturación, haz lo siguiente:

      • Si la facturación ya está habilitada para el proyecto seleccionado y solo tienes una cuenta de facturación, se abrirá la página Facturación.
      • Si tienes varias cuentas de facturación, selecciona Ir a la cuenta de facturación vinculada para ver los detalles de la cuenta de facturación asociada con el proyecto.
      • Si existe una cuenta de facturación, pero no está asociada al proyecto, se te solicitará que vincules una cuenta de facturación con el proyecto.
      • Si no existe una cuenta de facturación o quieres crear una nueva, selecciona Administrar cuentas de facturación para crear una nueva. Para obtener más información, consulta Crea una nueva cuenta de Facturación de Cloud de servicio automático.

Habilita la API

Antes de poder usar la API de Time Zone, debes usar la consola de Google Cloud o el comando gcloud para habilitarla en tu proyecto de Google Cloud.

Para habilitar la API, sigue estos pasos:

Console

  1. Abre la página del producto en la consola de Google Cloud:

    Habilita la API de zona horaria
  2. Haz clic en el botón Habilitar.

gcloud

gcloud services enable \
    --project "PROJECT" \
    "timezone-backend.googleapis.com"

Obtén más información sobre el SDK de Google Cloud, la instalación del SDK de Cloud y los siguientes comandos:

Obtén una clave de API para usarla con la API de zona horaria

Los productos de Google Maps Platform están protegidos contra un uso no autorizado porque requieren que las llamadas a la API incluyan una clave de API.

Una clave de API es una cadena alfanumérica única que asocia tu cuenta de Facturación de Cloud y tu proyecto de Google Cloud con la solicitud que tu aplicación realiza a una API o un SDK de Google Maps Platform. Para crear una clave nueva o agregar una API o un SDK a una clave existente, sigue estas instrucciones.

Console

  1. Ve a la página Google Maps Platform > Claves y credenciales.

    Ir a la página Claves y credenciales

  2. Si se solicita, selecciona tu proyecto.
  3. Realiza una de las siguientes acciones:

    • Crea una clave nueva:

      1. Haz clic en Crear credenciales > Clave de API.
      2. En el panel Crear clave de API, abre la lista Elige las restricciones de API.
      3. Borra las APIs que no necesite esta clave y asegúrate de que la API de zona horaria permanezca seleccionada.
      4. Haz clic en Crear. En el panel, se mostrará tu nueva clave de API.
    • Usar una clave existente:

      1. Haz clic en el nombre de la clave.
      2. En la lista Seleccionar restricciones de API, selecciona API de zona horaria.
      3. Haz clic en Guardar.

    Seleccionar una API aquí no la habilita. Asegúrate de que la API de zona horaria esté habilitada en su página de la biblioteca de la API.

  4. Para ver la cadena de clave más adelante, ve a la página Claves y credenciales y haz clic en Mostrar clave para la clave.

Si la consola se ve diferente de estos pasos, consulta Crea una clave de API y Agrega restricciones de API en la documentación de Google Cloud.

gcloud

Reemplaza PROJECT_ID por el ID del proyecto en los siguientes comandos.

  • Crea una clave nueva: Ejecuta el siguiente comando y reemplaza DISPLAY_NAME por un nombre para la clave.

    gcloud services api-keys create \
        --project="PROJECT_ID" \
        --display-name="DISPLAY_NAME" \
        --api-target=service=timezone-backend.googleapis.com

    Obtén más información sobre el SDK de Google Cloud, la instalación del SDK de Cloud y los siguientes comandos:

  • Usa una clave existente: Ejecuta el siguiente comando y reemplaza KEY_ID por el ID de la clave. La marca --append conserva las APIs que la clave ya permite. Sin él, el comando las reemplaza.

    gcloud services api-keys update KEY_ID \
        --project="PROJECT_ID" \
        --append \
        --api-target=service=timezone-backend.googleapis.com

    Obtén más información sobre el SDK de Google Cloud, la instalación del SDK de Cloud y los siguientes comandos:

    El ID de clave no es la cadena de clave ni el nombre visible. Para encontrarlo, ejecuta gcloud services api-keys list --project="PROJECT_ID". El ID es la última parte del campo name: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

Para ver la cadena de la clave, ejecuta gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

Realiza una solicitud a la API

Realiza una solicitud a la API de Time Zone para que devuelva una respuesta JSON que contenga la información de la zona horaria de Nevada, EE.UU. La marca de tiempo se establece en el 5 de diciembre de 2024. Debes incluir la cadena alfanumérica de tu clave de API en cada solicitud y usar HTTPS para las solicitudes que incluyan la clave de API.

  1. Haz clic en API_KEY en el siguiente código para insertar la cadena alfanumérica de la clave:

    curl -L -X GET 'https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810%2C-119.6822510&timestamp=1733428634&key=YOUR_API_KEY'
    
  2. Haz clic en el ícono de copia en la muestra de código, Selecciona el ícono de copiar., para copiar el comando curl.
  3. Pega el comando en una ventana de terminal y ejecútalo.

La respuesta es un objeto JSON con el siguiente formato:

{
   "dstOffset" : 0,
   "rawOffset" : -28800,
   "status" : "OK",
   "timeZoneId" : "America/Los_Angeles",
   "timeZoneName" : "Pacific Standard Time"
}

Aplica restricciones de claves de API

Google recomienda que restrinjas las claves de API limitando su uso solo a las APIs y las apps que las necesitan. La restricción de las claves de API agrega seguridad a tu aplicación, ya que la protege de solicitudes no autorizadas. Las claves de API admiten dos tipos de restricciones:

  • Las restricciones de API especifican a qué SDKs y APIs se puede llamar con la clave de API. La consola y gcloud CLI requieren al menos una restricción de API cuando creas una clave.
  • Las restricciones de aplicaciones especifican qué sitios web, direcciones IP o apps pueden usar una clave de API.

Para obtener más información sobre cómo aplicar restricciones, consulta Restringe tus claves de API.

¿Qué sigue?

Ahora que habilitaste la API de zona horaria y realizaste una solicitud correctamente, consulta Solicitudes y respuestas de zona horaria para obtener más información sobre cómo usar la API.