accountstatuses から Account Issues に移行する

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

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

: Merchant API では、アカウント単位の問題と集計された商品ステータス が分割されています。accountstatuses から 集計された商品ステータスへの移行に関するガイドもご確認ください。

主な違い

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

  • 専用リソース: アカウントの問題は独自のリソースです。Content API for Shopping では、アカウント単位の問題は一般的な AccountStatus リソース内のネストされたフィールドでした。Merchant API では、accounts.issues.list メソッドを使用して直接一覧表示できます。
  • 構造化された影響データ: AccountIssue リソースには、詳細な impactedDestinations フィールドがあります。このフィールドでは、問題の影響を明確に分類できます。たとえば、掲載先(ショッピング広告など)、特定の地域、その地域での問題の重大度などです。
  • 重大度を列挙型として指定: severity フィールドが列挙型(CRITICALERRORSUGGESTION などの値)になったため、Content API for Shopping の文字列ベースの値と比較して、プログラムで処理しやすくなりました。
  • 標準化された識別子: 各アカウントの問題には、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/v1/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/v1/accounts/{ACCOUNT_ID}/issues
アドバンス アカウントのすべてのサブアカウントのアカウント単位の問題を一覧表示する GET https://shoppingcontent.googleapis.com/content/v2.1/{MERCHANT_ID}/accountstatuses 利用できません。サブアカウントを反復処理する必要があります。

識別子

Merchant API では、アカウントと問題の識別子が変更されています。

識別子の比較

識別子の説明 Content API for Shopping Merchant API
アカウント ID パスパラメータとしての {MERCHANT_ID}{ACCOUNT_ID} accounts/{ACCOUNT_ID} 形式のパスパラメータとしての {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(文字列) 問題の識別子が完全なリソース名になりました(例: accounts/{ACCOUNT_ID}/issues/{ISSUE_ID})。
title(文字列) title(文字列) 変更はありません。
detail(文字列) detail(文字列) 変更はありません。
documentation(文字列) documentationUri(文字列) URL であることを明確にするために記すと、フィールドの名前が変更されました。
severity(文字列) severity(列挙型) 重大度が文字列ではなく、構造化された列挙型(CRITICALERRORSUGGESTION)になりました。
country(文字列)、destination(文字列) impactedDestinations(繰り返しメッセージ) 影響がリストに構造化され、影響を受ける地域ごとに掲載先、リージョン、重大度がグループ化されました。country フィールドは、Impact メッセージ内の regionCode に置き換えられました。
(なし) language_codetime_zone(リクエスト パラメータ) list リクエストの新しいパラメータを使用すると、titledetail などの人間が読めるフィールドをローカライズできます。