> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kameleoon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 検索結果の取得

> ユーザー入力に基づいて即時検索結果または全文検索結果を取得するために Kameleoon Search サービスをクエリします。

Kameleoon Search サービスは 2 種類の検索を提供します。

* **即時検索(タイプアヘッド検索)**: ユーザーが検索クエリを入力するたびに結果を表示および更新します。
* **完全検索**: ユーザーが検索クエリを送信した後に完全でフィルタリングされた検索結果を返します。

両方のオプションは同じエンドポイントを使用します。検索タイプを指定するには `type` パラメーターを使用します。

### リクエスト

```
GET https://api.products.kameleoon.com/search
```

### クエリパラメーター

これらのクエリパラメーターは完全検索と即時検索の両方に適用されます。[追加のパラメーター](#追加のクエリパラメーター-完全検索のみ)は完全検索でのみ使用してください。

| パラメーター         | 型      | 必須       | 説明                                                                                                                                                                                                        |
| :------------- | :----- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `did`          | String | True     | デバイス ID。`KameleoonProducts_device_id` クッキーからこの ID を取得します。このエンドポイントを呼び出す前に、バックエンドから取得してください。"Recently Viewed" や "Recommended for You" など、過去のデバイスデータに依存するフィルターまたはアルゴリズムを使用する場合にのみ `did` を提供します。             |
| `sid`          | String | True     | 一時的なユーザーセッション ID。`KameleoonProducts_session_code` クッキーからこの ID を取得します。このエンドポイントを呼び出す前に、バックエンドから取得してください。"Recently Viewed" や "Recommended for You" など、過去のユーザーデータに依存するフィルターまたはアルゴリズムを使用する場合にのみ `sid` を提供します。 |
| `shop_id`      | String | True     | ストアキー。Kameleoon アプリの **Recommendations** > **Settings** > **Store settings** で確認できます。必要に応じてカスタマーサクセスマネージャーにキーをお問い合わせください。                                                                                 |
| `type`         | String | True     | 検索タイプを指定します: `instant_search` または `full_search`。                                                                                                                                                          |
| `search_query` | String | True     | 現在の検索クエリ。                                                                                                                                                                                                 |
| `locations`    | List   | Optional | 場所 ID のカンマ区切りリスト。                                                                                                                                                                                         |

### 追加のクエリパラメーター(完全検索のみ)

これらの追加パラメーターは完全検索リクエスト(`type=full_search`)で使用してください。

| パラメーター           | 型                | 必須       | 説明                                                                                                                              |
| :--------------- | :--------------- | :------- | :------------------------------------------------------------------------------------------------------------------------------ |
| `limit`          | Integer          | Optional | API が返す結果の最大数。                                                                                                                  |
| `offset`         | Integer          | Optional | 結果のオフセット。                                                                                                                       |
| `category_limit` | Integer          | Optional | サイドバーフィルターのカテゴリの最大数。                                                                                                            |
| `categories`     | List             | Optional | フィルタリング用のカテゴリのカンマ区切りリスト。                                                                                                        |
| `extended`       | Integer or empty | Optional | 商品結果の拡張情報を追加します。サポートされる値: `1` または空。`1` の場合、API はすべての商品情報を返します。空の場合、API は商品 ID のみを返します。Kameleoon は完全検索の場合これを `1` に設定することをお勧めします。 |
| `sort_by`        | String           | Optional | ソートパラメーター。サポートされる値: `popular`、`price`、`discount`、`sales_rate`、`date`。                                                           |
| `order`          | String           | Optional | ソート方向: `asc`(昇順)または `desc`(降順)。デフォルトは `desc` です。                                                                                |
| `brands`         | List             | Optional | フィルタリング用のブランドのカンマ区切りリスト。                                                                                                        |
| `filters`        | String           | Optional | フィルターパラメーターを含むエスケープされた JSON 文字列。例: `{"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}`                           |
| `price_min`      | Integer          | Optional | 最低価格。                                                                                                                           |
| `price_max`      | Integer          | Optional | 最高価格。                                                                                                                           |
| `colors`         | Integer          | Optional | 色のカンマ区切りリスト。                                                                                                                    |
| `exclude`        | Integer          | Optional | 検索結果から除外する商品 ID のカンマ区切りリスト。                                                                                                     |

### レスポンス(即時検索)

| 名前                       | 型      | 説明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| :----------------------- | :----- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `search_query`           | string | 検索クエリ。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `categories`             | array  | カテゴリ情報。各オブジェクトには次のプロパティが含まれます:<ul><li>`id` – カテゴリ ID (string)</li><li>`name` – カテゴリ名 (string)</li><li>`url` – カテゴリ URL (string)</li><li>`count` – カテゴリ内の商品数 (number)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `filters`                | array  | フィルター情報。各オブジェクトには次のプロパティが含まれます: <ul><li>`filter` – 次のプロパティを含むフィルターオブジェクト:</li><li>`count` – これらのパラメーターにマッチする商品の合計数 (number)</li><li>`values` – 次のプロパティを含む値オブジェクトの配列:</li><li>`value` – 値ラベル (string)</li><li>`count` – このパラメーターを持つ商品の数 (number)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `html`                   | string | 商品ブロックの HTML コード。Kameleoon の個人アカウントでテンプレートをカスタマイズします。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `price_range`            | object | 商品価格の最小値と最大値。次のプロパティが含まれます:<ul><li>`min` – 最低価格 (number)</li><li>`max` – 最高価格 (number)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `products`               | array  | 商品情報。各オブジェクトには次のプロパティが含まれます:<ul><li>`description` – 商品の説明 (string)</li><li>`url` – 商品の絶対 URL (string)</li><li>`url_handle` – 商品の相対 URL (string)</li><li>`picture` – Kameleoon ストレージ内の商品画像 URL (string)</li><li>`name` – 商品名 (string)</li><li>`price` – 商品価格 (integer)</li><li>`price_full` – 商品価格 (float)</li><li>`price_formatted` – 通貨付きの商品価格 (string)</li><li>`price_full_formatted` – 通貨付きフォーマット済み商品価格 (string)</li><li>`image_url` - Kameleoon ストレージ内の商品画像の絶対 URL (string)</li><li>`image_url_handle` - Kameleoon ストレージ内の商品画像の相対 URL (string)</li><li>`image_url_resized` - リサイズされた画像 URL の配列</li><li>`currency` – 商品の通貨 (string)</li><li>`id` – 商品 ID (string)</li><li>`old_price` – 商品の以前の価格 (integer、デフォルトは 0)</li><li>`old_price_full` – 商品の以前の価格 (float)</li><li>`old_price_formatted` – 通貨付きの商品の以前の価格 (string)</li><li>`old_price_full_formatted` – 通貨付きフォーマット済み商品の以前の価格 (string)</li><li>リクエストに `extended` を含めた場合の追加プロパティ:<ul><li>`id` – カテゴリ ID (string)</li><li>`name` – カテゴリ名 (string)</li><li>`parent_id` – 親カテゴリ ID (string)</li><li>`url` - カテゴリ URL</li><li>`category_ids` - 商品カテゴリ ID (array)</li></ul></li></ul> |
| `search_query_redirects` | array  | リダイレクト情報。各オブジェクトには次のプロパティが含まれます:<ul><li>`query` – 検索クエリ (string)</li><li>`redirect_link` – リダイレクト用 URL (string)</li><li>`deep_link` – モバイルアプリ用 URL (string)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `products_total`         | number | 商品の合計数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |

### レスポンス(完全検索)

| 名前               | 型      | 説明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| :--------------- | :----- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `brands`         | array  | ブランド情報。各オブジェクトには次のプロパティが含まれます:<ul><li>`name` – ブランド名 (string)</li><li>`picture` – ブランド画像 URL (string)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `categories`     | array  | カテゴリ情報。各オブジェクトには次のプロパティが含まれます:<ul><li>`alias` – カテゴリエイリアス (string)</li><li>`id` – カテゴリ ID (string)</li><li>`name` – カテゴリ名 (string)</li><li>`parent` – 親カテゴリ ID (string)</li><li>`url` – カテゴリ URL (string)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `filters`        | array  | フィルター情報。各オブジェクトには次のプロパティが含まれます:<ul><li>`filter` – 次のプロパティを含むフィルターオブジェクト:<ul><li>`count` – これらのパラメーターにマッチする商品の合計数 (number)</li><li>`values` – `value` (string) と `count` (number) を含む値オブジェクト</li></ul></li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `html`           | string | 商品ブロックの HTML コード。Kameleoon の個人アカウントでテンプレートをカスタマイズします。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `price_range`    | object | 商品価格の最小値と最大値。次のプロパティが含まれます:<ul><li>`min` – 最低価格 (number)</li><li>`max` – 最高価格 (number)</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `products`       | array  | 商品情報。各オブジェクトには次のプロパティが含まれます:<ul><li>`brand` – 商品ブランド (string)</li><li>`currency` – 商品通貨 (string)</li><li>`id` – 商品 ID (string)</li><li>`is_new` – 商品プロパティ (boolean、デフォルトは null)</li><li>`name` – 商品名 (string)</li><li>`old_price` – 商品の以前の価格 (string、デフォルトは 0)</li><li>`picture` – Kameleoon ストレージ内の商品画像 URL (string)</li><li>`price` – 商品価格 (number)</li><li>`price_formatted` – 通貨付きの商品価格 (string)</li><li>`url` – 商品 URL (string)</li><li>リクエストに `extended` を含めた場合の追加プロパティ:<ul><li>`barcode` – 商品のバーコード (string)</li></ul></li><li>`categories` – 商品カテゴリ (array)。`id`、`name`、`parent` ID が含まれます。</li><li>`params` – パラメーター情報。各オブジェクトには `key` (string) と `values` (array) が含まれます。</li></ul> |
| `products_total` | number | 商品の合計数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `search_query`   | string | 検索クエリ。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |