Von V2 Beta migrieren

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

Erste Schritte mit V2

Wenn Sie bereits V2 Beta verwenden, müssen Sie keine weiteren Schritte zur Einrichtung ausführen, um V2 nutzen zu können. Sie können dieselben Dienstkonten und Anmeldedaten verwenden. Die API wird für Sie bereits aktiviert.

Zum Aufrufen der V2-Endpunkte ersetzen Sie einfach den Teil /v2beta/ der Anfrage-URL durch /v2/. So führen Sie beispielsweise ein Upgrade eines cases.get-Aufrufs von V2 Beta auf V2 aus:

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

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

Funktionsgefährdende Änderungen an SearchCases, Case.severity und Comment.plainTextBody

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

SearchCases Endpunktänderungen

Der Endpunkt SearchCases hat sich 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

• Der Parameter filter akzeptiert keinen project- oder organization-Filter mehr. Stattdessen wird das Projekt/die Organisation aus der URL als Suchbereich verwendet.

Feldänderungen

Die Felder wurden folgendermaßen geändert:

• Das Feld severity für Fälle wurde zugunsten des Felds priority entfernt.

• Das Feld plainTextBody bei Fallkommentaren wurde zugunsten des Felds body entfernt.

Warum haben wir diese Änderungen vorgenommen?

• Pfad SearchCases ändern

  • Die alte Methode zum Definieren des Suchbereichs war verwirrend und entspricht nicht den Designpraktiken der Google Cloud Platform API.
  • Die neue Methode macht SearchCases einheitlicher als andere Endpunkte in der API, z. B. ListCases.

• Case.severity-Feld entfernen

  • Der Schweregrad hat denselben Zweck wie die Priorität. Daher wird die API entfernt, wenn Sie ihn entfernen.

• Comment.plainTextBody-Feld entfernen

  • Comment.body enthält immer nur Nur-Text. Es ist also ein Duplikat dieses Feldes. Daher entfernen wir plainTextBody, um die API zu vereinfachen.

Änderungen berücksichtigen

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

• Verwenden Sie das Feld priority an den Stellen, an denen Sie bisher das Feld severity verwendet haben. Da sie sehr semantisch ähnlich sind, können Sie diese Referenzen in der Regel austauschen.

• Verwenden Sie das Feld body anstelle des Felds plainTextBody. Sie enthielten dieselben Informationen. Daher sollten alle Verweise auf plainTextBody durch body ersetzt werden.