集計された商品に関する統計情報と問題を取得する方法が変更されました。これまで Content API for Shopping の accountstatuses リソースで利用可能だった機能は、Merchant API の専用リソースに分割されました。このガイドでは、新しい aggregateProductStatuses リソースを使用するように統合を移行する方法について説明します。
注: Merchant API では、アカウント レベルの問題と商品のステータスの集計が分割されています。accountstatuses からアカウントの問題に移行するためのガイドもご覧ください。
主な違い
Content API for Shopping と Merchant API の商品ステータス機能の主な違いは次のとおりです。
- 専用リソース: Content API for Shopping の
accountstatusesリソースが分割されました。Merchant API では、アカウント レベルの問題はaccountissuesリソースから取得できます。一方、商品の統計情報と商品アイテム レベルの問題は、新しいaggregateProductStatusesリソースから取得できます。 - 新しいリソース構造:
AggregateProductStatusは、レポート コンテキストと国の特定の組み合わせの統計情報と問題を表現する新しいリソースです。 - フィルタリング メカニズム: Merchant API では、
destinationsなどのクエリ パラメータを使用してデータを選択する代わりに、filter文字列を含むlistメソッドを使用して、特定のレポート コンテキストと国をクエリします。 - チャネル フィールドの削除:
channelフィールドは使用されなくなりました。この情報は、reportingContextの一部として暗黙的に含まれるようになりました。
リクエスト
Merchant API は、filter パラメータを含む GET リクエストを使用して、集計された商品ステータスを取得します。
GET
https://merchantapi.googleapis.com/issueresolution/v1/{parent=accounts/*}/aggregateProductStatuses
リクエスト URL の形式
| リクエストの説明 | Content API for Shopping | Merchant API |
|---|---|---|
| 商品の統計情報と問題を取得する | GET /content/v2.1/{merchantId}/accountstatuses/{accountId} |
GET /issueresolution/v1/accounts/{accountId}/aggregateProductStatuses |
識別子
新しい構造をサポートするために、リソースの識別方法が変更されました。
ID の形式
| 識別子の説明 | Content API for Shopping | Merchant API |
|---|---|---|
| リソース ID | リソースは accountId で識別されました。クエリ パラメータで特定のデータスライスが選択されました。 |
リソース名は、特定のレポート コンテキストと国 / 地域のデータを一意に識別します（accounts/{account}/aggregateProductStatuses/{reportingContext}~{country}）。 |
メソッド
商品ステータスを取得するメソッドが、フィルタリングをサポートする list メソッドに更新されました。
| Content API for Shopping のメソッド | Merchant API メソッド | 提供状況とメモ |
|---|---|---|
accountstatuses.get |
aggregateProductStatuses.list |
accountstatuses.get メソッドは、すべての商品統計情報を含む単一のリソースを返しました。新しい aggregateProductStatuses.list メソッドは、レポート コンテキストと国の組み合わせごとに 1 つのリソースのリストを返します。filter パラメータを使用して、特定のデータを取得します。アカウント単位の問題の場合は、accountissues.list を使用します。 |
フィールドの変更の詳細
商品に関する統計情報と問題のフィールドが更新され、新しい AggregateProductStatus リソースで再構築されました。
| Content API for Shopping | Merchant API | 説明 |
|---|---|---|
products |
aggregate_product_statuses |
products 配列は、リスト レスポンスの aggregate_product_statuses 繰り返しフィールドに置き換えられます。 |
destination |
reporting_context |
destination フィールドは、統計情報のプログラム コンテキストを指定する reporting_context に置き換えられます。 |
channel |
（対応するフィールドなし） | channel フィールドが削除されます。この情報は reporting_context の一部になりました。 |
statistics |
stats |
statistics オブジェクトの名前が stats に変更されました。内部のフィールド名は snake_case に変換されます（activeCount は active_count になります）。 |
itemLevelIssues.servability |
item_level_issues.severity |
servability 列挙型が severity 列挙型に置き換えられ、問題の影響を説明するようになりました。 |
itemLevelIssues.attributeName |
item_level_issues.attribute |
フィールド attributeName の名前が attribute に変更されました。 |
itemLevelIssues.documentation |
item_level_issues.documentation_uri |
フィールド documentation の名前が documentation_uri に変更されました。 |
itemLevelIssues.numItems |
item_level_issues.product_count |
フィールド numItems の名前が product_count に変更されました。 |