これは、Recommendations AI、Retail Search、新しい Retail コンソールに関するドキュメントです。

監視とトラブルシューティング

このページでは、カタログやユーザー イベントのインポートで発生したエラーや、その他の Retail API オペレーションの情報を取得する方法について説明します。

アラートの設定について詳しくは、アラートを設定するをご覧ください。

はじめに

正確なカタログ情報とユーザー イベントを Retail API に提供することは、最高品質の結果を得るために重要です。エラーの原因をモニタリングし、理解することで、サイトのエラーを検出して修正できます。

集約された統合エラーを確認する

データ アップロード プロセスと予測リクエストや検索リクエストによって生成され、集計されたエラーを確認するには、[モニタリングと分析] ページの [モニタリング] タブを使用します。

このページには、Retail API のすべてのエラーが表示されます。商品カタログ、ユーザー イベント、Recommendations AI の予測、Retail Search の結果、モデルに関連するエラーを表示できます。また、Cloud Storage ファイル内の不正な行など、インポートのエラーもシステムによって記録されます。インポート ファイルごとに最大 100 件のエラーがログに記録されます。エラーが表示される期間を定義し、エラータイプに基づいてフィルタできます。

個々のエラーをクリックすると、Cloud Logging にエラーのログが表示されます。

そのログを展開して、個々のエラーログを開くことができます。エラーログには、リクエストやレスポンスのペイロードやエラーの詳細など、リクエストに関する詳細情報が確認できます。この情報は、問題のあるメソッド呼び出しがサイトのどこにあるのかを判断するのに役立ちます。

無効な JSON エラーの場合、status フィールドを展開すると、問題の詳細情報を取得できます。

特定の統合オペレーションのステータスを確認する

特定の統合オペレーションのステータスを表示するには、統合アクティビティ パネルを使用します。

  1. Google Cloud Console の [Retail Data] ページに移動します。

    [データ] ページに移動

  2. ボタンバーの [インポート アクティビティを表示] をクリックして、インポート アクティビティ パネルを開きます。

    特定の統合オペレーションのエラーをチェックできます。

  3. エラーがあるオペレーションの [詳細] 列で [ログを表示] をクリックし、Cloud Logging のログファイルを検査できます。

エラータイプ

  • MISSING_FIELD: 必須項目の値が設定されていません。(例: カタログ アイテムのタイトルがない)
  • INVALID_TIMESTAMP: タイムスタンプが無効です(例: 遠すぎる未来の日時、形式が正しくない)。
  • FIELD_VALUE_TOO_SMALL: フィールドの値が必要な最小値よりも小さい(例: 価格がマイナスになっている)。
  • INCORRECT_JSON_FORMAT: リクエスト内の JSON の形式が正しくありません(例: { 角かっこがない)。
  • INVALID_LANGUAGE_CODE: 言語コードの形式が正しくありません。
  • FIELD_VALUE_EXCEEDED: フィールドの値が上限を超えています。
  • INVALID_RESOURCE_ID: リソース ID が無効です(例: リソース名に存在しない catalog_id)。
  • FIELD_SIZE_EXCEEDED: フィールド内のエントリ数が上限を超えています。
  • UNEXPECTED_FIELD: 空であることが想定されたフィールドに値があります(例: 詳細ページビュー イベントのトランザクション)。
  • INVALID_FORMAT: フィールドの形式が正しくない(例: 文字列の形式が正しくない)。
  • RESOURCE_ALREADY_EXISTS: すでに存在するリソースを作成しようとしました(例: 作成済みのカタログ アイテム)。
  • INVALID_API_KEY: API キーがリクエスト内のプロジェクトと一致しません。
  • INSUFFICIENT_PERMISSIONS: リクエストを実行する権限がありません。このエラーは通常、必要な IAM 権限がないことに関連します。
  • UNJOINED_WITH_CATALOG: カタログに存在しないカタログ アイテム ID がリクエストに含まれています。カタログが最新であることをご確認ください。
  • BATCH_ERROR: リクエストに複数のエラーがあります(例: 10 個のアイテムがあるインライン インポートの検証に複数の理由で失敗した)。
  • INACTIVE_RECOMMENDATION_MODEL: サービス提供が有効ではないモデルに対してクエリを実行しました。
  • ABUSIVE_ENTITY: リクエストに関連付けられた訪問者 ID またはユーザー ID が、短期間に異常な数のイベントを送信しています。
  • FILTER_TOO_STRICT: 予測リクエスト フィルタによって、すべての予測結果がブロックされました。呼び出しで strictFiltering が false として指定されている場合を除き、汎用の(パーソナライズされていない)人気商品が返されます。それ以外の場合は、商品が返されません。この問題が発生する一般的な原因は次のとおりです。

    • カタログに存在しないフィルタタグを指定しています。フィルタタグの更新が反映されるまでに最大で 1 日かかることがあります。
    • フィルタが狭すぎます。

ログを直接確認する

Logging で直接ログファイルを開くこともできます。たとえば、Open Retail ログのリンクをクリックすると、過去 1 時間に発生したすべての Retail エラーのログが表示されます。

データの読み込み指標を表示する

データ アップロード システムが正常に実行されたら、[小売データ] ページの [カタログ] タブと [イベント] タブを使用して、データの取り込みのエラー指標を確認し、すべてが円滑に実行されるようにすることができます。

データ アップロード システムで問題が発生した場合に通知されるアラートを追加できます。

カタログデータの概要

[データ] ページの [カタログ] タブを使用して、各カタログ ブランチのデータ統計の概要を表示します。このページには、商品カタログ ブランチごとに、インポートした商品の数、在庫数、最後にインポートした商品が表示されます。

アップロードしたカタログ アイテムのプレビューを表示し、商品フィールドに基づいてフィルタリングすることもできます。

Recommendations AI または小売検索結果をステージングしてプレビューする方法として、データをさまざまなブランチにインポートできます。たとえば、ホリデー シーズンに備えて、新しいカタログデータをデフォルト以外のブランチにアップロードし、小売結果が正しく生成されることを確認してからウェブサイトで公開することができます。

ユーザー イベント記録の統計情報

ユーザー イベントの種類ごとに、[イベント] タブで、記録したイベントの数、そのうち商品に関連付けられなかったイベントの数(結合されていないイベント)、前の期間との数の相違を確認できます。プリセット期間を選択することも、カスタム期間を入力することもできます。

指標グラフには、一定期間にわたって取り込まれたユーザー イベントが表示されます。これは、ユーザー イベントの種類によってフィルタリングできます。

データ品質の指標

[データ] ページで [データ品質を表示] をクリックして、[データ品質] パネルを開きます。

データ品質の指標は、データ品質の推奨基準を満たすプロダクトとユーザー イベントの割合を示します。

これらの指標に従ってデータ品質を向上させるために Retail API を使用する必要はありませんが、改善して品質の高いレコメンデーションと検索結果を得ることを強くおすすめします。

カタログのデータ品質

[データ] ページの [カタログ] タブに、Retail Search のカタログ品質指標を満たすカタログ内の商品の割合が表示されます。

すべてのカタログ データ品質指標の一覧については、カタログのデータ品質指標をご覧ください。

イベントデータ品質

[データ] ページの [イベント] タブに、Recommendations AI と Retail Search の両方でデータ品質のベスト プラクティスを満たすユーザー イベント数が表示されます。

[イベント] データ品質タブには 2 つのセクションがあります。

  • 一般的な Retail API 指標: このタブの最初のセクションには、Recommendations AI と Retail Search の両方に適用できる指標が表示されます。これらの指標の提案に従うことで、推奨事項と検索結果を改善できます。

    このセクションの指標は、評価したユーザー イベントの時間範囲でフィルタできます。

  • 検索指標: このセクションの指標は、Retail Search にのみ適用されます。これらの指標の提案に従うことで、検索結果を改善できます。

    これらの指標は期間でフィルタできません。

    指標「検索イベント」はほぼリアルタイムで更新されます。フィルタを使用した検索イベントの指標は、検索イベントを最初にアップロードしてから 4 ~ 24 時間後に最初に更新されます。その後、約 4 時間ごとに更新されます。

    このセクションの他の指標は、検索イベントの指標が 100% に達するまで表示されます。検索イベントが完了してから約 24 時間後にこれらの指標が表示されます。1 日に 1 回更新されます。

    ユニーク商品数商品あたりの平均検索クリック数は関連する指標です。これらの指標の割合が低い場合は、検索イベントデータをインポートしていずれかの指標を向上させると、他の指標も改善されます。

Recommendations AI と Retail Search のすべてのユーザー イベント要件と推奨事項については、ユーザー イベントの要件とベスト プラクティスをご覧ください。

非結合イベント

ユーザー イベントまたは API リクエストが小売にアップロードされていないプロダクトを参照する場合、結合されていないイベントになります。結合されていないユーザー イベントは引き続きログに記録され、結合されていないリクエストも処理されますが、今後の予測に対して、にさらに強化するためには使用できません。このため、ログに記録されないイベントの割合が、ユーザー イベントと予測リクエストの両方で非常に低い値であることを確認する必要があります。

結合されていないユーザー イベントの割合は、[データ] ページの [イベント] タブで確認できます。

API エラー

クリックすると、メソッド名別に API エラーのグラフを時系列で表示するには、[モニタリングと分析] ページのボタンバーで、API 指標の表示をクリックします。

API メソッドのアクティビティをモニタリングする

API メソッドを使用してトラフィック、エラー、レイテンシを可視化するには、[モニタリングと分析] ページの [Monitoring] タブに移動します。プリセット期間を選択することも、カスタム期間を入力することもできます。

各グラフの詳細を表示するには:

  • グラフの下にあるメソッド名をクリックすると、グラフ内で分離されます。
  • グラフにカーソルを合わせると、各メソッドと、その時点での値のコールアウトが表示されます。
  • グラフの一部をクリックしてドラッグし、その期間を拡大できます。

次のステップ