データスキーマ: 検索分析とルール

periodAnalyticsPeriodData 必須

集計期間とその開始・終了。

例: {"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"}

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

minLength: 1maxLength: 100

例: "example"

追加フィールド: いいえ

as_of文字列必須

報告データの基準時刻。

format: "date-time"

例: "2026-01-02T00:00:00Z"

days整数必須

集計期間の日数。

例: 1

started_at文字列必須

開始日時。

format: "date-time"

例: "2026-01-01T00:00:00Z"

追加フィールド: いいえ

data配列 <MetricData > 必須

レスポンス例 · AnalyticsResponse_list_MetricData__.

例: [{"clicks":1,"last_seen_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","searches":1,"zero_results":1}]

metaAnalyticsPageMeta | AnalyticsMeta 必須

レスポンスのメタデータ。

例: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

追加フィールド: いいえ

data配列 <OccurrenceData > 必須

レスポンス例 · AnalyticsResponse_list_OccurrenceData__.

例: [{"category_id":"example","category_result_count":1,"currency_code":"PLN","is_zero_results":false,"locale_code":"en","market_id":"example","max_price":"0.00","min_price":"0.00","occurred_at":"2026-01-01T12:00:00Z","page":1,"product_result_count":1,"query_display":"example","request_id":"example","results":[{"clicked":false,"entity_id":"example","entity_type":"product","image_url":"https://example.invalid/product.jpg","number":"example","placement_source":"organic","position":1,"sku":"example","slug":"example","title":"example"}],"sort_key":"example","source":"results"}]

metaAnalyticsPageMeta | AnalyticsMeta 必須

レスポンスのメタデータ。

例: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

追加フィールド: いいえ

dataOverviewData 必須

レスポンス例 · OverviewData.

例: {"click_through_rate":0,"clicked_searches":1,"recent":[{"is_zero_results":false,"locale_code":"en","occurred_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","request_id":"example","result_count":1,"source":"results"}],"searches":1,"zero_result_rate":0,"zero_results":1}

metaAnalyticsPageMeta | AnalyticsMeta 必須

レスポンスのメタデータ。

例: {"period":{"as_of":"2026-01-02T00:00:00Z","days":1,"started_at":"2026-01-01T00:00:00Z"},"request_id":"example"}

追加フィールド: いいえ

data配列 <RuleSummaryData > 必須

レスポンス例 · ApiResponse_list_RuleSummaryData__.

例: [{"created_at":"2026-01-01T12:00:00Z","enabled":true,"id":"example","is_available":true,"market_scope":"all","name":"Example","updated_at":"2026-01-01T12:00:00Z","version":1}]

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"locale":"en","market_code":"PL","market_id":"example","pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

追加フィールド: いいえ

dataRuleDetailData 必須

レスポンス例 · RuleDetailData.

例: {"category_ids":["example"],"created_at":"2026-01-01T12:00:00Z","enabled":true,"id":"example","is_available":true,"market_ids":["example"],"market_scope":"all","name":"Example","phrase_groups":[{"locale":"en","phrases":["example"]}],"product_ids":["example"],"updated_at":"2026-01-01T12:00:00Z","version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta 必須

レスポンスのメタデータ。

例: {"locale":"en","market_code":"PL","market_id":"example","request_id":"example"}

追加フィールド: いいえ

clicks整数必須

クリック数。

例: 1

last_seen_at文字列必須

最後に発生した時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

query_display文字列必須

管理者に表示する検索語句。

例: "example"

query_hash文字列必須

グループ化された検索語句の安定した識別子。

例: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

searches整数必須

検索回数。

例: 1

zero_results整数必須

結果が0件の検索回数。

例: 1

追加フィールド: いいえ

category_id文字列 | null必須

カテゴリー識別子。

例: "example"

category_result_count整数必須

カテゴリーの結果数。

例: 1

currency_code文字列必須

通貨コード。

例: "PLN"

is_zero_results真偽値必須

検索結果が0件だったかどうか。

例: false

locale_code文字列必須

言語コード。

例: "en"

market_id文字列必須

コンテキストエンドポイントが返した市場識別子。

例: "example"

max_price文字列 | null必須

報告範囲の最高価格。

例: "0.00"

min_price文字列 | null必須

報告範囲の最低価格。

例: "0.00"

occurred_at文字列必須

イベントの発生日時。

format: "date-time"

例: "2026-01-01T12:00:00Z"

page整数必須

CMS ページ情報。

例: 1

product_result_count整数必須

商品の検索結果数。

例: 1

query_display文字列必須

管理者に表示する検索語句。

例: "example"

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

例: "example"

results配列 <ResultSnapshotData > | null必須

記録された検索結果。

例: [{"clicked":false,"entity_id":"example","entity_type":"product","image_url":"https://example.invalid/product.jpg","number":"example","placement_source":"organic","position":1,"sku":"example","slug":"example","title":"example"}]

sort_key文字列必須

並べ替えキー。

例: "example"

source文字列必須

記録された活動の発生元。

制約

enum

["results", "autocomplete"]

例: "results"

追加フィールド: いいえ

click_through_rate数値必須

選択した検索データのクリック率。

例: 0

clicked_searches整数必須

クリックを伴う検索の回数。

例: 1

recent配列 <RecentSearchData > 必須

最近の検索情報。

例: [{"is_zero_results":false,"locale_code":"en","occurred_at":"2026-01-01T12:00:00Z","query_display":"example","query_hash":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","request_id":"example","result_count":1,"source":"results"}]

searches整数必須

検索回数。

例: 1

zero_result_rate数値必須

結果が0件の検索の割合。

例: 0

zero_results整数必須

結果が0件の検索回数。

例: 1

追加フィールド: いいえ

追加フィールド: はい

is_zero_results真偽値必須

検索結果が0件だったかどうか。

例: false

locale_code文字列必須

言語コード。

例: "en"

occurred_at文字列必須

イベントの発生日時。

format: "date-time"

例: "2026-01-01T12:00:00Z"

query_display文字列必須

管理者に表示する検索語句。

例: "example"

query_hash文字列必須

グループ化された検索語句の安定した識別子。

例: "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

request_id文字列必須

申請識別子。レスポンスのメタデータでは HTTP リクエストを識別します。

例: "example"

result_count整数必須

検索結果数。

例: 1

source文字列必須

記録された活動の発生元。

制約

enum

["results", "autocomplete"]

例: "results"

追加フィールド: いいえ

clicked真偽値必須

結果がクリックされたかどうか。

例: false

entity_id文字列必須

参照先のエンティティ識別子。

例: "example"

entity_type文字列必須

参照先のエンティティ種別。

制約

enum

["product", "category"]

例: "product"

image_url文字列 | null必須

画像 URL。

例: "https://example.invalid/product.jpg"

number文字列 | null必須

人向けの注文番号または申請番号。

例: "example"

placement_source文字列必須

注文が送信された経路。

制約

enum

["organic", "merchandising"]

例: "organic"

position整数必須

順序付きコレクション内の位置。

例: 1

sku文字列必須

在庫管理単位のコード。

例: "example"

slug文字列必須

選択した言語での URL パス部分。

例: "example"

title文字列必須

選択した言語でのタイトル。

例: "example"

追加フィールド: いいえ

category_ids配列 <文字列> 任意

関連するカテゴリーの識別子。

maxItems: 100

配列:minLength: 1maxLength: 63

enabled真偽値任意

この設定が有効かどうか。

既定値: false

market_ids配列 <文字列> 任意

選択した市場の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

market_scope文字列任意

すべての市場か選択した市場かを示す適用範囲。

制約

enum

["all", "selected"]

name文字列必須

該当コンテキストでのリソース名。

minLength: 1maxLength: 160

例: "Example"

phrases配列 <文字列> 必須

検索ルールで使う語句。

minItems: 1maxItems: 20

配列:minLength: 1maxLength: 255

例: ["example"]

product_ids配列 <文字列> 任意

関連商品の識別子。

maxItems: 100

配列:minLength: 1maxLength: 63

例: ["example"]

追加フィールド: いいえ

category_ids配列 <文字列> 必須

関連するカテゴリーの識別子。

例: ["example"]

created_at文字列必須

作成時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

enabled真偽値必須

この設定が有効かどうか。

例: true

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (RuleDetailData).

例: "example"

is_available真偽値必須

このコンテキストで対象を利用できるかどうか。

例: true

market_ids配列 <文字列> 必須

選択した市場の識別子。

例: ["example"]

market_scope文字列必須

すべての市場か選択した市場かを示す適用範囲。

制約

enum

["all", "selected"]

例: "all"

name文字列必須

該当コンテキストでのリソース名。

例: "Example"

phrase_groups配列 <RulePhraseGroupData > 必須

検索ルールの語句グループ。

例: [{"locale":"en","phrases":["example"]}]

product_ids配列 <文字列> 必須

関連商品の識別子。

例: ["example"]

updated_at文字列必須

最終更新時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

version整数必須

同時更新制御に使うリソースバージョン。

例: 1

追加フィールド: いいえ

locale文字列必須

このリクエストで選択した言語。

例: "en"

phrases配列 <文字列> 必須

検索ルールで使う語句。

例: ["example"]

追加フィールド: いいえ

created_at文字列必須

作成時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

enabled真偽値必須

この設定が有効かどうか。

例: true

id文字列必須

リソース識別子。返された値をそのまま保持してください。 (RuleSummaryData).

例: "example"

is_available真偽値必須

このコンテキストで対象を利用できるかどうか。

例: true

market_scope文字列必須

すべての市場か選択した市場かを示す適用範囲。

制約

enum

["all", "selected"]

例: "all"

name文字列必須

該当コンテキストでのリソース名。

例: "Example"

updated_at文字列必須

最終更新時刻。

format: "date-time"

例: "2026-01-01T12:00:00Z"

version整数必須

同時更新制御に使うリソースバージョン。

例: 1

追加フィールド: いいえ

category_ids配列 <文字列> 任意

関連するカテゴリーの識別子。

maxItems: 100

配列:minLength: 1maxLength: 63

enabled真偽値任意

この設定が有効かどうか。

expected_version整数必須

書き込み前に取得したバージョン。不一致の場合は更新を拒否します。

minimum: 1maximum: 2147483647

例: 1

market_ids配列 <文字列> 任意

選択した市場の識別子。

maxItems: 1000

配列:minLength: 1maxLength: 63

market_scope文字列任意

すべての市場か選択した市場かを示す適用範囲。

制約

enum

["all", "selected"]

name文字列任意

該当コンテキストでのリソース名。

minLength: 1maxLength: 160

例: "Example"

phrases配列 <文字列> 任意

検索ルールで使う語句。

maxItems: 20

配列:minLength: 1maxLength: 255

product_ids配列 <文字列> 任意

関連商品の識別子。

maxItems: 100

配列:minLength: 1maxLength: 63

追加フィールド: いいえ

追加フィールド: はい