Von V2 Beta migrieren

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

Erste Schritte mit V2

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

Ersetzen Sie zum Aufrufen der V2-Endpunkte einfach den Teil /v2beta/ der Anfrage-URL durch /v2/. So würden Sie beispielsweise einen cases.get-Aufruf von V2 Beta auf V2 upgraden:

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

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

Wichtige Änderungen an SearchCases, Case.severity und Comment.plainTextBody

Wichtig: Dies sind die einzigen funktionsgefährdenden Änderungen zwischen V2 Beta und V2. Alle Felder/Endpunkte, die in diesem Abschnitt nicht erwähnt werden, sind identisch. Wenn Sie derzeit nicht den Endpunkt SearchCases, das Feld Case.severity oder das Feld Comment.plainTextBody verwenden, können Sie sicher zu V2 migrieren, ohne Änderungen an der Geschäftslogik oder am Anfrage-Antwort-Format vorzunehmen.

SearchCases Endpunktänderungen

Der Endpunkt SearchCases wurde so geändert:

• Der Pfad hat sich geändert von:

  GET https://cloudsupport.googleapis.com/v2/cases:search

  to:

  GET https://cloudsupport.googleapis.com/v2beta/{parent=*/*}/cases:search

• Für den filter-Parameter ist kein project- oder organization-Filter mehr zulässig. Stattdessen wird das Projekt/die Organisation aus der URL als Suchbereich verwendet.

Feldänderungen

Die Felder wurden so geändert:

• Das Feld „severity“ wurde für Fälle entfernt und stattdessen das Feld „priority“ verwendet.

• Das Feld plainTextBody für Fallkommentare wurde zugunsten des Felds body entfernt.

Warum haben wir diese Änderungen vorgenommen?

• SearchCases-Pfad ändern

  • Die bisherige Definition des Suchbereichs war verwirrend und entsprach nicht den standardmäßigen API-Designpraktiken der Google Cloud Platform.
  • Die neue Methode macht SearchCases konsistenter mit anderen Endpunkten in der API, z. B. ListCases.

• Case.severity-Feld entfernen

  • Der Schweregrad dient demselben Zweck wie die Priorität. Daher wird die API vereinfacht.

• Comment.plainTextBody-Feld entfernen

  • Comment.body enthält immer nur Text, daher ist es ein Duplikat dieses Felds. Daher entfernen wir plainTextBody, um die API zu vereinfachen.

An die Änderungen anpassen

• Entfernen Sie die Filter project und organization aus SearchCase-Anfragen und deklarieren Sie sie stattdessen in der Anfrage-URL.

• Verwenden Sie das Feld priority dort, wo Sie früher das Feld severity verwendet haben. Ihre semantische Bedeutung ist sehr ähnlich, sodass Sie diese Verweise in der Regel austauschen können.

• Verwenden Sie das Feld body anstelle des Felds plainTextBody. Sie enthielten dieselben Informationen. Daher sollte es gut sein, alle Verweise auf plainTextBody durch body zu ersetzen.