Skip to content

用語集 ​

契約(contract=v1) ​

このドキュメントに書かれた形でレスポンスを返してほしい、という指定です。リクエストに contract=v1 を付けたときだけ、フィールドの名前・型・意味が変わらないことを保証します。

付けない場合はアプリ内部のレスポンスが返ります。そちらはまるっと検索のウィジェットが読むための形で、予告なく変わります。

ファセット(facets) ​

絞り込みの選択肢と、その件数です。「ベンダー: ATELIER NOA (42)」のように表示するための集計値を指します。

検索結果の横に出る絞り込みメニューを作るための材料、と考えてください。

json
"facets": {
  "vendors": [{ "value": "ATELIER NOA", "count": 42 }],
  "price_range": [3900, 42000]
}

縮退(degraded) ​

索引が一時的に使えない状態です。初回同期中や障害時に、degraded が true になります。

縮退中は結果が空になるか、Shopify 標準検索の結果が返ります。エラーではないので、data.results を読む処理は通常どおり動きます。

ブラウズ(q=*) ​

検索語なしで全件を並べるモードです。コレクションページのように「まず全部出してから絞り込む」画面で使います。

商品テーブルだけを読む別経路のため、一部のファセットが返りません。

形態素解析 ​

日本語の文を単語に切る処理です。日本語は単語の間に空白がないため、この処理をしないと「ワンピース」で「春夏用リネンワンピース」を見つけられません。

表記ゆれ ​

同じものを指す、書き方の違いです。「りんご / リンゴ / 林檎」「WD650 / WD650」など。

まるっと検索は登録なしで吸収します(→ 検索の仕組み)。

同義語 ​

文字としては無関係だが、意味が同じ語です。「Tシャツ / カットソー」など。

表記ゆれと違い、自動では吸収できないため管理画面で登録します(Pro)。

App Proxy ​

Shopify が提供する仕組みで、ストアのドメイン上のURLへのアクセスを、アプリのサーバへ転送します。

これにより https://ストア.myshopify.com/apps/marutto-search/search というストア自身のURLで検索でき、APIキーもCORS設定も不要になります。

measurement_proof ​

検索と売上を紐づけるための署名です。この値を計測イベントに含めることで、「どの検索が購入につながったか」を追跡できます。

含めないと、そのストアの検索経由売上は計上されません(→ 仕様の7章)。

session_id ​

同じ買い物客の一連の操作をまとめるための識別子です。御社で発番していただきます。

検索とクリックを結び付けるために使うので、ページ遷移で変わらないようにしてください。session_id の無い検索は分析に計上されません。

まるっと検索