Control de versiones

Algunas APIs de Perfil de Negocio están disponibles en más de una versión y canal de lanzamiento. La versión es el segmento de la URL de solicitud que sigue al nombre de host, como v1 o v1alpha. En esta página, se explica cómo se numeran las versiones, qué tan estable es cada canal de versiones y cómo llamar al canal alfa.

Numeración de versiones

Cada versión de la API tiene un número de versión principal y un sufijo de canal opcional:

  • Versión principal (v1, v2, etcétera): Es una versión estable y con disponibilidad general. Una versión principal solo recibe cambios retrocompatibles, como métodos, campos o valores de enumeración nuevos. Los cambios que no son retrocompatibles se lanzan en una nueva versión principal.
  • Canal alfa (v1alpha, v2alpha, etcétera): Es un canal de versiones previo al lanzamiento de una versión principal. Incluye todo lo que se incluye en esa versión principal, además de las funciones que aún no están disponibles de forma general.

Canales de versiones

Canal Estabilidad Contenido
Disponibilidad general (v1) Estable. Los cambios dentro de una versión principal son retrocompatibles. Cuando una versión principal queda obsoleta, permanece disponible durante al menos 12 meses después del anuncio de baja. Las bajas y las fechas de descontinuación se publican en la página Programa de bajas. Funciones de disponibilidad general
Alfa (v1alpha) Versión preliminar, sin compromiso de estabilidad ni vida útil definida. Las funciones alfa pueden cambiar o descontinuarse con un aviso de, al menos, 30 días. No uses funciones alfa en integraciones de producción. Todo lo que se incluye en v1, además de las funciones que aún no están disponibles de forma general.

Cómo se mueven las funciones entre los canales

Cuando una función pasa de v1alpha a v1, sigue estando disponible en v1alpha.

Las guías y las páginas de referencia de las funciones que solo están disponibles en v1alpha se marcan como alfa. Las nuevas funciones alfa y de disponibilidad general, y los cambios o las eliminaciones de las funciones alfa, se anuncian en Actualizaciones más recientes y en el registro de cambios de cada API.

Usa el canal alfa

Para llamar al canal alfa, reemplaza v1 por v1alpha en la URL de la solicitud. Por ejemplo:

GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}?readMask={readMask}

Ambos canales pertenecen a la misma API, por lo que comparten lo siguiente:

  • Habilitación de la API en la consola de Google Cloud
  • Permisos de OAuth 2.0 y requisitos de acceso.
  • Nombres de recursos, como locations/{locationId}.
  • Cuota. Las solicitudes a v1 y v1alpha se descuentan de la misma cuota por proyecto. Para obtener más detalles, consulta Límites de cuota.
  • Los datos empresariales subyacentes. Los cambios que realices con v1alpha son visibles con v1 y viceversa.

Las bibliotecas cliente y el directorio de APIs públicas solo incluyen v1. Para llamar a v1alpha, envía solicitudes de REST directamente.

Prácticas recomendadas

  • Usa la versión estable, como v1, para las integraciones de producción.
  • Usa el canal alfa, como v1alpha, para adoptar funciones nuevas antes de que alcancen la disponibilidad general. Para compartir comentarios, consulta Asistencia.
  • Haz que tu cliente tolere los campos y los valores de enumeración que no reconoce.
  • Antes de compilar con una función alfa, consulta su guía y el registro de cambios para conocer las limitaciones conocidas.