accountstatuses から Account Issues に移行する

商品とアカウントの健全性に影響する可能性のあるアカウント単位の問題を取得する方法が変更されました。Content API for Shopping の accountstatuses リソースと比較して、Merchant API では、より構造化された詳細な情報を提供する専用の AccountIssue リソースが導入されています。

新機能の使用方法について詳しくは、アカウントの問題を確認するガイドをご覧ください。

主な違い

Merchant API AccountIssue リソースの主な改善点と相違点は次のとおりです。

  • 専用リソース: アカウントの問題は独自のリソースです。ショッピング用 Content API では、アカウント単位の問題は一般的な AccountStatus リソース内のネストされたフィールドでした。Merchant API では、accounts.issues.list メソッドを使用して直接一覧表示できます。
  • 構造化された影響データ: AccountIssue リソースは、詳細な impactedDestinations フィールドを提供します。このフィールドには、問題の影響(掲載先(ショッピング広告など)、特定の地域、その地域での問題の重大度など)が明確に表示されます。
  • 列挙型としての重大度: severity フィールドが列挙型(CRITICALERRORSUGGESTION などの値)になり、ショッピング向け Content API の文字列ベースの値と比較して、プログラムで処理しやすくなりました。
  • 標準化された ID: 各アカウントの問題には、accounts/{ACCOUNT_ID}/issues/{ISSUE_ID} 形式の固有の完全なリソース name があります。この標準化されたアプローチは、Content API for Shopping の id 文字列に代わるものです。
  • ローカライズのサポート: accounts.issues.list メソッドを使用すると、タイトルや説明などの問題の詳細を希望の言語で受け取るための language_code を指定できます。Content API for Shopping では、これはできませんでした。
  • 高度なアカウントの動作: 高度なアカウントで accounts.issues.list を呼び出すと、その高度なアカウントに直接適用される問題のみが返されます。サブアカウントの問題は返されません。Content API for Shopping では、accountstatuses.list メソッドはすべてのサブアカウントのステータスを返します。Merchant API でサブアカウントの問題をすべて取得するには、accounts.listSubaccounts を呼び出してから、サブアカウントごとに accounts.issues.list を個別に呼び出す必要があります。

リクエスト

Merchant API では、特定の Merchant Center アカウントのアカウントに関する問題を一覧表示できます。

GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/ACCOUNT_ID/issues

リクエスト URL の比較

リクエストの説明 Content API for Shopping Merchant API
単一のアカウントのアカウント単位の問題を一覧表示する GET https://shoppingcontent.googleapis.com/content/v2.1/{MERCHANT_ID}/accountstatuses/{ACCOUNT_ID} GET https://merchantapi.googleapis.com/accounts/v1beta/accounts/{ACCOUNT_ID}/issues
高度なアカウントのすべてのサブアカウントのアカウント単位の問題を一覧表示する GET https://shoppingcontent.googleapis.com/content/v2.1/{MERCHANT_ID}/accountstatuses 利用できません。サブアカウントを反復処理する必要があります。

識別子

Merchant API でアカウントと問題の識別子が変更されました。

ID の比較

識別子の説明 Content API for Shopping Merchant API
アカウント ID {MERCHANT_ID}{ACCOUNT_ID} をパスパラメータとして使用します。 {ACCOUNT_ID}accounts/{ACCOUNT_ID} 形式のパス パラメータとして使用します。
問題 ID レスポンスの本文の id フィールド("products-that-enable-dishonest-behavior-hacking-policy" など)。 レスポンス本文の name フィールド。これは完全なリソース名(例: accounts/12345/issues/example-issue-id)です。

メソッド

Merchant API で、アカウントの問題を取得する方法が統合され、簡素化されました。

メソッドの比較

Content API for Shopping Merchant API 提供状況とメモ
accountstatuses.get accounts.issues.list 利用可能。単一のアカウントの問題を取得するには、accounts.issues.list を使用してアカウント ID を指定します。Merchant API には、単一の問題に対する get メソッドがありません。
accountstatuses.list 同等のものはありません。 利用できません。Merchant API の accounts.issues.list メソッドは、指定されたアカウントの問題のみを返し、サブアカウントの問題は返しません。すべてのサブアカウントの問題を取得するには、まず accounts.listSubaccounts を呼び出し、次に各サブアカウントに対して accounts.issues.list を呼び出す必要があります。
accountstatuses.custombatch 同等のものはありません。 利用できません。Merchant API では、アカウントに関する問題の一括処理はサポートされていません。アカウントごとに個別の list 呼び出しを行う必要があります。

フィールドの変更の詳細

アカウントの問題リソース内のフィールドが更新され、構造と明確さが向上しました。

フィールドの比較

Content API for Shopping Merchant API 説明
accountLevelIssuesAccountStatus の配列) accountIssuesListAccountIssuesResponse の配列) 問題は、ネストされたフィールドではなく、専用の最上位リソースになりました。
id(文字列) name(文字列) 問題 ID は完全なリソース名(accounts/{ACCOUNT_ID}/issues/{ISSUE_ID} など)になりました。
title(文字列) title(文字列) 変更はありません。
detail(文字列) detail(文字列) 変更はありません。
documentation(文字列) documentationUri(文字列) URL であることを示すために、フィールドの名前を変更しました。
severity(文字列) severity(列挙型) 重大度が文字列ではなく、構造化された列挙型(CRITICALERRORSUGGESTION)になりました。
country(文字列)、destination(文字列) impactedDestinations(繰り返されるメッセージ) 影響がリスト形式で表示されるようになり、影響を受ける各エリアの宛先、地域、重大度がグループ化されます。Impact メッセージ内で、country フィールドが regionCode に置き換えられます。
(なし) language_codetime_zone(リクエスト パラメータ) list リクエストの新しいパラメータにより、titledetail などの人間が読める形式のフィールドをローカライズできます。