データファイルリファレンス¶
データファイルとは¶
データファイルは、検索に使用するデータです。
- 商品データファイル
- 候補語登録ファイル
- 候補語除外ファイル
- デフォルト表示キーワード登録ファイル
- 表示順制御ファイル
- 類語登録ファイル
商品データファイル¶
商品情報のデータファイルです。
次の形式、書式でファイルに格納してください。
- RFC4180 に準拠した形式の CSV もしくは タブ区切りテキスト (TSV)
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に 1 列から 14 列までのフィールド名を持つヘッダ行を記述する
- フィールドの順序は変えない
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
- TSV では、項目をダブルクォートで囲むことはできない
各列に格納するデータは下表のとおりです。
| 列 | フィールド名 | 項目 | 必須 | 表示 | 候補語 | 検索 |
|---|---|---|---|---|---|---|
| 1 (A) | id | 商品 ID | ○ | |||
| 2 (B) | link | 商品ページ URL | ○ | |||
| 3 (C) | title | 商品名 | ○ | ○ | ○ | ○ |
| 4 (D) | summary | 商品説明 | ○ | ○ | ○ | |
| 5 (E) | image | 商品画像 URL | ○ | ○ | ||
| 6 (F) | any1 | ユーザー定義データ1 | ○ | |||
| 7 (G) | any2 | ユーザー定義データ2 | ○ | |||
| 8 (H) | any3 | ユーザー定義データ3 | ○ | |||
| 9 (I) | sort1 | ソート用データ1 | ||||
| 10 (J) | sort2 | ソート用データ2 | ||||
| 11 (K) | sort3 | ソート用データ3 | ||||
| 12 (L) | keywords | キーワード | ○ | ○ | ||
| 13 (M) | itemcode | 商品コード | ||||
| 14 (N) | searchtext | 検索用追加テキスト | ○ |
必須：必ず指定すべき項目
表示：商品検索結果での表示に使用される項目
候補語：候補語の抽出の対象となる項目
検索：検索の対象となる項目
商品 ID (id)¶
商品を一意に識別できる文字列を格納します。
商品ページ URL (link)¶
商品検索結果をクリックした際に遷移するページのURLを格納します。
スキーム (https: や http:) を含まない、// (連続するスラッシュ 2 つ) から始まる文字列を格納してください。
商品名 (title)¶
商品検索結果に表示される商品名を格納します。この商品名は、候補語の抽出や、商品検索でも用いられます。
商品説明 (summary)¶
商品検索結果に表示される商品の説明文を格納します。この商品説明は、候補語の抽出や、商品検索でも用いられます。
商品画像 URL (image)¶
商品検索結果に表示される画像の URL を格納します。
スキーム (https: や http:)を含まない、// (連続するスラッシュ 2 つ) から始まる文字列を格納してください。
表示速度や画質の観点から、90 ピクセル × 90 ピクセルの大きさの画像を推奨します。
(それより大きめの画像を選ぶ場合でも、できるだけこの大きさに近いものを推奨します。)
ユーザー定義データ1 ~ 3 (any1 ~ any3)¶
ユーザー定義データ1 ~ 3は、特に用途が決められていません。
たとえば、価格やお薦め度など、データ作成者が用途を決めます。
このデータは商品検索結果に表示することができます。
ソート用データ1 ~ 3 (sort1 ~ sort3)¶
商品検索結果のソートに使用するデータを指定します。
数値の場合は桁数を揃えてください。
桁が足りないデータは左側を 0 で埋めて、全商品で桁数を揃えてください。
桁数がそろっていない数値データは正しくソートできません。
ソート用データ1 ~ 3のいずれをソートに使うか、また優先度、さらにソートの方向を、弊社へのお申し込み時にお知らせください。
キーワード (keywords)¶
この商品に関する特徴的なキーワードを記入します。ここに記入したキーワードは、候補語として登録されます。
また、商品検索用の単語としても登録されるため、このキーワードを入力すると、この商品が商品検索結果の候補になります。
キーワードが複数ある場合にはカンマで区切ります。
(カンマの前後にスペース不要。カンマを含む候補語の登録不可)
他の商品に同じキーワードが存在しても問題ありません。
商品コード (itemcode)¶
商品レコメンド機能で、レコメンドサービスと連携させる場合に使用します。
レコメンドサービス側で認識される商品識別コードを格納します。
レコメンドサービスとの連携につきましては、弊社営業までお問い合わせください。
検索用追加テキスト (searchtext)¶
商品検索でヒットさせたい文字列を記入します。
キーワードのカラムや商品説明のデータとは異なり、検索用追加テキストは、候補語や表示の対象にはなりません。
候補語登録ファイル¶
独自の候補語や読み仮名を登録するのに使用します。
また、候補語を上位に表示するのにも使用します。
次の形式、書式でファイルに格納してください。
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
候補語登録ファイルのカラム構成は次のとおりです。
| フィールド名 | 項目 | 必須 |
|---|---|---|
| keyword | 候補語 (表示される文字列) | ○ |
| yomi | 読み (ひらがな) | |
| weight | 優先度 (1 から 100 の数値。大きいほうが優先的に表示される) | |
| remarks | コメント (登録内容は動作に影響しない) |
優先度の指定を省略した場合には、20 が適用されます。
また、読みを省略した場合には、読みが自動的に付与されます。
複数の読みを持つ候補語を登録するには、同じ候補語を、読みを変えて複数登録します。
下記の例では、「ビール」という候補語に「びいる」、「びあ」、「beer」の 3 つの読みを割り当てています。
keyword,yomi,weight
ビール,びいる,20
ビール,びあ,20
ビール,beer,20
候補語除外ファイル¶
不要な候補語を削除するのに使用します。
次の形式、書式でファイルに格納してください。
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
| フィールド名 | 項目 | 必須 |
|---|---|---|
| keyword | 除外する単語 | ○ |
| remarks | コメント (登録内容は動作に影響しない) |
デフォルト表示キーワード登録ファイル¶
検索ボックスに文字を入力する前に、キーワードを表示するのに使用します。
次の形式、書式でファイルに格納してください。
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
| フィールド名 | 項目 | 必須 |
|---|---|---|
| keyword | 表示するキーワード | ○ |
| rank | 表示する順位 | ○ |
類語登録ファイル¶
キーワードの言い換えや表記の揺れを解決するのに使用します。
次の形式、書式でファイルに格納してください。
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
| フィールド名 | 項目 | 必須 |
|---|---|---|
| keyword | 見出し語 | ○ |
| synonym1 | 類語1 | ○ |
| synonym2 | 類語2 | |
| synonym3 | 類語3 | |
| synonym4 | 類語4 | |
| synonym5 | 類語5 |
表示順制御ファイル¶
検索結果の表示順を変更するのに使用します。
次の形式、書式でファイルに格納してください。
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
| フィールド名 | 項目 | 必須 |
|---|---|---|
| keyword | 見出し語 | ○ |
| url | URL | ○ |
| score | スコア | ○ |
| remarks | コメント (登録内容は動作に影響しない) |
カスタムサジェストデータファイル¶
カスタムサジェストを表示するのに使用します。
前提
カスタムサジェストオプション の契約が必要です。
次の形式、書式でファイルに格納してください。
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
| フィールド名 | 項目 | 必須 |
|---|---|---|
| name | 表示する名称 | ○ |
| icon_url | アイコンの URL | |
| link | 遷移先 URL | ○ |
| weight | レコードの重み。整数値で指定。大きいものが優先的にヒットする | |
| keywords | ヒットさせるキーワード。複数指定する場合はカンマ区切りで指定する | ○ |
文字に関する制限¶
設定データファイルに含めることができる文字には制限があります。
以下は不正な文字として扱います。
インデクシングで不正な文字があった場合、エラーとなり、データベースは更新されません。
- バイトオーダーマーク (BOM)
- 制御文字
- UTF-8 として正しくないバイト列
制御文字には、VT (Vertical Tab–0B)、CR (Carriage Return–0D) が含まれます。
また、HT (Horizontal Tab–09) はカラムの区切り、LF (Line Feed–0A) は行末文字として扱われるため、データに含めることはできません。