Bevorstehende Änderung in Marketing API – Versionsveraltung zur Aktivierung des automatischen Versionsupgrades
Wir möchten das API-Nutzungserlebnis insgesamt verbessern, indem wir es reibungsloser und effizienter gestalten. Hierzu freuen wir uns, die bevorstehende Einführung der MAPI-Funktion zum automatischen Versionsupgrade anzukündigen. Ab Mai 2024 wird die Funktion zum automatischen Versionsupgrade für Marketing API-Endpunkte aktiviert, die zwischen Versionen nicht betroffen sind. Dies bedeutet Folgendes: Wenn ein Endpunkt zwischen einer Version, die als veraltet markiert werden soll, und der nächsten verfügbaren Version nicht betroffen ist, führt die Plattform automatisch ein Upgrade des Aufrufs auf die nächste verfügbare Version durch, anstatt die Anfrage direkt fehlschlagen zu lassen.
Die Versionierung einer API ist eine gängige Methode zur Handhabung von Änderungen an der API. Am häufigsten wird sie zur Bereitstellung wichtiger Änderungen verwendet. Wenn neue Versionen veröffentlicht werden, werden ältere Versionen als veraltet markiert. Wenn eine App während der API-Veraltung eine veraltete API-Version aufruft, wird der Fehler #2635 ausgegeben, der besagt, dass du eine veraltete Version der Ads API aufrufst. Du wirst gebeten, auf die neueste Version zu aktualisieren: vXXX.
Ab dem 14. Mai 2024 ist Version v17.0 veraltet. Gemäß dem Änderungsprotokoll von v18.0 sind die folgenden Endpunkte hiervon betroffen:
- 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
Wenn deine App POST /{adset-id} mit v17.0 aufruft, nachdem diese Version am 14. Mai 2024 als veraltet markiert wurde, schlägt diese API-Anfrage fehl, da das automatische Upgrade nicht auf Endpunkte angewendet wird, die von der nächsten verfügbaren Version (v18.0) betroffen sind.
Wenn deine App GET /{ad-account-id}/insights mit v17.0 nach der Veraltung aufruft, führt die Plattform ein Upgrade deines Aufrufs auf die nächste verfügbar Version (v18.0) durch.
Wenn deine App bereits Aufrufe mit höheren Versionen als v17.0 tätigt, ändert sich am Datum der Versionsveraltung nichts.
Um das automatische Versionsupgrade zu deaktivieren, wechsle auf der Karte des Marketing API-App-Produkts zu „Einstellungen“ > „Einstellungen für die Ads-API-Version“.
Um zu verifizieren, ob für einen Aufruf ein automatisches Upgrade durchgeführt wurde, sieh dir den Header der API-Antwort an – dort findest du weitere Details.
- Beispiel eines Benachrichtigungs-Headers: „X-Ad-Api-Version-Warning: The call has been auto-upgraded to v17.0 as v16.0 has been deprecated“
Mehr Informationen über dieses Verhalten findest du unter Marketing API – Versionierung.
Welche Endpunkte in den einzelnen Versionen betroffen sind, kannst du dem Änderungsprotokoll entnehmen.
Betroffene Endpunkte
- Alle MAPI-Endpunkte
Link zur Entwicklungsdokumentation
Link zum Hilfeartikel zur Funktion
