集計された商品に関する統計情報と問題点の取得方法が変更されました。これまで 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などのクエリ パラメータを使用してデータを選択するのではなく、listメソッドとfilter文字列を使用して、特定のレポート コンテキストと国をクエリします。 - チャネル フィールドの削除:
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 の形式
| 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 に変更されました。 |