V2 アルファ版からの移行

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

V2 ベータ版を使ってみる

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

V2 ベータ版のエンドポイントを呼び出すには、リクエスト URL の /v2alpha/ 部分を /v2beta/ にただ置き換えます。たとえば、cases.get の呼び出しを V2 アルファ版から V2 ベータ版にアップグレードする方法を以下に示します。

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

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

ケースの分類に対する重要な変更

V2 アルファ版から V2 ベータ版で変更された挙動は、ケース分類タイプのみです。

V2 アルファ版の CaseClassification

項目 ケース作成に必須 説明
productType string
分類が対応するプロダクト タイプ。
value string
ケースの作成時に使用される分類(例 : 「技術的な問題 > コンピューティング > Compute Engine」)

V2 ベータ版の CaseClassification

項目 ケース作成に必須 説明
id string
分類の一意の ID。ケースの作成の場合、指定する必要があります。
displayName × string
分類の表示名。

変更の理由

  • productType フィールドの削除

    • API の初期設計では、このフィールドを追加する必要がありましたが、API の進化に伴い、不要になりました。
    • このフィールドは必須ですが、有効な値は GOOGLE_CLOUD のみです。それにより、すべてのケース作成リクエストにボイラープレートが追加されます。
  • valueiddisplayName への分離

    • V2 アルファ版の value フィールドは、(人間がオプションのリストから選択できるように)人間が読める、かつ(作成されたケースのタイプが API にわかるように)機械が読める必要があります。
    • V2 ベータ版では、これらの課題を 2 つのフィールドに分離しています。id は分類の機械が読める部分で、displayName は人間が読める部分です。
    • これにより、API 統合を中断することなく、表示名を柔軟に変更できます。たとえば、将来、displayName の複数の翻訳が必要な場合がありますが、id は同じケースの分類を表すため、すべての翻訳に対して同じままになります。