V2 ベータ版からの移行

このページは、現在 Cloud Support API の V2 ベータ版を使用していて、V2 に移行するお客様を対象としています。

V2 を使ってみる

すでに V2 ベータ版を使用している場合は、V2 の使用を開始するために、追加のセットアップは必要ありません。同じサービス アカウントと認証情報を使用できます。API はすでに有効になっています。

V2 エンドポイントを呼び出すには、リクエスト URL の /v2beta/ 部分を /v2/ に置き換えます。たとえば、cases.get 呼び出しを V2 ベータ版から V2 にアップグレードするには、次のように指定します。

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

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

SearchCases、Case.severity、Comment.plainTextBody への互換性を破る変更

SearchCases エンドポイントの変更

SearchCases エンドポイントは次のように変更されました。

  • 元のパスは次のとおりです。

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

    これを、次のように変更します。

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

  • filter パラメータは、project または organization のフィルタを受け入れなくなりました。代わりに、URL からのプロジェクトまたは組織が検索のスコープとして使用されます。

フィールドの変更

このフィールドは次のように変更されています。

  • ケース の severity フィールドが削除され、priority フィールドに置き換えられました。

  • ケースのコメントの plainTextBody フィールドが削除され、body フィールドに置き換えられました。

今回の変更の理由

  • SearchCases パスの変更

    • 検索範囲を定義する従来の方法はわかりにくいため、標準の Google Cloud Platform API 設計手法に沿っていません。
    • 新しい方法により、SearchCases の API の他のエンドポイント（ListCases など）との整合性が高まります。

  • Case.severity フィールドの削除

    • 重大度は優先度と同じ目的を果たすため、削除することで API が簡素化されます。

  • Comment.plainTextBody フィールドの削除

    • Comment.body にはプレーン テキストしか含まれておらず、このフィールドと重複しているため、API を簡略化するために plainTextBody を削除します。

変化に適応させる方法

  • SearchCase リクエストから project フィルタと organization フィルタを削除し、代わりにリクエスト URL で宣言します。

  • severity フィールドを使用していた場所で priority フィールドを使用します。セマンティックな意味で非常によく似ているため、通常はこれらの参照を入れ替えることができます。

  • plainTextBody フィールドの代わりに body フィールドを使用します。同じ情報が含まれていました。つまり、plainTextBody へのすべての参照を body に置き換えても問題はありません。