データファイルリファレンス¶
データファイルのフォーマットについて説明します。
データはこれらの形式で格納しておく必要があります。
類語登録ファイル¶
特定のキーワードで検索された場合に指定しておいたキーワード (類語) に変換して検索するためのファイルです。
類語登録ファイルの形式¶
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
各列に格納するデータは下表のとおりです。
| 列 | 項目 | 説明 |
|---|---|---|
| 1 | 見出し語 | 基準となる見出し語を記述します 検索キーワードがこの語にマッチした場合に類語に展開されます。 |
| 2...N | 類語 | 見出し語に対する類語を記述します。 複数の類語がある場合、3 列目, 4 列目…のように、タブ文字で区切り複数登録します。 |
注意
展開される類語に見出し語は含まれません。見出し語と展開した類語を共に検索キーワードとしたい場合、類語の記述の中に見出し語も含めてください。
おすすめリンクデータファイル¶
検索結果とは別に特定キーワードで検索された場合や、デフォルトで固定のリンクバナーを表示させるためのファイルです。
おすすめリンクデータファイルの形式¶
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
注意
以下に該当する場合、データは正しく登録されません。
- 「_(アンダーバー)」で始まるフィールド名をヘッダ行に指定した列
- データ型に対して無効なデータが含まれた行
- ヘッダ行が存在しない
- link を指定した列が存在しない
- ヘッダ行に同じフィールド名が複数回登録する
おすすめリンクデータファイルで利用可能なフィールド¶
各列に格納するデータは下表のとおりです。
画面の表示には、表示に印が付いているフィールドが出力されます。
| フィールド名 | 説明 | データ型 | 必須 | 表示 |
|---|---|---|---|---|
| title | タイトル | 文字列 | ○ | |
| summary | 概要 | 文字列 | ○ | |
| link | 遷移先 URL | 文字列 | ○ | |
| url | 表示用 URL | 文字列 | ○ | |
| image | 画像 URL | 文字列 | ○ | |
| weight | 重み | 整数値 | ||
| start_date | 表示開始日時 | 日時 (5分刻み) | ||
| end_date | 表示終了日時 | 日時 (5分刻み) | ||
| keywords_exact | 完全一致キーワード | ｢|｣区切り文字列 | ||
| flag_nokeywords | 検索文字列未指定時に表示 | yes または no | ||
| flag_always | 常に表示 | yes または no | ||
| sections | 出し分け用文字列 | ｢|｣区切り文字列 |
データ型の詳細¶
- 文字列
- 文字列を登録することができます。
タブや改行を含む制御文字が含まれていた場合、意図しない動作になる可能性があります。 - 「|」区切り文字列
- 文字列を登録することができます。
タブや改行を含む制御文字、および「| (バーティカルバー)」が含まれていた場合、意図しない動作になる可能性があります。
「| (バーティカルバー)」で区切ることで複数登録することができます。 - 整数値
- 整数を登録することができます。
全角数字や記号、文字列は登録することができません。 - 日時
- 日時を登録することができます。
登録可能な形式は YYYY-MM-DD もしくは YYYY-MM-DD HH:MM の形式です。
登録された日時は日本標準時 (JST) とみなします。 - yes または no
- yes か no のどちらかを登録することができます。
フィールド名の詳細¶
- title: タイトル
- タイトルを格納します。
- summary: 概要
- 概要を格納します。
- link: 遷移先 URL
- おすすめリンクを選択した際に遷移する URL を格納します。スキーム (https: や http:) を含まない、// (連続するスラッシュ 2 つ) から始まる文字列を推奨します。
この項目は表示には使用されません。
この項目は省略できません。 - url: 表示用 URL
- URL を格納します。この項目は表示にのみ使用されます。
- image: 画像 URL
- 商品の画像の URL を格納します。スキーム (https: や http:) を含まない、// (連続するスラッシュ 2 つ) から始まる文字列を推奨します。正方形に近い画像を推奨します。
- weight: 重み
- 重みを格納します。この項目の数値が大きいおすすめリンクほど、表示の際に上位に表示されます。未指定の場合、weight に指定のあるおすすめリンクが表示された後に表示されます。
- start_date: 表示開始日時
- 表示開始日時を 5 分刻みで格納します。現在時刻 (日本標準時: JST) が、表示開始日時に満たないおすすめリンクは表示されません。この制限は他の全ての制限より優先されます。未指定の場合は開始日時の判定は行われません。
時刻を省略した場合、00:00:00 が指定されたとみなします。 - end_date: 表示終了日時
- 表示終了日時を 5 分刻みで格納します。現在時刻 (日本標準時: JST) が、表示終了日時を超えたおすすめリンクは表示されません。この制限は他の全ての制限より優先されます。未指定の場合は終了期限はありません。
時刻を省略した場合、23:59:59 が指定されたとみなします。 - keywords_exact: 完全一致キーワード
- キーワードを格納します。利用者が検索した文字列とこの項目に格納したキーワードが完全一致した場合におすすめリンクが表示されます。「| (バーティカルバー)」で区切ることで、複数のキーワードを登録することが可能です。
- flag_nokeywords: 検索文字列未指定時に表示
- yes もしくは no を格納します。yesが指定されたおすすめリンクは、利用者が検索した際に検索文字列が未指定（空）だった場合、表示されます。未指定の場合、 no とみなします。
- flag_always: 常に表示
- yes もしくは no を格納します。yesが指定されたおすすめリンクは、常に表示されます。ただし、表示開始日時、表示終了日時、出し分け用文字列、表示件数の制限は受けます。未指定の場合、no とみなします。
- sections: 出し分け用フラグ
- 出し分けフラグとなる文字列を「|」区切り文字列形式で格納します。おすすめリンクを表示する際に、ここに記述された文字列をリソースファイルに指定することで、対象の出し分けフラグが含まれたおすすめリンクのみを表示することができます。
キーワードランキングファイル¶
キーワードランキング機能において、指定したキーワードの順位や表示についての制御を行うためのファイルです。
キーワードランキングファイルの形式¶
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
注意
以下に該当する場合、データは正しく登録されません。
- 「_(アンダーバー)」で始まるフィールド名をヘッダ行に指定した列
- データ型に対して無効なデータが含まれた行
- ヘッダ行が存在しない
- keyword を指定した列が存在しない
- ヘッダ行に同じフィールド名が複数回登録する
キーワードランキングファイルで利用可能なフィールド¶
| フィールド名 | 説明 | データ型 | 必須 |
|---|---|---|---|
| keyword | 制御するキーワード | 文字列 | ○ |
| rank | 表示する順位。指定した順位に対象のキーワードが表示される | 1 以上の数値 | ○ |
| remove | 削除フラグ。このフィールドに文字が入っていたキーワードはランキングに表示されない | 文字列 |
関連キーワード登録ファイル¶
関連キーワード機能において、検索結果の表示時に追加表示させる関連のあるキーワードの登録を行うためのファイルです。
関連キーワード登録ファイルの形式¶
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
注意
以下に該当する場合、データは正しく登録されません。
- 「_(アンダーバー)」で始まるフィールド名をヘッダ行に指定した列
- データ型に対して無効なデータが含まれた行
- keyword を指定した列が存在しない行
- type に指定した値以外が存在する行
- related_keyword を指定した列が存在しない行
- ヘッダ行が存在しない
- ヘッダ行に同じフィールド名が複数回登録する
- keyword, type, related_keyword がこの順番に指定されていない
関連キーワード登録ファイルで利用可能なフィールド¶
| フィールド名 | 説明 | データ型 | 必須 |
|---|---|---|---|
| keyword | 登録する見出し語。検索キーワードはこの語と比較して関連キーワードを表示する | 文字列 | ○ |
| type | 関連キーワードの表示方法を指定する append: 関連キーワードを第 2 キーワードとして追加して表示する replace: 関連キーワードに置き換えて表示する 列が存在しない、または列に値が存在しない場合は append として扱われる |
append または replace | |
| related_keyword | 表示する関連キーワード。1 列に 1 つの関連キーワードを登録する。複数列の登録が可能 | 文字列 | ○ |
表示順制御ファイル¶
特定のキーワードで検索された場合に検索結果に表示される順番を変更するためのファイルです。
表示順制御ファイルの形式¶
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
注意
以下に該当する場合、データは正しく登録されません。
- 「_(アンダーバー)」で始まるフィールド名をヘッダ行に指定した列
- データ型に対して無効なデータが含まれた行
- ヘッダ行が存在しない
- keyword を指定した列が存在しない
- ヘッダ行に同じフィールド名が複数回登録する
表示順制御ファイルで利用可能なフィールド¶
| フィールド名 | 説明 | データ型 | 必須 |
|---|---|---|---|
| keyword | 制御するキーワード | 文字列 | ○ |
| url | キーワードで検索されるコンテンツ URL | 文字列 | ○ |
| score | 優先度。大きい値であるほど優先される | 1 以上の数値 | ○ |
| remarks | コメント | 文字列 |
検索結果除外ファイル¶
検索結果から特定のコンテンツを除外するためのファイルです。
検索結果除外ファイルの形式¶
- RFC4180 に準拠した形式の CSV
- 文字コードには UTF-8 を用いる。BOM (バイトオーダーマーク) は使用しない
- 1 行目に各列の定義を示すフィールド名を持つヘッダ行を記述する
- フィールドのデータにタブや改行を含む制御文字は使用しない
- 行の区切りは LF (line feed) で区切る
注意
以下に該当する場合、データは正しく登録されません。
- 「_(アンダーバー)」で始まるフィールド名をヘッダ行に指定した列
- データ型に対して無効なデータが含まれた行
- ヘッダ行が存在しない
- keyword を指定した列が存在しない
- ヘッダ行に同じフィールド名が複数回登録する
検索結果除外ファイルで利用可能なフィールド¶
| フィールド名 | 説明 | データ型 | 必須 |
|---|---|---|---|
| url | 除外するコンテンツ URL | 文字列 | ○ |
| remarks | コメント | 文字列 |