Control de versiones en la API de informes de Search Ads 360

La API de Search Ads 360 Reporting usa el control de versiones semántico.

Hay versiones principales y secundarias, con el formato vMAJOR_MINOR. Por ejemplo, v0_0 es la primera versión principal y v0_1 es la primera versión secundaria. El sufijo del número de versión indica el tipo de versión: para las versiones principales, siempre es cero, y para las versiones secundarias, siempre es mayor que cero.

Versiones principales

Las versiones principales introducen cambios rotundos, es decir, cambios que no son compatibles con versiones anteriores.

Cada versión principal tiene un extremo separado, por ejemplo:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

Cuando actualices de una versión principal a otra, es posible que debas cambiar tu código antes de cambiar al nuevo extremo de la versión principal.

Si usas una biblioteca cliente, debes actualizarla a la versión más reciente. Las nuevas versiones principales proporcionan una guía de migración para ayudarte a corregir los cambios rotundos en tu código.

Estos son algunos ejemplos de cambios rotundos:

  • Quitar o cambiar el nombre de un servicio, una interfaz, un campo, un método o un valor de enumeración
  • Cambiar el tipo de un campo
  • Cambiar un formato de nombre de recurso
  • Cambiar el formato de URL en la definición HTTP
  • Cambiar los formatos de salida, por ejemplo, cambiar 0 a -- como valor predeterminado
  • Cambiar el motivo del error que se muestra de A a B

Versiones secundarias

Las versiones secundarias solo introducen cambios retrocompatibles.

Cuando se lanza una versión secundaria, el extremo que ya está en uso se actualiza de forma automática. Esto no hará que se rompa el código. Puedes seguir usando tu biblioteca cliente existente.

Las versiones secundarias incluyen funciones nuevas o actualizaciones que no afectan el código existente. Si deseas usar las funciones nuevas, debes actualizar tu biblioteca cliente a la versión más reciente.

Puestas de sol

Cuando se programe la baja de una versión anterior de la API de Search Ads 360 Reporting, publicaremos un aviso en el grupo de Google searchads-api-announcements.