Gestion des versions

Gestion sémantique des versions

L'API Google Ads suit la gestion sémantique des versions en cas de version majeure et mineure. Le format de la version est MAJOR.MINOR ou vMAJOR_MINOR. Par exemple, v17_0 est une version majeure, tandis que v17_1 est une version mineure.

Consultez les notes de version pour les versions précédentes.

Versions majeures

Les versions majeures introduisent des modifications destructives et incompatibles avec les versions antérieures. La version se termine par zéro au format vX_0, où X correspond au numéro de version majeure.

Chaque version majeure possède un point de terminaison distinct. Dans cet exemple d'URL, X correspond au numéro de version majeure.

https://googleads.googleapis.com/vX

Si vous effectuez une mise à niveau à partir d'une ancienne version majeure, votre code peut nécessiter des modifications lorsque vous passez au point de terminaison de la nouvelle version majeure. Si vous utilisez nos bibliothèques clientes, effectuez une mise à niveau vers la version la plus récente. Lorsqu'une version majeure est publiée, nous vous fournissons un guide de migration que vous devez parcourir pour corriger toute modification destructive de votre code.

Voici quelques exemples de modifications destructives:

  • Supprimer ou renommer un service, une interface, un champ, une méthode ou une valeur d'énumération
  • Modifier le type d'un champ.
  • Modifier le format d'un nom de ressource
  • Modifier le format d'URL dans la définition HTTP.
  • Modification des formats de sortie, comme le passage de 0 à -- comme valeur par défaut.
  • Modification du motif de l'erreur renvoyé de A à B.

Versions mineures

Les versions mineures n'introduisent que des modifications rétrocompatibles. Pour une version mineure, vMAJOR_MINOR aurait un nombre MINOR supérieur à zéro.

Lorsqu'une version mineure est publiée, le point de terminaison déjà utilisé est automatiquement mis à jour. Cela n'entraînera pas l'interruption de votre code. Vous pouvez continuer à utiliser vos bibliothèques clientes existantes.

Les versions mineures incluent les nouvelles fonctionnalités ou les mises à jour qui n'affectent pas votre code existant. Si vous souhaitez utiliser ces nouvelles fonctionnalités, mettez à niveau vos bibliothèques clientes vers la version la plus récente.

Couchers de soleil

Les anciennes versions de l'API Google Ads doivent régulièrement être abandonnées. Lorsqu'une version est sur le point d'être abandonnée, nous en informerons sur le blog des développeurs. Le calendrier d'abandon est mis à jour avec les prochaines dates d'abandon.