Versionsverwaltung

Einige Google Unternehmensprofil-APIs sind in mehreren Versionen und Release-Versionen verfügbar. Die Version ist das Segment der Anfrage-URL, das auf den Hostnamen folgt, z. B. v1 oder v1alpha. Auf dieser Seite wird erläutert, wie Versionen nummeriert werden, wie stabil die einzelnen Release-Versionen sind und wie die Alpha-Version aufgerufen wird.

Versionsnummerierung

Jede API-Version hat eine Hauptversionsnummer und ein optionales Kanal-Suffix:

  • Hauptversion (v1, v2, ...): Eine stabile, allgemein verfügbare Version. Eine Hauptversion erhält nur abwärtskompatible Änderungen, z. B. neue Methoden, neue Felder oder neue Enum-Werte. Änderungen, die nicht abwärtskompatibel sind, werden in einer neuen Hauptversion veröffentlicht.
  • Alpha-Version (v1alpha, v2alpha, ...): Eine Vorabveröffentlichung einer Hauptversion. Sie enthält alles, was in dieser Hauptversion enthalten ist, sowie Funktionen, die noch nicht allgemein verfügbar sind.

Release-Versionen

Kanal Stabilität Inhalt
Allgemeine Verfügbarkeit (v1) Stabil. Änderungen innerhalb einer Hauptversion sind abwärtskompatibel. Wenn eine Hauptversion eingestellt wird, bleibt sie nach der Einstellungsankündigung mindestens 12 Monate lang verfügbar. Einstellungs- und Deaktivierungsdaten werden auf der Seite Zeitplan für die Einstellung veröffentlicht. Allgemein verfügbare Funktionen.
Alpha (v1alpha) Vorabveröffentlichung ohne Stabilitätsverpflichtung und ohne definierte Lebensdauer. Alpha-Funktionen können mit einer Frist von mindestens 30 Tagen geändert oder eingestellt werden. Verwenden Sie Alphafunktionen nicht in Produktionsintegrationen. Alles in v1 sowie Funktionen, die noch nicht allgemein verfügbar sind.

Wie Funktionen zwischen Kanälen verschoben werden

Wenn ein Feature von v1alpha auf v1 umgestellt wird, bleibt es in v1alpha verfügbar.

Anleitungen und Referenzseiten für Funktionen, die nur in v1alpha verfügbar sind, sind als Alpha gekennzeichnet. Neue Alpha- und allgemein verfügbare Funktionen sowie Änderungen an oder Entfernungen von Alpha-Funktionen werden in den neuesten Updates und im Änderungsprotokoll für jede API angekündigt.

Alphakanal verwenden

Wenn Sie den Alpha-Kanal aufrufen möchten, ersetzen Sie in der Anfrage-URL v1 durch v1alpha. Beispiel:

GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}?readMask={readMask}

Beide Kanäle gehören zur selben API und haben daher Folgendes gemeinsam:

  • API-Aktivierung in der Google Cloud Console.
  • OAuth 2.0-Bereiche und Zugriffsanforderungen.
  • Ressourcennamen, z. B. locations/{locationId}.
  • Kontingent. Anfragen an v1 und v1alpha werden auf dasselbe projektbezogene Kontingent angerechnet. Weitere Informationen finden Sie unter Kontingentlimits.
  • Die zugrunde liegenden Geschäftsdaten. Änderungen, die Sie über v1alpha vornehmen, sind über v1 sichtbar und umgekehrt.

Clientbibliotheken und das öffentliche API-Verzeichnis enthalten nur v1. Wenn Sie v1alpha aufrufen möchten, senden Sie REST-Anfragen direkt.

Best Practices

  • Verwenden Sie für Produktionsintegrationen die stabile Version, z. B. v1.
  • Verwenden Sie den Alphakanal, z. B. v1alpha, um neue Funktionen zu übernehmen, bevor sie allgemein verfügbar sind. Informationen zum Geben von Feedback finden Sie unter Support.
  • Sorgen Sie dafür, dass Ihr Client Felder und Enum-Werte toleriert, die er nicht erkennt.
  • Bevor Sie eine Alphafunktion verwenden, sollten Sie sich im Leitfaden und im Änderungsprotokoll über bekannte Einschränkungen informieren.