リソースファイルリファレンス¶
ポップファインドを導入するにあたり、
- 並び順リソースファイル: 並び順の定義、変更に使用
- メッセージリソースファイル: 文言変更に使用(文言を変更しない場合は不要)
- 属性リソースファイル: 属性絞り込みの表示に使用(未使用の場合は不要)
- おすすめリンクリソースファイル: おすすめリンクの表示に使用(未使用の場合は不要)
-
最終更新日リソースファイル: 最終更新日絞り込みの表示のカスタマイズに使用(カスタマイズしない場合は不要)
-
ハッシュタグリソースファイル: ハッシュタグの表示に使用
上記のリソースファイルを、必要に応じて作成・編集し、
利用先サーバへの設置をすることで、ポップファインドの振る舞いを変更することができます。
それぞれのファイルの文字コードには UTF-8を用いてください。
並び順リソースファイル¶
並び順リソースファイルは、並び順とその名称を定義するファイルです。
このリソースファイルは、デフォルトの並び順を決定したり、並び順コンポーネントで表示する並び順を決定する為に使用されます。
注意
並び順リソースファイルは、並び順変更コンポーネントでの表示以外にも、
デフォルトの並び順の決定の為に必要です。
必ず1つ以上の並び順を定義した並び順リソースファイルを読み込んでください。
並び順が未定義の場合、ポップファインドの並び順は「不定」となります。
内容は、sitesearchSortOrder という変数に、各値がハッシュになる配列を代入しているファイルになります。
コンポーネントや URL パラメータでソート順を指定しない場合、ハッシュの先頭のエントリで並び替えをします。
記述例
var sitesearchSortOrder = [
{"label":"一致順", "order":"wordweight:desc"},
{"label":"タイトル順", "order":"title:asc"}
];
ハッシュは次のエントリを含みます。
- label: sortOrderSelectorコンポーネントで表示される表示用文字列
- order: 実際に適用される並び順
- 並び順のキーと asc (昇順) / desc (降順) をコロン (:) で連結した文字列
- 並び順のキーは文字列として比較されるものと、数値として比較されるものがあります。
// 並び順 (昇順)
[キー]:asc
もしくは
// 並び順 (降順)
[キー]:desc
また、複数キーによる並び順を定義する場合、カンマ (,) で連結して記述します。最大 10 個まで可能です。
[キー]:asc,[キー]:desc
指定可能な並び順のキー¶
指定可能な並び順のキーを以下に示します。
並び順のキーには大きく分けて、商品データに含まれた値と、商品データには含まれず、ポップファインドサービスが自動的に生成する値の 2 種類があります。
自動的に生成するものに関しては、データ作成者やサイト管理者による制御はできかねます。
また、有償オプションのご契約が必要となるキーもあります。
クロールされたデータに含まれるもの¶
キー名 | 比較 | 備考 |
---|---|---|
id | 文字列 | コンテンツID。通常URLと同一 |
title | 文字列 | コンテンツのタイトル |
summary | 文字列 | コンテンツの概要 |
link | 文字列 | コンテンツURL |
thumbnail | 文字列 | コンテンツの画像 |
filetype | 文字列 | 取得したコンテンツの種別 |
filesize | 数値 | 取得したコンテンツのサイズ |
domain | 文字列 | 取得したコンテンツのドメイン |
path | 文字列 | 取得したコンテンツのパス |
last_modified | 数値 | 取得したコンテンツの最終更新日 |
text | 文字列 | 表示用文字列 |
sort | 数値 | ソート専用フィールド |
additional_textN | 文字列 | 汎用文字列N(Nは1から10) |
additional_linkN | 文字列 | 汎用リンクN(Nは1から3) |
additional_sortN | 数値 | 汎用ソートキーN(Nは1から10) |
クロールされたデータに含まれないもの (自動生成されるもの)¶
キー | 比較 | 備考 |
---|---|---|
wordweight | 数値 | 検索されたキーワードとの適合度 |
clickweight | 数値 | 検索結果のクリック数 |
item_scoreN | 数値 | 外部サービスと連携することで得られる各商品の値(1 から N まで) オプションご契約時のみ有効 |
wordscore1 | 数値 | 管理画面で「表示順位制御」機能を使用した際に発動する並び順 降順指定のみ有効 |
wordscore9 | 数値 | 検索されたキーワードと単語の完全一致により算出される並び順 降順指定のみ有効 |
score | 数値 | 当社独自アルゴリズムで計算される並び順 降順指定のみ有効 mode が ec あるいは cp では使用できない |
情報
item_scoreN の実際に指定するキーは、オプションご契約後にご連絡いたします。
標準的な並び順¶
標準的な並び順としたい場合、以下の値を設定してください。
wordscore1:desc,wordweight:desc,clickweight:desc,wordscore9:desc
メッセージリソースファイル¶
メッセージリソースファイルは、ポップファインドで表示する文言を設定するファイルです
sitesearchMessage という変数に、ハッシュを代入しているファイルを作成します
ハッシュの内容は、コンポーネント名を第一階層、キー名を第二階層とし、変更する内容を値として指定します。
変更したい箇所だけを変数定義することで、
上書きすることが可能です。
例えば、並び順変更コンポーネントのメッセージを変更したい場合、
以下のような変更する内容を差分のみ記述したファイルを作成します。
var sitesearchMessage = {
"sortOrderSelector": {
"label":"変更したメッセージ"
}
};
具体的な変更方法は「応用編:表示メッセージの変更」も参照ください。
コンポーネント名 | キー名 | デフォルト | 説明 |
---|---|---|---|
attributes | labelSuffix | の絞り込み | 絞り込みコンポーネントのラベルとしてグループ名の後ろに付く |
attributes | selectAllPrefix | すべての | 絞り込みコンポーネントのラジオボタン/プルダウン表示時の全選択時のラベル |
sortOrderSelector | label | 並び順: | 並び順変更コンポーネントのラベル |
countSelector | label | 表示件数: | 表示件数変更コンポーネントのラベル |
countSelector | suffix | 件 | 表示件数コンポーネントで表示件数の後ろに表示 |
groupingSelector | label | グループ表示: | グループ表示変更コンポーネントのラベル |
groupingSelector | group | する | グループ表示変更コンポーネントのグループ表示する選択肢 |
groupingSelector | noGroup | しない | グループ表示変更コンポーネントのグループ表示しない選択肢 |
searchStatus | status | 全%1$s件を表示 | 検索ステータスコンポーネントの表示内容。%1$sにはヒット件数が入る |
searchStatus | noKeyword | 検索ワードを入れてください | 検索ワードが空のとき ※設定パラメータ「allowEmptyKeywordSearch」が falseのときのみ有効 |
searchStatus | groupstatus | 全%1$sアイテム(%2$sSKU)を表示 | 検索ステータスコンポーネントのグループ検索の表示内容。%1$sにはグループ時のヒット件数、%2$sにヒットしたレコード数が入る |
searchStatusFull | keyword_hits | 「%keyword%」検索結果 %countstart%-%countend% / %totalhits% | 検索キーワードあり、ヒット件数1件以上の際の表示 |
searchStatusFull | keyword_nohits | 「%keyword%」検索結果 0件 | 検索キーワードあり、ヒット件数0件の際の表示 |
searchStatusFull | nokeyword_hits | 検索結果 %countstart%-%countend% / %totalhits% | 検索キーワードなし、ヒット件数1件以上の際の表示 |
searchStatusFull | nokeyword_nohits | 検索結果 0件 | 検索キーワードなし、ヒット件数0件の際の表示 |
searchStatusFull | keyword_hits_grouping | 「%keyword%」 検索結果 %countstart%-%countend% / %grouplhits%(%totalhits% SKU) | グループ検索時、検索キーワードあり、ヒット件数1件以上の際の表示 |
searchStatusFull | keyword_nohits_grouping | 「%keyword%」検索結果 0件 | グループ検索時、検索キーワードあり、ヒット件数0件の際の表示 |
searchStatusFull | nokeyword_hits_grouping | 検索結果 %countstart%-%countend% / %grouplhits%(%totalhits% SKU) | グループ検索時、検索キーワードなし、ヒット件数1件以上の際の表示 |
searchStatusFull | nokeyword_nohits_grouping | 検索結果 0件 | グループ検索時、検索キーワードなし、ヒット件数0件の際の表示 |
searchStatusFull | noKeyword | 検索ワードを入力してください。 | 検索ワードが空のとき ※設定パラメータ「allowEmptyKeywordSearch」が falseのときのみ有効 |
searchResults | pricePrefix | 結果表示コンポーネントでpriceを表示した場合に前に表示 | |
searchResults | priceSuffix | 円 | 結果表示コンポーネントでpriceを表示した場合に後ろに表示 |
searchResults | numericNPrefix | レイアウトとして numericN を表示する際に前に表示 (Nは1から5) |
|
searchResults | numericNSuffix | レイアウトとして numericN を表示する際に後ろに表示 (Nは1から5) |
|
searchResults | addItemList | 比較する | 結果表示コンポーネントでadd_item_listを表示した際のラベル |
searchResults | itemListLimit | これ以上追加できません | 結果表示コンポーネントでadd_item_listを表示した際に追加不可を表すメッセージ |
searchResults | lastModifiedPrefix | 最終更新日: | 結果表示コンポーネントでlast_modifiedを表示した場合に前に表示 |
searchResults | filesizePrefix | ファイルサイズ: | 結果表示コンポーネントでfilesizeを表示した場合に前に表示 |
searchResults | extra | 追加で見る | 追加で見るボタンに表示されるラベル |
modal | status | 全%1$s件がヒット | モーダルコンポーネントのヘッダーの内容。%1$sにはヒット件数が入る |
modal | groupstatus | 全%1$sアイテム(%2$sSKU)を表示 | グループ検索時のモーダルコンポーネントのヘッダの内容。 %1$s にはグルーピング時のヒット件数、%2$s には非グルーピング時のヒット件数が入る |
modal | open | 詳細 | モーダルコンポーネントを開くボタンの文字列 |
modal | close | × | モーダルコンポーネントを閉じるボタンの文字列 |
modal | submit | 更新 | モーダルコンポーネント内での更新ボタンの文字列 |
recommendlinks | label | おすすめリンク | おすすめリンクコンポーネントで表示されるグループのラベル(ラベル未指定時) |
pagenator | firstPage | <<最初へ | ページ番号変更コンポーネントへ最初のページへ遷移するリンクのテキスト |
pagenator | prevPage | <<前へ | ページ番号変更コンポーネントへ前のページへ遷移するリンクのテキスト |
pagenator | nextPage | 次へ>> | ページ番号変更コンポーネントへ次のページへ遷移するリンクのテキスト |
checkedItems | label | 最近チェックした商品 | チェック履歴コンポーネントのラベル |
checkedItems | clear | 履歴をクリア | チェック履歴コンポーネントでチェックした商品をクリアするリンクのテキスト |
checkedItems | noItems | 最近チェックした商品はありません | チェック履歴コンポーネントで商品が1件も存在しない場合に表示されるテキスト |
lastModifiedSelector | label | 最終更新日: | 最終更新日絞り込みコンポーネントのラベル |
lastModifiedSelector | selectAll | すべての期間 | 最終更新日絞り込みコンポーネントで絞り込み解除に使用されるテキスト |
lastModifiedSelector | FROM_NOW-1 | 1日以内 | 最終更新日絞り込みコンポーネントの標準絞り込み候補「1日以内」で使用されるテキスト |
lastModifiedSelector | FROM_NOW-7 | 7日以内 | 最終更新日絞り込みコンポーネントの標準絞り込み候補「7日以内」で使用されるテキスト |
lastModifiedSelector | FROM_NOW-30 | 30日以内 | 最終更新日絞り込みコンポーネントの標準絞り込み候補「30日以内」で使用されるテキスト |
属性リソースファイル¶
属性リソースファイルは、絞り込み用のグループとそれに所属する属性や名称を定義し、
属性絞り込みコンポーネントで使用する為のファイルです。
属性絞り込みを行わない場合は、このファイルを作成、読み込みする必要はありません。
sitesearchAttributes という変数に、各値がハッシュになる配列を代入しているファイルを作成します。
注意
グループ名には次の文字列を含めることができません。
>
,
:
属性値には次の文字列を含めることができません。
>
,
以下にファイル例を示します
var sitesearchAttribute = [
{
group: {"label": "絞り込みグループ1", "name":"group1"},
attributes: [
{"label":"属性1", "name":"ATTRIBUTE1", "sub_groups":["sub_ATTRIBUTE1"]},
{"label":"属性2", "name":"ATTRIBUTE2"}
]
},
{
group: {"label": "絞り込みグループ2", "name":"group2"},
attributes: [
{"label":"属性3", "name":"ATTRIBUTE3", "class":"attr_red"},
{"label":"属性4", "name":"ATTRIBUTE4", "class":"attr_blue"},
{"label":"属性5", "name":"ATTRIBUTE5", "class":"attr_white"}
],
type: "type2"
},
{
group: {"label": "絞り込みグループ1の子", "name":"sub_ATTRIBUTE1"},
attributes: [
{"label":"属性1-1", "name":"ATTRIBUTE1-1"},
{"label":"属性1-2", "name":"ATTRIBUTE1-2"},
{"label":"属性1-3", "name":"ATTRIBUTE1-3"}
]
}
];
各値となるハッシュは次のエントリを含みます
親要素 | 子要素 | 型 | デフォルト値 | 説明 |
---|---|---|---|---|
group | ハッシュ | 省略不可 | 属性絞り込みを行うグループの単位、同グループ間は OR 検索、異なるグループ間は AND 検索になる 以下のメンバーを持つ |
|
label | 文字列 | '' | 属性絞り込みコンポーネントで表示されるグループ名 | |
name | 文字列 | 省略不可 | 属性絞り込みコンポーネントを呼び出す際のコンポーネント識別子の値の一部となる。URL パラメータにも使用される | |
attributes | 配列 | 省略不可 | グループに所属する属性を持つ配列 配列の値は以下のメンバーを持つハッシュ |
|
label | 文字列 | '' | 属性絞り込みコンポーネントで表示される属性名 | |
name | 文字列 | 必須 | TSV で定義した属性を示す値。refinements を使用する場合は項目の識別子 | |
refinements | 配列 | undefined | この値はオプションとなる。この値が指定された場合、name の代わりにこのリストに基づいた絞り込み条件が使用される | |
class | 文字列 | undefined | この値はオプションとなる。この値が指定された場合、各属性ごとの表示時に生成される要素のクラス名が、自動生成される文字列の代わりにこの値が使用される | |
sub_groups | 配列 | undefined | この値はオプションとなる。この値が指定された場合、画面上でこの属性が選択された場合に、指定された子グループが表示される | |
type | 文字列 | 'type1' | この値はオプションとなる。有効な値が指定された場合、表示バリエーションが変更される | |
show_all_count | 真偽値 | true | この値はオプションとなる。false が指定された場合、択一式となる表示バリエーションでの「すべての ○○」という全選択を示す選択肢において、ヒット件数を表示しない |
おすすめリンクリソースファイル¶
おすすめリンクリソースファイルは、おすすめリンク UID、表示・絞り込み条件を指定したグループを定義し、おすすめリンクコンポーネントを用いておすすめリンクを表示する為のファイルです。
おすすめリンク機能を使用しない場合、このファイルを作成、読み込みする必要はありません。
sitesearchRecommend という変数に、各値がハッシュになる配列を代入しているファイルを作成します。
以下にファイル例を示します
var sitesearchRecommend = [
{
group: {name:"g1", label:"おすすめリンク1"},
recommend_id: "[おすすめリンク UID]",
type: "type2",
count:3,
layoutOrder: ["title", "image", "url"]
},
{
group: {name:"g2", label:"おすすめリンク2"},
recommend_id: "[おすすめリンク UID]",
count:1,
section: 'english'
}
];
各値となるハッシュは次のエントリを含みます※1
親要素 | 子要素 | 型 | デフォルト値 | 説明 |
---|---|---|---|---|
group | ハッシュ | おすすめリンクコンポーネントを表示するグループの単位 以下のメンバーを持つ |
||
label | 文字列 | おすすめリンクコンポーネントで表示される見出し | ||
name | 文字列 | おすすめリンクコンポーネントを呼び出す際のコンポーネント識別子の値の一部 | ||
recommend_id | 文字列 | 必須 ※2 | 使用するおすすめリンク UID | |
type | 文字列 | 'type1' | おすすめリンクの表示バリエーション type1 または type2 が指定可能 |
|
count | 数値 | 5 | 表示するおすすめリンクの最大表示数 | |
layoutOrder | 配列 | [] | 各レコード内で表示するレイアウト。指定可能な値は「データファイルリファレンス」で表示が可能とされているフィールド。未指定時にはデフォルト表示 | |
section | 文字列 | 出し分け用文字列を指定。指定された文字列でおすすめリンクが絞り込まれる |
補足
※1: 登録されたデータによって、特定のフィールドでの表示・絞り込みが出来ない場合があります。
※2: おすすめリンク UID が不明な場合はお問い合わせください
キーワードランキングリソースファイル¶
キーワードランキングリソースファイルは、キーワードランキング UID や表示条件を指定したグループを定義し、キーワードランキングコンポーネントを用いて検索キーワードを表示する為のファイルです。
keywordRankingResource という設定パラメータに本リソースの内容を渡します。
キーワードランキング機能を使用しない場合は、このファイルを作成、読み込みする必要はありません。
以下に例を示します
// キーワードランキング設定タグ
var popfindConf = popfindConf || {};
popfindConf["data-kwranking"] = {
uid: "[キーワードランキング UID]",
mode: "[モード]",
keywordRankingResource: [
{
group:{label:"注目ワード"},
count: 5,
}
]
};
各値となるハッシュは次のエントリを含みます
親要素 | 子要素 | 型 | デフォルト値 | 説明 |
---|---|---|---|---|
group | キーワードランキングコンポーネントを表示するグループの単位 以下のメンバーを持つ |
|||
label | 文字列 | キーワードランキングコンポーネントで表示される見出し | ||
name | 文字列 | キーワードランキングコンポーネントを識別子付きで呼び出す際のコンポーネント識別子の値の一部 | ||
kwranking_id | 文字列 | 使用するキーワードランキング UID。省略時は UID が使用される ※1 | ||
count | 数値 | 5 | 最大表示件数 上限値: 100 (ただしキーワードの総数を超える値を設定しても、総数分しか表示されません。) |
|
location | 文字列 | なし(現在の画面) | 表示されたキーワードを選択した際の遷移先 | |
param_name | 文字列 | クエリパラメータの設定に依存 | 遷移する際に付与する検索キーワードのパラメータ名 |
補足
※1: キーワードランキング UID が不明な場合はお問い合わせください。
関連キーワードリソースファイル¶
関連キーワードリソースファイルは、関連キーワードコンポーネントを用いて関連キーワードを表示する際に、
その振る舞いを変更する際に作成するファイルです。
関連キーワード機能を使用しない場合、標準の振る舞いで使用する場合は、このファイルを作成、読み込みする必要はありません。
sitesearchRelatedKeyword という変数に、各値がハッシュになる配列を代入しているファイルを作成します。
以下にファイル例を示します
var sitesearchRelatedKeyword = [
{
group: {label: "その他のキーワード", name: "group1"},
count: 5,
keepRefinements: true,
}
];
各値となるハッシュは次のエントリを含みます
親要素 | 子要素 | 型 | デフォルト値 | 説明 |
---|---|---|---|---|
group | 関連キーワードコンポーネントを表示するグループの単位 以下のメンバーを持つ |
|||
label | 文字列 | 関連キーワードコンポーネントで表示される見出し | ||
name | 文字列 | 必須 | 関連キーワードコンポーネントを呼び出す際のコンポーネント識別子の値の一部 | |
count | 数値 | 5 | 最大表示件数 | |
keepRefinements | 真偽値 | false | 表示された関連キーワードを選択した際に、現在の絞り込み条件を引き継ぐかどうかの指定。trueを指定した場合は引き継ぐ |
レコメンド(popwiz)リソースファイル¶
レコメンド(popwiz)リソースファイルは、表示するレコメンドの解析手法や表示件数を定義し、レコメンド(popwiz)コンポーネントを用いて表示する為のファイルです。
レコメンドの表示にはレコメンド機能オプションへのご契約が必要です。
レコメンド機能を使用しない場合、このファイルを作成、読み込みする必要はありません。
sitesearchPopwiz という変数に、各値がハッシュになる配列を代入しているリソースを作成します。
また、popwizResource という設定パラメータに本リソースの内容をそのまま渡すこともできます。
以下にリソース例を示します
var sitesearchPopwiz = [
{
group:{label:"おすすめ商品", name:"group1"},
popwiz_id: '.....',
layoutOrder: ['image','title'],
type: 'type1',
}
];
各値となるハッシュは次のエントリを含みます
親要素 | 子要素 | 型 | デフォルト値 | 説明 |
---|---|---|---|---|
group | ハッシュ | グループの単位 | ||
label | 文字列 | おすすめ商品 | 表示されるレコメンドのラベル | |
name | 文字列 | レコメンドコンポーネントを識別子付きで呼び出す際のコンポーネント識別子の値の一部 | ||
popwiz_id | 文字列 | 必須 | 問い合わせに使用する idを指定する。この項目が空の場合、動作しない | |
type | 文字列 | 'type1' | 表示のバリエーション type1: 縦型表示(縦にレコメンドアイテムが並ぶ) type2: 横型表示(横にレコメンドアイテムが並ぶ) |
|
layoutOrder | 配列 | ['image', 'title'] | 表示するレイアウト。指定可能なレイアウトは「layoutOrder で指定可能なレイアウト一覧」 | |
count | 数値 | 5 | 最大表示数 |
最終更新日リソースファイル¶
最終更新日リソースファイルは、最終更新日絞り込みコンポーネントにおいて、標準の機能ではなく、見た目や日付範囲のリストをカスタマイズしたグループを新たに定義し、利用する為のファイルです。
最終更新日絞り込み機能を使用しない場合、標準の見た目や日付範囲で使用する場合は、このファイルを作成、読み込みする必要はありません。
Warning
リソースファイルを読み込ませた場合、グループ名を省略した最終更新日絞り込みコンポーネントの利用には先頭のグループが使用されます
sitesearchLastModified という変数に、各値がハッシュになる配列を代入しているファイルを作成します。
以下にファイル例を示します
var sitesearchLastModified = [
{
group: {"label": "最終更新日の絞り込み(年)", "name":"g1"},
dateranges: [
{label: "2021年", from: "2021/01/01", to: "2021/12/31"},
{label: "2020年", from: "2020/01/01", to: "2020/12/31"},
{label: "2019年", from: "2019/01/01", to: "2019/12/31"},
]
},
{
group: {"label": "最終更新日の絞り込み(最近)", "name":"g2"},
type: 'type1s',
dateranges: [
{label: "3日以内", from: "NOW-3"},
{label: "15日以内", from: "NOW-15"},
{label: "30日以内", from: "NOW-30"}
]
},
];
各値となるハッシュは次のエントリを含みます
親要素 | 子要素 | 型 | デフォルト値 | 説明 |
---|---|---|---|---|
group | ハッシュ | 最終更新日絞り込みコンポーネントを表示するグループの単位 以下のメンバーを持つ |
||
label | 文字列 | 最終更新日絞り込みコンポーネントで表示される見出し | ||
name | 文字列 | 最終更新日絞り込みコンポーネントを呼び出す際のコンポーネント識別子の値の一部 | ||
type | 文字列 | 'type1' | 見た目のバリエーション。種類とその名称については「コンポーネントリファレンス」を参照 | |
dateranges | ハッシュ | [{ from: 'NOW-1' }, { from: 'NOW-7' }, { from: 'NOW-30' }] | 絞り込みに利用する日付範囲のリスト 以下のメンバーを持つ |
|
label | 文字列 | 日付範囲として表示される見出し | ||
from | 日時 (後述) | 日付指定の起点(日本標準時: JST) | ||
to | 日時 (後述) | 日付指定の終点(日本標準時: JST) |
日時で指定可能な値¶
from,to で指定可能な日時のフォーマットは
- YYYY/MM/DD (年月日)
- YYYY/MM/DD HH:MM:SS (年月日 時分秒)
または、予約キーワードとして
- NOW (現在時刻)
- NOW+N (現在時刻にN日を加算したもの)
- NOW-N (現在時刻にN日を減算したもの)
が利用できる
ハッシュタグリソースファイル¶
ハッシュタグリソースファイルは、ハッシュタグの表示条件や並び替え条件を指定し、ハッシュタグコンポーネントで使用するためのファイルです。
以下にリソース例を示します。
var popfindConf = popfindConf || {};
popfindConf['data-[モード]'] = {
uid: '[UID]',
mode: '[モード]',
hashtagResource: [
{
name: 'group1',
sort: [{ key: 'count', order: 'desc' }],
count: 5,
},
],
}
hashtagResource の要素¶
hashtagsResource には、次のパラメータを指定できます。
キー名 | 型 | デフォルト値 | 説明 |
---|---|---|---|
name | 文字列 | 'default' | ハッシュタグコンポーネントを識別子付きで呼び出す際のコンポーネント識別子の値の一部となる。URL パラメータにも使用される。 |
sort | 配列 | [{ key: “count”, order: “desc” }] | ハッシュタグの並び順を指定する。 指定方法は「並び順の指定と指定可能な値」を参照。 |
count | 数値 | 5 | ハッシュタグの最大表示件数(ただしハッシュタグの総数を超える値を設定しても、総数分しか表示されない)。 |
location | 文字列 | '' | ハッシュタグをクリックした際の遷移先 URL。未指定の場合は、遷移しない。 |
newTab | 真偽値 | false | クリック時に新しいタブで遷移するかどうかを指定する。true の場合、新しいタブで遷移する。 |
operator | 'AND' または 'OR' | 'AND' | 複数のハッシュタグを選択した際の検索の挙動を指定する 'AND' の場合、ハッシュタグは AND 検索、'OR' の場合は、 OR 検索として実行される。 |
query | 絞り込み型 | undefined | ハッシュタグの絞り込み条件を指定する。設定可能なパラメータについては「絞り込み型で指定可能な値」を参照。 |
clickHook | 関数 | undefined | ハッシュタグをクリックした際に実行される関数を指定する。詳細は「clickHook」を参照。 |
itemId | 文字列 | undefined | コンテンツ URL を指定すると、そのコンテンツが持つハッシュタグを表示する。 |
並び順の指定と指定可能な値¶
sort パラメータを指定することで、ハッシュタグの並び順を指定できます。
並び順は配列に指定された順に決定されます。
sort: [
{ key: 'count', order: 'desc' },
{ key: 'key', order: 'asc' },
]
キー名 | 説明 |
---|---|
key | 並び順の基準となるキー。 |
order | ハッシュタグの順序を指定する。指定可能な値は asc (昇順)または desc (降順)。 |
key には、次の値を指定できます。
キー名 | 説明 |
---|---|
count | そのハッシュタグで絞り込まれた際のヒット件数で並ぶ。 |
key | ハッシュタグを ASCII 順で並ぶ。 |
絞り込み型で指定可能な値¶
query パラメータを指定することで、ハッシュタグを特定の条件に絞り込むことができます。
これにより、特定の商品・カテゴリに関連するハッシュタグのみを表示することができます。
実装例については、「特定の条件に絞り込んだハッシュタグを表示する」を参照してください。
query パラメータには、次のパラメータを指定できます。
キー名 | 型 | 説明 |
---|---|---|
_searchKeyword | 文字列 | キーワード検索対象フィールド全てへのフリーワード検索。 |
フィールド名 | フィールドの型に依る | フィールドに対しての検索。検索可能フィールドについては、お問い合わせください。 |
AND | 配列(複数の検索条件) | 検索条件のいずれも真になる時は真、それ以外は偽となる。 |
OR | 配列(複数の検索条件) | 検索条件のいずれかあるいは全てが真になる時は真、いずれも偽の時は偽となる。 |
NOT | 単体の検索条件 | 検索条件が真になる時は偽、それ以外は真となる。 |
補足
なお、検索条件直下の要素は、暗黙の AND が指定されているとみなします。