Semantische Versionierung
Die Google Ads API folgt der semantischen Versionsverwaltung mit einer Haupt- und einer Nebenversionsnummer. Versionen werden als MAJOR.MINOR oder vMAJOR.MINOR geschrieben.
v25.0 (oder v25) ist beispielsweise eine Hauptversion, während v25.1 eine Nebenversion ist.
Weitere Informationen zu aktuellen und früheren Versionen finden Sie in den Versionshinweisen.
Hauptversionen
Hauptversionen enthalten funktionsgefährdende, nicht abwärtskompatible Änderungen. Die erste Version einer Hauptversion endet mit 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. v25):
https://googleads.googleapis.com/vX
Wenn Sie ein Upgrade von einer älteren Hauptversion durchführen, muss Ihr Code möglicherweise geändert werden, wenn Sie zum Endpunkt der neuen Hauptversion wechseln. Wenn Sie unsere Clientbibliotheken verwenden, führen Sie ein Upgrade auf die Clientbibliothek durch, die die neue Hauptversion unterstützt. Wenn eine Hauptversion veröffentlicht wird, stellen wir einen Upgrade-Leitfaden zur Verfügung, der Ihnen hilft, alle nicht abwärtskompatiblen Änderungen in Ihrem Code zu beheben.
Beispiele für Breaking Changes:
- Entfernen oder Umbenennen eines Dienstes, einer Schnittstelle, eines Felds, einer Methode oder eines Enum-Werts.
- Ändern des Typs eines Felds.
- Ändern des Formats eines Ressourcennamens.
- Ändern des URL-Formats in der HTTP-Definition.
- Ausgabeformate ändern, z. B. Standardwerte.
- Der von A zurückgegebene Fehlergrund wird in B geändert.
Nebenversionen
In Nebenversionen werden nur abwärtskompatible Änderungen eingeführt. Bei einer Nebenversion hat vMAJOR.MINOR eine MINOR-Nummer größer als null (z. B. v25.1).
Wenn eine Nebenversion veröffentlicht wird, wird der vorhandene Hauptversionsendpunkt (https://googleads.googleapis.com/vX) automatisch aktualisiert. Sie müssen den Versionspfad in Ihren Endpunkt-URLs nicht ändern und vorhandener Code funktioniert weiterhin.
Bei 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 eine Version, die die Definitionen der Nebenversion enthält.
Einstellung und Außerbetriebnahme
Ältere Google Ads API-Versionen werden regelmäßig eingestellt und später deaktiviert:
- Verworfen: Wenn eine Hauptversion (z. B.
v25) veröffentlicht wird, werden alle früheren Hauptversionen als verworfen markiert. API-Aufrufe an verworfene Versionen sind bis zum Sunset-Datum weiterhin erfolgreich und bestehende Clientbibliotheksversionen unterstützen sie weiterhin. In nachfolgenden Clientbibliotheksversionen werden verworfene API-Versionen jedoch ausgelassen, um die Paketgröße zu reduzieren. - Einstellung: Eine Version wird am Datum der Einstellung deaktiviert und alle API-Aufrufe an den zugehörigen Endpunkt schlagen fehl.
Wir veröffentlichen Ankündigungen im Entwicklerblog, bevor Versionen eingestellt werden. Im Zeitplan für die Einstellung finden Sie Informationen zu aktiven, eingestellten und geplanten Einstellungsdaten.