Versionsverwaltung in der Search Ads 360 Reporting API

Die Search Ads 360 Reporting API verwendet die semantische Versionsverwaltung.

Es gibt Haupt- und Nebenversionen im Format vMAJOR_MINOR. v0_0 ist beispielsweise die erste Hauptversion und v0_1 die erste Nebenversion. Das Suffix der Versionsnummer gibt den Versionstyp an: Bei Hauptversionen ist er immer null und bei Nebenversionen immer größer als null.

Hauptversionen

Hauptversionen enthalten funktionsgefährdende Änderungen, d. h. Änderungen, die nicht abwärtskompatibel sind.

Jede Hauptversion hat einen separaten Endpunkt. Beispiel:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

Wenn Sie ein Upgrade von einer Hauptversion auf eine andere durchführen, müssen Sie möglicherweise Ihren Code ändern, bevor Sie zum neuen Hauptversionsendpunkt wechseln.

Wenn Sie eine Clientbibliothek verwenden, müssen Sie ein Upgrade auf die neueste Version durchführen. Neue Hauptversionen bieten eine Migrationsanleitung, mit der Sie funktionsgefährdende Änderungen in Ihrem Code beheben können.

Beispiele für funktionsgefährdende Änderungen:

  • Dienst, Schnittstelle, Feld, Methode oder ENUM-Wert entfernen oder umbenennen
  • Feldtyp ändern
  • Ändern des Formats eines Ressourcennamens.
  • Ändern des URL-Formats in der HTTP-Definition.
  • Ausgabeformate ändern, z. B. 0 in -- als Standardwert ändern
  • Ändern der zurückgegebenen Fehlerursache von A in B

Nebenversionen

Nebenversionen führen nur abwärtskompatible Änderungen ein.

Bei der Veröffentlichung einer Nebenversion wird der bereits verwendete Endpunkt automatisch aktualisiert. Dies führt nicht dazu, dass Ihr Code beschädigt wird. Sie können weiterhin Ihre vorhandene Clientbibliothek verwenden.

Nebenversionen enthalten neue Funktionen oder Updates, die sich nicht auf Ihren vorhandenen Code auswirken. Wenn Sie die neuen Features verwenden möchten, müssen Sie Ihre Clientbibliothek auf die neueste Version aktualisieren.

Sonnenuntergänge

Sobald eine ältere Search Ads 360 Reporting API-Version eingestellt wird, veröffentlichen wir einen entsprechenden Hinweis in der Google-Gruppe searchads-api-announcements.