Modification à venir dans la procédure d’abandon des versions de l’API Marketing afin de permettre la mise à niveau automatique des versions

16 avril 2024DeMengxuan Zhang

Pour améliorer l’expérience globale de l’API et rendre son utilisation plus simple et optimale, nous allons prochainement lancer la fonctionnalité de mise à niveau automatique des versions MAPI. À compter de mai 2024, nous allons activer la fonctionnalité de mise à niveau automatique des versions pour les points de terminaison de l’API Marketing qui ne sont pas affectés d’une version à l’autre. Cela signifie qu'entre une version prochainement obsolète et la version disponible suivante, si un point de terminaison n'est pas affecté, la plateforme mettra à jour l'appel vers la version disponible suivante, plutôt que de faire échouer directement la requête.

La gestion des versions d’une API est une pratique courante pour gérer les modifications apportées à cette dernière, en particulier pour distribuer les modifications majeures. Les anciennes versions sont abandonnées dès que de nouvelles sont disponibles. Durant l’abandon, si une application appelle une version d’API obsolète, le message d’erreur suivant s’affiche : « (#2635) You are calling a deprecated version of the Ads API. Please update to the latest version: vXXX » (Vous appelez une version obsolète de l’API Ads. Veuillez passer à la version la plus récente : vXXX).

La version 17.0 sera abandonnée le 14 mai 2024. Selon le changelog de la version 18.0, les points de terminaison affectés sont les suivants :

POST /act_{ad-account-id}/reachfrequencypredictions
GET /act_{ad-account-id}/reachestimate
GET /act_{ad-account-id}/delivery_estimate
POST /act_{ad-account-id}/adsets
POST /{adset-id}
POST /act_{ad-account-id}/saved_audiences
POST /{saved-audience-id}
POST /act_{ad-account-id}/credit_cards

Si votre application appelle le point de terminaison POST /{adset-id} avec la version 17.0 après son abandon le 14 mai 2024, la requête d’API échouera, car la mise à niveau automatique n’est pas appliquée à ces points de terminaison affectés par la version 18.0.

Si votre application appelle le point de terminaison GET /{ad-account-id}/insights avec la version 17.0 après son abandon, la plateforme mettra à niveau votre appel vers la version 18.0.

Si votre application émet déjà des requêtes avec des versions ultérieures à la version 17.0, elle ne sera pas impactée à la date d’abandon de la version.

Pour refuser la mise à niveau automatique de la version, accédez à Settings > Ads API Version Settings (Paramètres > Paramètres de version de l’API Ads) sous la carte du produit API Marketing pour désactiver la fonctionnalité.

Pour savoir si la mise à niveau automatique a été appliquée à un appel, vérifiez l’en-tête de réponse de l’API.

Exemple d’en-tête de notification : « ‘X-Ad-Api-Version-Warning:‘ The call has been auto-upgraded to v17.0 as v16.0 has been deprecated » (X-Ad-Api-Version-Warning : L’appel a été mis à niveau vers la version 17.0, car la version 16.0 a été abandonnée.)

Pour plus d’informations, consultez Gestion des versions de l’API Marketing.

Pour vérifier les points de terminaison affectés à chaque version, consultez le Changelog.

Points de terminaison concernés