URL パラメータリファレンス¶

URL パラメータの一覧¶

ポップファインドで使用される URL パラメータの一覧とその意味は以下の通りです。

パラメータ名は設定により変更することができます。詳しくは、「設定パラメータリファレンス」を参照ください。

パラメータキー	パラメータ名	説明	デフォルト値	指定可能な文字種
searchKeyword	q	検索キーワード	なし	表示可能な文字列
resultPage	p	ページ番号	1	数値
resultCount	c	表示件数	resultCountList の先頭	数値
sortOrder	o	並び順	並び順リソースファイルに従う	後述
refinements	r	属性絞り込み条件	なし	後述
hashtag	ht	ハッシュタグ	なし	後述
refineOthers	ro	属性以外の絞り込み条件	なし	後述
charset	charset	変換元文字コード	なし	空文字,UTF-8,Shift_JIS,EUC-JP のいずれか
group	g	グループ表示	y	y,n のいずれか(グループ検索利用時のみ有効)

並び順パラメータの指定¶

並び順パラメータは、検索結果の並び順を指定するためのパラメータです。並び順パラメータが指定されていない場合、並び順リソースファイルで定義された並び順の先頭のものが適用されます。

並び順パラメータは、次のように指定します。

o=[並び順のキー]:[並び順の値],[並び順のキー]:[並び順の値],...

キー	説明	備考
並び順のキー	並び順の基準となる値	指定可能な並び順のキーについては「指定可能な並び順のキー」を参照。
並び順の値	昇順または降順	昇順の場合は asc 、降順の場合は desc を指定。

例として、wordscore1:desc,wordweight:desc,clickweight:desc,wordscore9:desc という並び順を指定する場合は、次のように指定します。

o=wordscore1:desc,wordweight:desc,clickweight:desc,wordscore9:desc

この並びが適応された場合、以下の順番で並び替えが行われ、検索結果が表示されます。

管理画面で「表示順位制御」機能を使用した際に発動する並びの降順
検索されたキーワードとの適合度の降順
検索結果のクリック数の降順
検索されたキーワードと単語の完全一致により算出される並びの降順

属性絞り込み条件パラメータの指定¶

属性絞り込み条件パラメータは、検索結果を特定の属性値で絞り込むためのパラメータです。属性絞り込み条件パラメータが指定されていない場合、絞り込みは行われません。

属性絞り込み条件パラメータは、次のように指定します。

r=[グループ名]:[属性名],[グループ名]:[属性名],...

キー	説明	備考
グループ名	絞り込みグループ名	属性絞り込みリソースファイルに記述された絞り込みグループの name を指定。
属性名	絞り込み属性名	属性絞り込みリソースファイルに記述された属性の name を指定。

グループ名や属性名は、属性絞り込みリソースファイルで定義されたものを指定します。例として、以下のような属性絞り込みリソースファイルがあるとします。

var popfindAttribute = [
  {
    group: { label: '絞り込みグループ1', name: 'group1' },
    attributes: [
      {
        label: '属性1',
        name: 'ATTRIBUTE1',
      },
      {
        label: '属性2',
        name: 'ATTRIBUTE2',
        refinements: ['ATTRIBUTE2-1', 'ATTRIBUTE2-2'],
      },
    ],
  },
  {
    group: { label: '絞り込みグループ2', name: 'group2' },
    attributes: [
      {
        label: '属性3',
        name: 'ATTRIBUTE3',
      },
      {
        label: '属性4',
        name: 'ATTRIBUTE4',
      },
      {
        label: '属性5',
        name: 'ATTRIBUTE5',
      },
    ],
  },
]

絞り込みグループ 1 の属性 1 で絞り込む場合、次のようにグループ名として group1 、属性名として ATTRIBUTE1 を指定します。

r=group1:ATTRIBUTE1

絞り込みグループ 1 の属性 1 と属性 2 で絞り込む場合は、次のように指定します。

r=group1:ATTRIBUTE1,group1:ATTRIBUTE2

絞り込みグループ 1 の属性 1 と絞り込みグループ 2 の属性 3 で絞り込む場合は、次のように指定します。

r=group1:ATTRIBUTE1,group2:ATTRIBUTE3

属性絞り込みリソースファイルについては、「属性リソースファイルリファレンス」を参照ください。

ハッシュタグパラメータの指定¶

ハッシュタグパラメータは、検索結果を特定のハッシュタグで絞り込むためのパラメータです。ハッシュタグパラメータが指定されていない場合、ハッシュタグに合致する検索結果は表示されません。

ハッシュタグパラメータは、次のように指定します。

ht=[グループ名]:[検索条件](ハッシュタグ, ...),[グループ名]:[検索条件](ハッシュタグ, ...),...

キー	説明	備考
グループ名	ハッシュタグのグループ名	ハッシュタグリソースに記述されたハッシュの name を指定。
検索条件	同じグループのハッシュタグが選択された場合の検索条件（ AND 検索と OR 検索）	ハッシュタグリソースに記述されたハッシュの oparator の値が AND の場合は、 A を指定し、OR の場合は O を指定する。なお、 A の場合は、 AND 検索、O の場合は OR 検索を行う。
ハッシュタグ	絞り込みを行いたいハッシュタグ

例として、以下のようなハッシュタグリソースファイルがあるとします。

var popfindConf = popfindConf || {};
popfindConf['data-[モード]'] = {
  uid: '[UID]',
  mode: '[モード]',
  hashtagResource: [
    {
      name: 'group1',
      sort: [{ key: 'count', order: 'desc' }],
      count: 5,
      oparator: 'AND',
    },
    {
      name: 'group2',
      sort: [{ key: 'count', order: 'desc' }],
      count: 5,
      oparator: 'OR',
    },
  ],
}

また、 group1 により表示されたハッシュタグを HASHTAG1, HASHTAG2 とし、group2 により表示されたハッシュタグを HASHTAG3, HASHTAG4 とします。

HASHTAG1 を含む検索結果を表示する場合は、次のように指定します。

ht=group1:A(HASHTAG1)

HASHTAG1 と HASHTAG2 の両方に一致する検索結果を表示する場合は、次のように指定します。

ht=group1:A(HASHTAG1,HASHTAG2)

HASHTAG3 または HASHTAG4 を含む検索結果を表示する場合は、次のように指定します。

ht=group2:O(HASHTAG3,HASHTAG4)

HASHTAG1 と HASHTAG2 の両方を含み、かつ HASHTAG3 または HASHTAG4 を含む検索結果を表示する場合は、次のように指定します。

ht=group1:A(HASHTAG1,HASHTAG2),group2:O(HASHTAG3,HASHTAG4)

ハッシュタグリソースファイルについては、「ハッシュタグリソースファイルリファレンス」を参照ください。

属性以外の絞り込み条件パラメータの指定¶

本パラメータは製品のアップデートなどで将来的に内容が変更される可能性があります。
本パラメータの値を参照したカスタマイズなどは正しく動作しなくなる可能性があるので利用を控えてください。