Appendix¶
フックやフィルタの引数オブジェクトのプロパティ¶
item¶
item (商品情報) は次のプロパティを持ちます。
データが含まれていない項目については、そのプロパティは存在しません。(取り出した場合、undefined が返されます。)
プロパティの値はデータ型が異なります。
| プロパティ名 | 型 | 説明 |
|---|---|---|
| id | String | コンテンツ ID。通常 URL と同一 |
| title | String | コンテンツのタイトル |
| summary | String | コンテンツの概要 |
| link | String | コンテンツ URL |
| attributes | Array | コンテンツの属性 |
| icons | Array | コンテンツのアイコン |
| review_score | Number | コンテンツのレビュー平均点 |
| text | String | 表示用文字列 |
| keywords | Array | コンテンツのキーワード |
| keywords_exact | Array | コンテンツのキーワード |
| keywords_forward | Array | コンテンツのキーワード |
| keywords_alphanumeric | Array | 英数字の文字単位検索に使用するキーワード |
| additional_textN | String | 汎用文字列N (N は 1 から 10) |
| additional_linkN | String | 汎用リンクN (N は 1 から 3) |
| additional_sortN | Number | 汎用ソートN (N は 1 から 10) |
| additional_iconsN | Array | 汎用アイコンN (N は 1 から 3) |
| group | String | グルーピング検索用グルーピングキー |
| group_title | String | 代表コンテンツのタイトル |
| group_link | String | 代表コンテンツの URL |
| group_image | String | 代表コンテンツの画像 URL |
| numericN | Number | 汎用数値N (N は 1 から 5) |
| multi_numericN | Array | 複数汎用数値N (N は 1 から 5) |
| display_textN | String | 表示用文字列N(N は 1 から 50) |
| snippet | String | コンテンツの周辺文字列 |
| thumbnail | String | コンテンツの画像 |
| filetype | String | 取得したコンテンツの種別 |
| filesize | Number | 取得したコンテンツのサイズ |
| domain | String | 取得したコンテンツのドメイン |
| path | String | 取得したコンテンツのパス |
| last_modified | Number | 取得したコンテンツの最終更新日 (数値が返却されますので、itemLastModifiedFilter などで整形してお使いください。) |
filter_options¶
filter_options (フィルタ用設定ハッシュ) は次のプロパティを持ちます。
| プロパティ名 | 説明 | 型 | デフォルト値 |
|---|---|---|---|
| use_html | 出力時にエスケープを行わずHTMLとして出力する (※注) | Boolean | false |
注意
use_html を true で使用した場合、クロスサイトスクリプティング (XSS) などのセキュリティ上のリスクを防ぐため、フィルタ作成者自身が入力値を適切にエスケープする必要があります。
component¶
component (コンポーネント情報) は次のプロパティを持ちます。
データが含まれていない項目については、そのプロパティは存在しません。(取り出した場合、undefined が返されます。)
プロパティの値はデータ型が異なります。
| プロパティ名 | 説明 | 型 |
|---|---|---|
| element | コンポーネントの DOM | Element |
| name | data-[モード] に指定した値 | String |
| componentname | コンポーネント名 | String |
| elementid | DOM に指定された id。指定がなければ空文字 | String |
クエリでの絞り込み¶
属性リソースファイルの attributes パラメータの query キーの値には、AND、 OR、 NOT を組み合わせた絞り込み条件を指定します。
| フィールド | 説明 |
|---|---|
| AND | 指定した配列の属性で AND 検索 |
| OR | 指定した配列の属性で OR 検索 |
| NOT | 論理否定 ([値] ではない) |
補足
配列を 5 階層まで定義できます。
例
A1
{"AND": ["A1"]}
A1 AND A2
{"AND": ["A1", "A2"]}
A1 AND A2 AND A3
{
"AND": [
"A1",
"A2",
"A3"
]
}
A1 OR A2
{
"OR":[
"A1",
"A2"
]
}
NOT A1
{"NOT": "A1"}
A1 AND (A2 OR A3)
{"AND": ["A1", { "OR": ["A2", "A3"] }]}
(A1 OR A2) AND A3)
{"AND": [{ "OR": ["A1", "A2"] }, "A3"]}
A1 AND (NOT A2)
{"AND": ["A1", { "NOT": "A2" }]}
(NOT A1) AND (NOT A2)
{"AND": [{ "NOT": "A1" }, { "NOT": "A2" }]}
配列での絞り込み¶
次の値には、配列で絞り込み条件を指定します。
- additionalAttribute パラメータ
- refinements キー
| 記法 | 説明 |
|---|---|
| 属性を配列の第 1 階層に指定する | AND 検索 |
| 属性を配列の第 2 階層に指定する | OR 検索 |
例
A1
["A1"]
A1 AND A2
["A1", "A2"]
A1 AND A2 AND A3
["A1", "A2", "A3"]
A1 OR A2
[["A1", "A2"]]
A1 AND (A2 OR A3)
[["A1", ["A2", "A3"]]
(A1 OR A2) AND A3
[["A1", "A2"], "A3"]
additionalNotAttribute パラメータを使っての AND NOT 検索¶
additionalAttribute パラメータは additionalNotAttribute パラメータを組み合わせて AND NOT 検索を行うことができます。
補足
配列を 1 階層のみ定義できます。
例
A1 AND NOT A2
additionalAttribute: ["A1"]
additionalNotAttribute: ["A2"]
A1 AND NOT (A2 OR A3)
additionalAttribute: ["A1"]
additionalNotAttribute: ["A2", "A3"]
NOT (A1 OR A2) AND A3
additionalNotAttribute: ["A1", "A2"]
additionalAttribute: ["A3"]
利用可能な meta 要素¶
HTML を取得する際、いくつかの meta 要素を利用することができます。
これらの値は、クロール対象サイトの HTML に埋め込むことで利用可能です。
| nameの値 | 値の型 | contentの値 |
|---|---|---|
| keywords | 「, (カンマ)」区切り文字列 | 利用する設定の場合、キーワード検索時にマッチした場合に上位に表示されやすくなります。 |
| description | 文字列 | 利用する設定の場合、検索対象テキストに含まれるようになります。 |
| date | 日付 | ページの最終更新日の候補の 1 つとして利用されます。 書式は日付型の書式を参照してください。 優先順位は「最終更新日絞り込み機能の実装」を参照してください。 |
| og:image | 画像 URL | 利用する設定の場合、サムネイル画像として利用されます。 |
| og:title | 文字列 | タイトル要素が存在しない場合に代替タイトルとして利用されます。 |
| pf:image | 画像 URL | 画像として利用されます。 |
| pf:attributes | 「|(バーティカルバー)」区切り文字列 | 属性絞り込みの属性として利用されます。 属性絞り込みは「meta 要素による属性絞り込み」を参照してください。 |
| pf:last_modified | 日付 | ページの最終更新日の候補の 1 つとして利用されます。 書式は日付型の書式を参照してください。 優先順位は「最終更新日絞り込み機能の実装」を参照してください。 |
| pf:price | 整数値 | 価格として利用されます。 |
| pf:numericN | 整数値 | 汎用数値フィールドNとして利用されます。(N は 1 から 5) |
| pf:multi_numericN | 「, (カンマ)」区切り整数値 | 複数登録型汎用数値フィールドNとして利用されます。(N は 1 から 5) |
| pf:review_score | 実数 | レビュー平均点として利用されます。0.0 から 5.0。0.5 単位で未満は切り捨て |
| pf:text | 文字列 | テキストとして利用されます。 |
| pf:additional_textN | 文字列 | 汎用テキスト項目Nとして利用されます。(N は 1 から 10) |
| pf:additional_linkN | 文字列 | 汎用リンク項目Nとして利用されます。(N は 1 から 3) |
| pf:keywords | 「|(バーティカルバー)」区切り文字列 | キーワード (部分一致) として利用されます。 |
| pf:keywords_exact | 「|(バーティカルバー)」区切り文字列 | キーワード (完全一致) として利用されます。 |
| pf:keywords_forward | 「|(バーティカルバー)」区切り文字列 | キーワード (前方一致) として利用されます。 |
| pf:keywords_alphanumeric | 「|(バーティカルバー)」区切り文字列 | キーワード (文字単位前方一致) として利用されます |
| pf:sort | 整数値 | 並び順のキーとして利用されます。 |
| pf:additional_sortN | 整数値 | 並び順のキーとして利用されます。(N は 1 から 10) |
| pf:icons | 「, (カンマ)」区切り文字列 | アイコン画像 URL として利用されます。 |
| pf:additional_iconsN | 「, (カンマ)」区切り文字列 | 汎用アイコン画像URLNとして利用されます。(N は 1 から 3) |
| pf:group | 文字列 | グループキーとして利用されます。 |
| pf:group_title | 文字列 | 代表商品タイトルとして利用されます。 |
| pf:group_link | 文字列 | 代表商品 URL として利用されます。 |
| pf:group_image | 文字列 | 代表商品画像 URL として利用されます。 |
| pf:dateN | 日付 | 汎用日付Nとして利用されます。(N は 1 から 5) 書式は日付型の書式を参照してください。 |
| pf:display_textN | 文字列 | 表示専用テキストNとして利用されます。(N は 1 から 50)。 |
| pf:searchtext | 文字列 | 検索用テキストとして利用されます。 |
日付型の書式¶
書式: [年月日][区切り文字][時分秒]
| 項目 | 設定値 |
|---|---|
| [年月日] | YYYY-MM-DD YYYY/MM/DD |
| [区切り文字] | T |
| [時分秒] | hh:mm:ss+09:00 hh:mm:ss+0900 hh:mm:ss.xxx+09:00 hh:mm:ss.xxx hh:mm:ss hh:mm:ss GMT hh:mm:ss UTC 秒 (ss) に続く +0900 といった文字列はタイムゾーンを表す。日本標準時等を指定することが可能 |
例:
YYYY-MM-DDThh:mm:ss+09:00
YYYY-MM-DD hh:mm:ss+0900
YYYY/MM/DD hh:mm:ss