Von V2 Alpha migrieren

Diese Seite richtet sich an Kunden, die derzeit die V2 Alpha-Version der Cloud Support API verwenden und zu V2 Beta migrieren möchten.

Erste Schritte mit V2 Beta

Wenn Sie bereits V2 Alpha verwenden, müssen Sie keine zusätzliche Einrichtung vornehmen, um V2 Beta zu verwenden. Sie können dieselben Dienstkonten/Anmeldedaten verwenden und die API ist bereits für Sie aktiviert.

Zum Aufrufen der V2 Beta-Endpunkte ersetzen Sie einfach /v2alpha/ der Anfrage-URL durch /v2beta/. So aktualisieren Sie beispielsweise einen cases.get-Aufruf von V2 Alpha auf V2 Beta:

V2 Alpha: GET https://cloudsupport.googleapis.com/v2alpha/projects/123/cases/abc

V2 Beta: GET https://cloudsupport.googleapis.com/v2beta/projects/123/cases/abc

Funktionsgefährdende Änderungen an Fallklassifizierungen

Wichtig: Dies ist die einzige funktionsgefährdende Änderung zwischen V2 Alpha und V2 Beta. Alle Endpunkte, die in diesem Abschnitt nicht erwähnt werden, können ohne Änderungen an der Geschäftslogik oder dem Anfrage-/Antwortformat sicher zu V2 Beta migriert werden.

Das einzige Verhalten, das sich von V2 Alpha zu V2 Beta geändert hat, ist der Typ der Fallklassifizierung.

V2-Alpha-Fallklassifizierung

Feld	Für die Fallerstellung erforderlich	Beschreibung
productType	Ja	string Der Produkttyp, dem die Klassifizierung entspricht.
value	Ja	string Die Klassifizierung, die beim Erstellen eines Falls verwendet werden soll, z. B. "Technisches Problem > Computing > Compute Engine"

V2 Beta-Fallklassifizierung

Feld	Für die Fallerstellung erforderlich	Beschreibung
id	Ja	string Die eindeutige ID für eine Klassifizierung. Muss für die Fallerstellung angegeben werden.
displayName	Nein	string Der angezeigte Name der Klassifizierung.

Warum haben wir diese Änderungen vorgenommen?

• productType-Feld entfernen

  • In einem frühen Design der API mussten wir dieses Feld hinzufügen, aber da die API weiterentwickelt wurde, wurde es unnötig.
  • Dieses Feld ist erforderlich, aber der einzige gültige Wert ist GOOGLE_CLOUD. Damit wird jeder Anfrage zur Fallerstellung ein Standardtext hinzugefügt.

• value in id und displayName trennen

  • Das value-Feld in V2 Alpha muss für Menschen lesbar sein, damit Menschen aus der Liste der Optionen auswählen können, und maschinenlesbar, damit unsere API erkennen kann, welcher Falltyp erstellt wird.
  • V2 Beta teilt dieses Problem in zwei Felder auf. id ist der maschinenlesbare Teil der Klassifizierung, displayName der für Menschen lesbare Teil.
  • So können wir den Anzeigenamen flexibel ändern, ohne API-Integrationen zu beeinträchtigen. Zum Beispiel möchten wir in Zukunft vielleicht mehrere Übersetzungen von displayName haben, aber id soll für alle Übersetzungen gleich bleiben, da sie dieselbe Klassifizierung von Fällen darstellen.