Gestion des versions

Gestion sémantique des versions

L'API Google Ads suit la gestion sémantique des versions avec un numéro de version majeure et un numéro de version mineure. Les versions sont écrites sous la forme MAJOR.MINOR ou vMAJOR.MINOR. Par exemple, v25.0 (ou v25) est une version majeure, tandis que v25.1 est une version mineure.

Consultez les notes de version pour en savoir plus sur les versions actuelles et précédentes.

Versions majeures

Les versions majeures introduisent des modifications incompatibles avec les versions antérieures. La version initiale d'une version majeure se termine par zéro (vX.0 ou vX, où X est le numéro de version majeure).

Chaque version majeure possède un chemin de point de terminaison REST et gRPC distinct (vX), qui n'inclut pas le suffixe de la version mineure. Dans l'URL suivante, X correspond au numéro de version majeur (par exemple, v25) :

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 nouvel point de terminaison de version majeure. Si vous utilisez nos bibliothèques clientes, passez à la version de la bibliothèque cliente compatible avec la nouvelle version majeure. Lorsqu'une version majeure est publiée, nous fournissons un guide de mise à niveau pour vous aider à résoudre les problèmes de compatibilité dans 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 du nom d'une ressource.
  • Modification du format de l'URL dans la définition HTTP.
  • Modifier les formats de sortie, par exemple en modifiant les valeurs par défaut.
  • Modification de la raison de l'erreur renvoyée de A à B.

Versions mineures

Les versions mineures n'introduisent que des modifications rétrocompatibles. Pour une version mineure, vMAJOR.MINOR a un nombre MINOR supérieur à zéro (par exemple, v25.1).

Lorsqu'une version mineure est publiée, le point de terminaison de la version majeure existante (https://googleads.googleapis.com/vX) est automatiquement mis à jour sur place. Vous n'avez pas besoin de modifier le chemin de version dans les URL de vos points de terminaison, et le code existant continue de fonctionner sans problème.

Les versions mineures ajoutent des fonctionnalités ou des mises à jour qui n'affectent pas votre code existant. Pour utiliser des champs ou des fonctionnalités d'une version mineure avec une bibliothèque cliente, mettez à niveau votre bibliothèque cliente vers une version qui inclut les définitions de la version mineure.

Abandon et arrêt de fonctionnalités

Périodiquement, les anciennes versions de l'API Google Ads sont abandonnées, puis supprimées :

  • Obsolète : lorsqu'une version majeure (telle que v25) est publiée, toutes les versions majeures antérieures sont marquées comme obsolètes. Les appels d'API vers les versions obsolètes continueront de fonctionner jusqu'à leur date d'arrêt, et les versions existantes des bibliothèques clientes continueront de les prendre en charge. Toutefois, les versions ultérieures des bibliothèques clientes omettront les versions d'API obsolètes afin de réduire la taille des packages.
  • Arrêt : une version est désactivée à sa date d'arrêt, et tous les appels d'API à son point de terminaison échouent.

Nous publions des annonces sur le blog des développeurs avant l'arrêt des versions. Consultez le calendrier d'abandon et d'arrêt pour connaître les dates d'arrêt actives, abandonnées et prévues.