Semantische Versionierung
Die Google Ads API verwendet die semantische Versionsverwaltung mit einer Haupt- und einer Nebenversionsnummer. Versionen werden als MAJOR.MINOR oder vMAJOR.MINOR geschrieben.
v26.0 (oder v26) ist beispielsweise eine Hauptversion, während v26.1 eine Nebenversion ist.
Weitere Informationen zu aktuellen und früheren Versionen finden Sie in den Versionshinweisen.
Hauptversionen
Hauptversionen führen zu funktionsgefährdenden, nicht abwärtskompatiblen Änderungen. Die erste Version einer Hauptversion endet mit einer Null (vX.0 oder vX, wobei X die Hauptversionsnummer ist).
Jede Hauptversion hat einen separaten REST- und gRPC-Endpunktpfad (vX), der das Suffix der Nebenversion nicht enthält. In der folgenden URL ist X die Hauptversionsnummer (z. B. v26):
https://googleads.googleapis.com/vX
Wenn Sie ein Upgrade von einer älteren Hauptversion durchführen, müssen Sie möglicherweise Ihren Code ändern, wenn Sie zum neuen Hauptversionsendpunkt wechseln. Wenn Sie unsere Clientbibliotheken verwenden, führen Sie ein Upgrade auf die Clientbibliotheksversion durch, die die neue Hauptversion unterstützt. Wenn eine Hauptversion veröffentlicht wird, stellen wir einen Upgrade-Leitfaden zur Verfügung, mit dem Sie funktionsgefährdende Änderungen in Ihrem Code beheben können.
Beispiele für funktionsgefährdende Änderungen:
- Entfernen oder Umbenennen eines Dienstes, einer Schnittstelle, eines Felds, einer Methode oder eines Enum-Werts.
- Ändern des Typs eines Felds.
- Format eines Ressourcennamens ändern.
- Ändern des URL-Formats in der HTTP-Definition.
- Ausgabeformate ändern, z. B. Standardwerte ändern
- Ändern des zurückgegebenen Fehlergrunds von A zu B.
Nebenversionen
Nebenversionen führen nur abwärtskompatible Änderungen ein. Bei einer Nebenversion hat vMAJOR.MINOR eine MINOR-Nummer, die größer als null ist (z. B. v26.1).
Wenn eine Nebenversion veröffentlicht wird, wird der vorhandene Endpunkt der Hauptversion (https://googleads.googleapis.com/vX) automatisch aktualisiert. Alle API-Aufrufe an eine bestimmte Hauptversion werden immer an die neueste entsprechende Nebenversion weitergeleitet. Die Google Ads API unterstützt keine Aufrufe bestimmter Nebenversionen.
Sie müssen den Versionspfad in Ihren Endpunkt-URLs nicht ändern und vorhandener Code funktioniert weiterhin ohne Unterbrechung. Die Lebensdauer von Nebenversionen wird nicht separat erfasst. Stattdessen haben Nebenversionen dasselbe Einstellungsdatum wie die entsprechende Hauptversion.
In Nebenversionen werden Funktionen oder Updates hinzugefügt, die sich nicht auf Ihren vorhandenen Code auswirken. Wenn Sie Felder oder Funktionen aus einer Nebenversion mit einer Clientbibliothek verwenden möchten, aktualisieren Sie Ihre Clientbibliothek auf einen Release, der die Definitionen der Nebenversion enthält.
Einstellung und Außerbetriebnahme
In der Google Ads API sind jederzeit mehrere aktive Hauptversionen verfügbar. In regelmäßigen Abständen werden ältere Versionen eingestellt und später eingestellt:
- Eingestellt: Eine Version gilt nur dann als eingestellt, wenn sie explizit als eingestellt gekennzeichnet ist. API-Aufrufe an verworfene Versionen sind bis zum Datum der Einstellung weiterhin erfolgreich.
- Einstellung: Eine Version wird am Datum der Einstellung deaktiviert und alle API-Aufrufe an ihren Endpunkt schlagen fehl.
Wir veröffentlichen Ankündigungen im Entwicklerblog, bevor Versionen eingestellt werden. Im Zeitplan für die Einstellung und Deaktivierung finden Sie Informationen zu aktiven, eingestellten und geplanten Deaktivierungsdaten.