Gestion des versions dans l'API Search Ads 360 Reporting

L'API Search Ads 360 Reporting utilise la gestion sémantique des versions.

Il existe des versions majeures et mineures, au format vMAJOR_MINOR. Par exemple, v0_0 est la première version majeure et v0_1 est la première version mineure. Le suffixe du numéro de version indique le type de version: il est toujours égal à zéro pour les versions majeures et, pour les versions mineures, il est toujours supérieur à zéro.

Versions majeures

Les versions majeures introduisent des modifications destructives, c'est-à-dire des modifications qui ne sont pas rétrocompatibles.

Chaque version majeure possède un point de terminaison distinct, par exemple:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

Lors de la mise à niveau d'une version majeure vers une autre, vous devrez peut-être modifier votre code avant de passer au nouveau point de terminaison de la version majeure.

Si vous utilisez une bibliothèque cliente, vous devez passer à la dernière version. Les nouvelles versions majeures fournissent un guide de migration pour vous aider à corriger les modifications destructives dans votre code.

Voici quelques exemples de modifications destructives:

  • Suppression ou changement de nom d'un service, d'une interface, d'un champ, d'une méthode ou d'une valeur d'énumération.
  • Modifier le type d'un champ
  • Modification du format d'un nom de ressource.
  • Modification du format de l'URL dans la définition HTTP.
  • Modifier les formats de sortie, par exemple en remplaçant 0 par -- 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.

Lorsqu'une version mineure est publiée, le point de terminaison déjà utilisé est automatiquement mis à jour. Cela n'entraîne pas le dysfonctionnement de votre code. Vous pouvez continuer à utiliser votre bibliothèque cliente existante.

Les versions mineures incluent les nouvelles fonctionnalités ou mises à jour qui n'affectent pas votre code existant. Si vous souhaitez utiliser les nouvelles fonctionnalités, vous devez mettre à niveau votre bibliothèque cliente vers la dernière version.

Couchers de soleil

Lorsqu'une ancienne version de l'API Search Ads 360 Reporting est planifiée pour s'arrêter, nous publions une notification sur le groupe Google searchads-api-announcements.