このページは、現在 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のみです。これにより、すべてのケース作成リクエストにボイラープレートが追加されます。
valueのidとdisplayNameへの分離- V2 アルファ版の
valueフィールドは、（人間がオプションのリストから選択できるように）人間が判読でき、かつ（作成されたケースのタイプが API にわかるように）機械が読める必要があります。 - V2 ベータ版では、これらの課題を 2 つのフィールドに分離しています。
idは分類の機械が読める部分で、displayNameは人間が読める部分です。 - これにより、API の統合を損なうことなく、表示名を柔軟に変更できます。たとえば、
displayNameの複数の翻訳を将来的に追加したいとします。しかし、idは同じケース分類を表すため、すべての翻訳で同じになります。
- V2 アルファ版の