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_foreard	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)
keywords_alphanumeric	String	英数字の文字単位検索に使用するキーワード
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(フィルタ用設定ハッシュ)は次のプロパティを持ちます。

プロパティ名	説明	型	デフォルト値
use_html	出力時にエスケープを行わずHTMLとして出力する(※注)	Boolean	false

注意

use_html を true で使用した場合、クロスサイトスクリプティング(XSS)などのセキュリティ上のリスクを防ぐため、フィルタ作成者自身が入力値を適切にエスケープする必要があります。

component¶

component(コンポーネント情報)は次のプロパティを持ちます。
データが含まれていない項目については、そのプロパティは存在しません。(取り出した場合、undefinedが返される)
プロパティの値はデータ型が異なります。

プロパティ名	説明	型
element	コンポーネントのDOM	Element
name	data-[モード]に指定した値	String
componentname	コンポーネント名	String
elementid	DOMに指定されたid。指定がなければ空文字	String

複雑な絞り込み条件に渡す配列の詳細¶

設定パラメータのadditionalAttributeや、属性リソースファイルのrefinementsは、配列の指定方法によって複雑な絞り込み条件を実現することができます。

以下はその例です。

A1を指定する

["A1"]

A1 AND A2を指定する
1階層目に複数の値を登録した場合はAND検索になります。

["A1","A2"]

A1 OR A01を指定する
2階層目に複数の値を登録した場合はOR検索になります。

[["A1","A01"]]

(A1 OR A01) AND A2を指定する
AND条件の中にOR条件を指定することもできます。

[["A1","A01"],"A2"]

not条件の追加¶

not条件を追加したい場合は、additionalNotAttributeパラメータを使用します。
additionalNotAttributeパラメータは1階層のみ指定可能で、指定された値同士はANDNOTで結合されます。

A1 ANDNOT A2を指定する

additionalAttribute: ["A1"]
additionalNotAttribute: ["A2"]

A1 ANDNOT A2 ANDNOT A3 を指定する
※A1 ANDNOT (A2 OR A3) と同じ意味になります。

additionalAttribute: ["A1"]
additionalNotAttribute: ["A2","A3"]

ポップファインドで利用可能なmeta要素¶

HTMLを取得する際、いくつかのmeta要素はポップファインドで利用することができます。
これらの値は、クロール対象サイトのHTMLに埋め込むことで利用可能です。
ご契約時のヒアリングシートの設定が反映される項目を「設定可」としています。

設定可	nameの値	値の型	contentの値
○	keywords	「,(カンマ)」区切り文字列	利用する設定の場合、キーワード検索時にマッチした場合に上位に表示されやすくなります
○	description	文字列	利用する設定の場合、検索対象テキストに含まれるようになります
	date	日付	ページの最終更新日の候補の1つとして利用されます。優先順位は「最終更新日絞り込み機能の実装」を参照ください
○	og:image	画像URL	利用する設定の場合、サムネイル画像として使用されるようになります
	og:title	文字列	タイトル要素が存在しない場合に代替タイトルとして使用されます
	pf:last_modified	日付	ページの最終更新日の候補の1つとして利用されます。優先順位は「最終更新日絞り込み機能の実装」を参照ください
	pf:sort	整数値	並び順のキーとして使用することができます
	pf:additional_sortN	整数値	並び順のキーとして使用することができます(Nは1から10)
	pf:attributes	「\|(バーティカルバー)」区切り文字列	属性絞り込みの属性として使用することが出来ます

ライセンス情報¶

ポップファインドのフロントエンドには、複数のオープンソースソフトウェアが使用されています。各ソフトウェアの利用条件に基づいて、弊社は、そのライセンスの内容をお客様へ通知する義務があります。

各ソフトウェアのライセンスの詳細な内容は、リンク先の文書をご覧ください。

encoding-japanese: Copyright (c) 2013-2017 polygon planet <polygon.planet.aqua@gmail.com>
Released under the MIT License.
https://github.com/polygonplanet/encoding.js/blob/master/README_ja.md#license
es6-promise: Copyright (c) 2014 Yehuda Katz, Tom Dale, Stefan Penner and contributors
Released under the MIT License.
https://raw.githubusercontent.com/stefanpenner/es6-promise/master/LICENSE
sprintf: Copyright © 2007-2013, Alexandru Marasteanu <hello [at) alexei (dot] ro> All rights reserved.
Released under the 3-Clause BSD License.
https://github.com/maritz/node-sprintf#copyrightlicense
uuid: Copyright (c) 2010-2016 Robert Kieffer and other contributors
Released under the MIT License.
https://github.com/kelektiv/node-uuid/blob/master/LICENSE.md
array-find: Copyright (c) Stefan Duberg
Released under the MIT License.
https://github.com/stefanduberg/array-find/blob/master/LICENSE
js-sha1: Copyright 2014-2017 Chen, Yi-Cyuan
Released under the MIT License.
https://github.com/emn178/js-sha1/blob/master/LICENSE.txt
change-case: Copyright (c) 2014 Blake Embrey (hello@blakeembrey.com)
Released under the MIT License.
https://github.com/blakeembrey/change-case/blob/master/LICENSE
deepmerge: Copyright (c) 2012 James Halliday, Josh Duff, and other contributors
Released under the MIT License.
https://github.com/TehShrike/deepmerge/blob/master/license.txt