地域管理を移行する
このガイドでは、統合を Content API for Shopping の RegionsService から Accounts サブ API 内の RegionsService に移行する方法について説明します。
地域サービスを使用すると、地域別の価格設定や配送のオーバーライドなどのユースケースに合わせてカスタムの地理的エリアを定義できます。地域は、RegionalInventory や ShippingSettings などのサービスで使用できます。
主な違い
- API の構造: 地域サービスは、Merchant API の
Accountsサブ API の一部になりました（例:merchantapi.googleapis.com/accounts/v1/...）。 - リソース名: Merchant API では、Get、Update、Delete オペレーションの URL パスで個別の
merchant_idパラメータとregion_idパラメータを使用する代わりに、リソース名（accounts/{account}/regions/{region}）を使用します。 - AIP コンプライアンス: Merchant API メソッドは、標準の API Improvement
Proposal パターン（List/Create に
parent、Get/Delete にname、標準のupdate_maskの使用など）に準拠しています。 - ラッパー型: 以前 Content API で
google.protobuf.StringValueまたはgoogle.protobuf.BoolValueを使用していたフィールドは、Merchant API で標準のoptionalフィールドを使用するようになりました。 - 新機能:
- Merchant API では、
Regionリソース内にRadiusAreaタイプが導入され、ポイントを中心とした半径に基づいて地域を定義できるようになりました（最初はTRUST_TESTERの公開設定）。 - バッチメソッド（
BatchCreateRegions、BatchUpdateRegions、BatchDeleteRegions）を使用できます。
- Merchant API では、
- エラー処理: エラーコードとメッセージで、より具体的なフィードバックが提供されるようになりました。
リクエスト
リクエスト パターンは次のように変更されます。
| 項目 | Content API for Shopping | Merchant API | 説明 |
|---|---|---|---|
| エンドポイント | https://shoppingcontent.googleapis.com |
https://merchantapi.googleapis.com |
ベースドメインが変更されます。 |
| Get パス | /content/v2.1/{merchant_id}/regions/{region_id} |
/accounts/v1/{name=accounts/*/regions/*} |
Merchant API では、accounts サブ API とリソース name を使用します。 |
| リスト パス | /content/v2.1/{merchant_id}/regions |
/accounts/v1/{parent=accounts/*}/regions |
Merchant API では、parent を使用してアカウントを指定します。 |
| 作成パス | /content/v2.1/{merchant_id}/regions |
/accounts/v1/{parent=accounts/*}/regions |
Merchant API では parent を使用します。region_id はリクエストの本文のフィールドです。 |
| 更新パス | /content/v2.1/{merchant_id}/regions/{region_id} |
/accounts/v1/{name=accounts/*/regions/*} |
Merchant API のリソース名は、本文の region オブジェクトの一部です。 |
| 削除パス | /content/v2.1/{merchant_id}/regions/{region_id} |
/accounts/v1/{name=accounts/*/regions/*} |
リソース name を使用します。 |
識別子
識別子の使用方法を次のように変更します。
| 項目 | Content API for Shopping | Merchant API | 説明 |
|---|---|---|---|
| アカウント | merchant_id（整数） |
account（整数、name または parent 文字列の一部） |
リソース名文字列に埋め込まれているアカウント ID を見つけます（例: accounts/{account}）。 |
| リージョン | region_id（文字列） |
{region}（文字列、name 文字列の一部） |
リソース名文字列に埋め込まれている地域 ID を見つけます（例: accounts/{account}/regions/{region}）。 |
| リソース名 | リクエストには厳密には使用されません。 | name: accounts/{account}/regions/{region} |
Get/Update/Delete リクエストの標準識別子。 |
| 親名 | リクエストには厳密には使用されません。 | parent: accounts/{account} |
List/Create リクエストの標準識別子。 |
リソース
Region リソース構造には小さな変更があります。
| 項目 | Content API for Shopping | Merchant API | 説明 |
|---|---|---|---|
| リソース ID | region_id（文字列）、merchant_id（int64） |
name（文字列）: accounts/{account}/regions/{region} |
Merchant API では、単一の name フィールドをリソース ID として使用します。 |
display_name |
google.protobuf.StringValue |
optional string |
ラッパー型が削除されました。 |
radius_area |
利用できません（該当なし） | RadiusArea |
この新しいタイプでは、半径で地域を定義します。
region_code、lat_lng、radius、
radius_unitsが含まれます。デフォルトでは、公開設定は制限されています。
|
regional_inventory_eligible |
google.protobuf.BoolValue（出力のみ） |
optional bool（出力のみ） |
ラッパー型が削除されました。 |
shipping_eligible |
google.protobuf.BoolValue（出力のみ） |
optional bool（出力のみ） |
ラッパー型が削除されました。 |
メソッド
メソッドの使用方法を次のように変更します。
| 項目 | Content API for Shopping | Merchant API | 説明 |
|---|---|---|---|
| リージョンの取得 | GetRegion |
GetRegion |
リクエストでは name を使用します。 |
| リージョンの作成 | CreateRegion |
CreateRegion |
リクエストは URL から parent を取得しますが、リクエストの本文
には region オブジェクトと region_id が含まれます。
|
| リージョンの更新 | UpdateRegion |
UpdateRegion |
リクエストでは region（region.name を含む必要があります）と update_mask を使用します。 |
| リージョンの削除 | DeleteRegion
|
DeleteRegion
|
リクエストでは name を使用します。
|
| 地域のリスト | ListRegions |
ListRegions |
リクエストでは parent を使用します。page_size と
page_token の動作は一貫しています。
|
| バッチ作成 | なし | BatchCreateRegions |
これは新しいメソッドです。 |
| バッチ更新 | なし | BatchUpdateRegions |
これは新しいメソッドです。 |
| バッチ削除 | なし | BatchDeleteRegions |
これは新しいメソッドです。 |
名前が変更されたフィールド
| 項目 | Content API for Shopping | Merchant API | 説明 |
|---|---|---|---|
| アカウント ID | merchant_id |
account（name または parent の一部） |
リソース name 文字列に統合されました。これは、
Region（レスポンス）と、API
リクエストを行うために使用される protobuf メッセージ（CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest、ListRegionsRequest など）に影響します。 |
| 地域 ID | region_id |
region（name の一部）、region_id |
ほとんどの場合、name に統合されますが、region_id
には個別のフィールドがあります。CreateRegionRequestこれは、Region
（レスポンス）と、API リクエストを行うために使用される protobuf メッセージ（CreateRegionRequest, GetRegionRequest, UpdateRegionRequest, DeleteRegionRequest
、ListRegionsRequestなど）に影響します。 |
| リージョン名（出力） | region_id
|
name
|
レスポンスのプライマリ識別子フィールドが完全なリソース name になりました。これは Region に影響します。
|
| 表示名 | display_name |
display_name |
型が StringValue から optional string に変更されます。
これは Region に影響します。
|
| 利用資格フラグ | ...eligible |
...eligible |
型が BoolValue から optional bool に変更されます。
これは Region に影響します。
|
| 更新マスク | update_mask |
update_mask |
Region フィールド パス。これは UpdateRegionRequest に影響します。 |