パラメータリファレンス
パラメータとは
パラメータは、サジェスト設定タグに設定し、サジェストの動作をカスタマイズします。
指定が必要なパラメータと任意で設定するパラメータがあります。
パラメータは次の形式で指定します。
var poplink3 = {
パラメータ名1: パラメータ値1,
パラメータ名2: パラメータ値2,
:
パラメータ名n: パラメータ値n
};
パラメータの指定は、var poplink3 = { ... }; の中に配置してください。
パラメータ指定とパラメータ指定の間にはカンマを置いてください。
下記に例を示します。
// サジェスト設定タグ
var poplink3 = {
uid: "[UID]",
target: "#q",
deviceType: "pcia"
};
パラメータ名
パラメータの名前を指定します。指定可能な全てのパラメータは、「パラメータ一覧」を参照してください。
パラメータ値
パラメータに与える値の種類は次のいずれかです。
| 値の種類 |
説明 |
値の例 |
| 数値 |
数値を表します。半角の数字、正負の符号、小数点で表します。引用符や二重引用符で囲まないでください |
1234 |
| 真偽値 |
真または偽を表す値です。英小文字で true または false と指定してください。引用符や二重引用符で囲まないでください |
true
false |
| 文字列 |
引用符または二重引用符で囲んだ文字列。HTML タグなどを含めないでください |
"abc"
'abc' |
| 関数 |
JavaScriptの関数オブジェクトを指定します |
(省略) |
パラメータ一覧
activateHook
|
|
| データ型 |
関数オブジェクト |
| デフォルト |
なし |
| 説明 |
検索ボックスがフォーカスを得て、アクティブ状態にされたときに任意のプログラムを実行することができます。パラメータに関数オブジェクトを指定します。このパラメータの詳細は、「フックリファレンス」を参照してください。 |
| 用途 |
たとえば、スマートフォンでキーボードに隠れないようにするために、サジェストの起動時に、検索ボックスを画面上部にスクロールさせる等の用途が考えられます。 |
| 注意事項 |
このパラメータを使用した場合は、弊社からのサポートが提供されない場合があります。 |
closeImage
|
|
| データ型 |
文字列 |
| デフォルト |
"//poplink-f.probo.biz/pl3/images/close.png" |
| 説明 |
sphs,spia など、スマートフォン用のデバイスタイプで使われる、サジェストを閉じるボタンの画像を URL で指定します。 |
| 用途 |
閉じるボタンの画像を、サジェスト標準のものではなく、ユーザー側で用意した画像を使用する場合に指定します。 |
| 注意事項 |
このパラメータを使用した場合は、弊社からのサポートが提供されない場合があります。 |
deviceNameHook
|
|
| データ型 |
関数オブジェクト |
| デフォルト |
なし |
| 説明 |
デバイスの種類を決定します。deviceType パラメータに(文字列ではなく)オブジェクトを指定した場合にこのフックが呼び出されます。このパラメータの詳細は、「フックリファレンス」を参照してください。 |
| 用途 |
レスポンシブウェブデザインを採用したページにおいて、デバイスの判別ロジックがサジェストのものと異なるときに、このフックを使ってデバイスの種類を判別します。 |
| 注意事項 |
このパラメータを使用した場合は、弊社からのサポートが提供されない場合があります。 |
deviceType
|
|
| データ型 |
文字列(またはオブジェクト) |
| デフォルト |
"pc011" |
| 説明 |
デバイスタイプを指定します。レスポンシブウェブデザインに基づいたページに設置する場合にはオブジェクトで指定します。詳しくは、「レスポンシブウェブデザインを用いたページへの導入」を参照してください。 |
displayTarget
|
|
| データ型 |
文字列 |
| デフォルト |
なし |
| 説明 |
サジェストの要素の親となる要素を、CSSセレクタで指定します。指定しなかった場合には、targetパラメータで指定した検索ボックスの直後に挿入されます。 |
| 用途 |
デザイン上の都合で、検索ボックスとは離れた場所にサジェストを表示したい場合に使用します。 |
gaType
|
|
| データ型 |
文字列 |
| デフォルト |
なし |
| 説明 |
Googleアナリティクスの種類を指定します。
"ga4", "ga4_gtm", "gtag" (グローバルサイトタグ), "universal" (ユニバーサルアナリティクス) のいずれかを指定します。
詳しくは 「Googleアナリティクスを用いた計測」 を参照してください。 |
| 用途 |
Googleアナリティクスを用いてアクセス解析を行うときに使用します。 |
| 注意事項 |
GA4, ユニバーサルアナリティクス、グローバルサイトタグ以外の機能には対応していません。 |
id
|
|
| データ型 |
文字列 |
| デフォルト |
なし |
| 説明 |
サジェストの最上位の DOM 要素 (class="poplink" を持つ div 要素) に指定された文字列を値に持つ id 属性を設定します。 |
| 用途 |
複数のサジェストを 1 つのページに設置する場合に (必要に応じて) 使用します。この id 属性を CSS セレクタとして利用し、個々のサジェストに個別のスタイルを設定するのに利用できます。 |
inactivateHook
|
|
| データ型 |
関数オブジェクト |
| デフォルト |
なし |
| 説明 |
サジェストが非表示にされたときに任意のプログラムを実行することができます。パラメータに関数オブジェクトを指定します。このパラメータの詳細は、「フックリファレンス」を参照してください。 |
| 注意事項 |
このパラメータを使用した場合は、弊社からのサポートが提供されない場合があります |
loadCompleteHook
|
|
| データ型 |
関数オブジェクト |
| デフォルト |
なし |
| 説明 |
サジェストがロードされ、利用可能状態になったときに任意のプログラムを実行することができます。パラメータに関数オブジェクトを指定します。このパラメータの詳細は、「フックリファレンス」を参照してください。 |
| 注意事項 |
このパラメータを使用した場合は、弊社からのサポートが提供されない場合があります |
suggestAutoDisplay
|
|
| データ型 |
真偽値 |
| デフォルト |
false |
| 説明 |
true を指定した場合、エンドユーザーが検索ボックスにフォーカスした際にデフォルト表示キーワードを表示します。このキーワードは、過去の利用統計やデータ作成者による表示キーワード登録ファイルから自動生成されます |
| 用途 |
デフォルト表示キーワード機能を利用する際に使用します。 |
suggestAutoSubmit
|
|
| データ型 |
真偽値 |
| デフォルト |
false |
| 説明 |
true を指定した場合、候補語をクリックした場合、候補語を検索ボックスに転送したのち、検索ボックスが属するフォームをsubmitします。検索ボックスがFORM要素に属していない場合には何も起こりません。ページの構造によっては、suggestAutoSubmitではsubmitできない場合があります。その場合には、ページに合った方法でsubmitするフックスクリプトを作成し、suggestClickHookに設定してください。 |
| 用途 |
候補語をクリックすると同時に検索を実行する検索ボックスを作る際に使用します。この機能を用いると、Enterキーや「検索」ボタンを押す手間を省くことができます。この機能は主に、入力アシストのみを利用するデバイスタイプ (pcia および spia) とともに用いられます。 |
suggestClickHook
|
|
| データ型 |
関数オブジェクト |
| デフォルト |
なし |
| 説明 |
候補語がクリックされたときに任意のプログラムを実行することができます。パラメータに関数オブジェクトを指定します。このパラメータの詳細は、「フックリファレンス」を参照してください。 |
| 用途 |
たとえば、クリックされた候補語のデータをアクセス解析ツールへ送信するような用途が考えられます。 |
| 注意事項 |
このパラメータを使用した場合は、弊社からのサポートが提供されない場合があります。 |
suggestCount
|
|
| データ型 |
数値 |
| デフォルト |
5(注意:デバイスタイプによっては、これ以外の値を持つものがあります) |
| 説明 |
候補語を表示する最大数を指定します。数値は 1 から 20 までの範囲で指定できます。 |
| 用途 |
表示される候補語の数を変えるときに使用します。 |
suggestUpdateHook
|
|
| データ型 |
関数オブジェクト |
| デフォルト |
なし |
| 説明 |
候補語リストが更新されたときに任意のプログラムを実行することができます。パラメータに関数オブジェクトを指定します。このパラメータの詳細は、「フックリファレンス」を参照してください。 |
| 注意事項 |
このパラメータを使用した場合は、弊社からのサポートが提供されない場合があります。 |
target
|
|
| データ型 |
文字列 |
| デフォルト |
なし |
| 説明 |
検索ボックスの要素を CSS セレクタの書式で指定します。
たとえば、<inputid="q" type="text"/> という要素を指定するには、target パラメータに #q と指定します。(先頭の # は、ID を指定することを示します。) |
| 注意事項 |
このパラメータは、必ず指定しなければなりません。 |
uid
|
|
| データ型 |
文字列 |
| デフォルト |
なし |
| 説明 |
サービスの識別コード (UID) を指定します。UID は弊社よりお知らせいたします。 |
| 用途 |
このパラメータは、必ず指定しなければなりません。 |
useGATracking
非推奨
|
|
| データ型 |
真偽値 |
| デフォルト |
false |
| 説明 |
Google アナリティクスにサジェストのイベントを送信します。詳しくは、「Googleアナリティクスを用いた計測」を参照してください。 |
| 用途 |
Google アナリティクスを用いてアクセス解析を行うときに使用します。 |
| 注意事項 |
このパラメータは、gaTypeによって置き換えられました。引き続き利用可能ですが、今後は gaType を利用することを推奨します。ユニバーサルアナリティクス以外の機能には対応していません。 |
userStyleSheet
|
|
| データ型 |
文字列 |
| デフォルト |
なし |
| 説明 |
追加で読み込むスタイルシートの URL を指定します。サジェストの標準のスタイルシートを置き換えるのではなく、追加で読み込むことに注意してください。 |
| 用途 |
サジェストのスタイルを変更するときに使用します。 |
displayHistoryTrigger
|
|
| データ型 |
文字列 ('' または 'empty' または 'always') |
| デフォルト |
'' |
| 説明 |
入力履歴表示機能の表示モードを制御できます。
'': 入力履歴を表示しません。
'empty': 検索ボックスが空の時のみ表示します。
'always': 常に表示します。 |
| 用途 |
入力履歴の表示タイミングを変更したい場合に使用します。 |
inputHistoryCount
|
|
| データ型 |
数値 |
| デフォルト |
5 |
| 説明 |
入力履歴表示機能で表示する入力履歴の個数を制御できます。 |
| 用途 |
入力履歴の表示個数を変更したい場合に使用します。 |
inputHistoryCookieName
|
|
| データ型 |
文字列 |
| デフォルト |
'bst.ih.0' |
| 説明 |
入力履歴を保存する Cookie の名前を指定できます。 |
| 用途 |
入力履歴を保存する Cookie の名前を変更したい場合に使用します。 |
inputHistoryLifetime
|
|
| データ型 |
数値 |
| デフォルト |
2592000 |
| 説明 |
入力履歴を保存する Cookie の有効期限を指定できます。デフォルトは 30 日です。 |
| 用途 |
入力履歴を保存する Cookie の有効期限を変更したい場合に使用します。 |
deleteHistoryImage
|
|
| データ型 |
文字列 |
| デフォルト |
'close.png' |
| 説明 |
入力履歴の削除ボタンに使用する画像を指定できます。public な URL も指定可能です。 |
| 用途 |
入力履歴の削除ボタンに使用する画像を変更したい場合に使用します。 |
|
|
| データ型 |
文字列 |
| デフォルト |
null |
| 説明 |
入力履歴のヘッダーに表示するテキストを指定できます。null の場合、表示されません。 |
| 用途 |
入力履歴のヘッダーに表示するテキストを変更したい場合に使用します。 |
useCustomSuggestN
|
|
| データ型 |
真偽値 |
| デフォルト |
false |
| 説明 |
カスタムサジェスト機能を有効にします。 |
| 用途 |
カスタムサジェスト機能を有効にしたい場合に使用します。 |
customSuggestNCount
|
|
| データ型 |
数値 |
| デフォルト |
5 |
| 説明 |
カスタムサジェスト機能で表示するサジェストの個数を指定できます。Nには 1 ~ 3 を指定できます。 |
| 用途 |
カスタムサジェスト機能で表示するサジェストの個数を変更したい場合に使用します。 |
|
|
| データ型 |
文字列 |
| デフォルト |
null |
| 説明 |
カスタムサジェスト機能で表示するヘッダーのテキストを指定できます。null の場合、表示されません。Nには 1 ~ 3 を指定できます。 |
| 用途 |
カスタムサジェスト機能で表示するヘッダーのテキストを変更したい場合に使用します。 |
suggestSkipSelect
|
|
| データ型 |
真偽値 |
| デフォルト |
false |
| 説明 |
true の場合、候補語が 1 度目のクリックで検索ボックスに反映されるようになります。このパラメータは sp 系デバイスタイプで使用できます。 |
| 用途 |
候補語が 1 度目のクリックで検索ボックスに反映されるようにしたい場合に使用します。 |