このセクションの記事

サイト内検索機能（Internal Site Search API 方式）

概要

お客様サイトで利用されているサイト内検索部分の多言語化は、WOVN.io の導入だけでは達成することができません。

WOVN では、サイト内検索の多言語化に特化した API（Internal Site Search API）を用意しています。
この API を利用することで、WOVN.io で翻訳している言語で Web サイト内コンテンツの検索を実現できます。

インフォメーション
この機能はオプションです。ご利用の際は カスタマーサポート までお問い合わせください。

インフォメーション
この API は、WOVN.io 上に保管されている翻訳データに対して検索を行う実装方法です。検索ベンターと WOVN の API を連携して、検索 DB 内のデータを多言語対応させる実装方法については、WOVN . api (Translation Sets API v2 ) with 検索ベンダー を参照してください。

目次

特徴

WOVN.io 上に保管されている翻訳データに対して検索を行います。
検索インデックスの更新も定期的に自動的に行われるため、自動コンテンツ追加機能 や 自動機械翻訳機能 とあわせて利用すれば、検索データを常に最新に保つことができます。

機能概要については Internal Site Search API 方式  も参照してください。

導入手順

検索機能の導入手順

  1. サイト内検索 API の呼び出し処理、および検索結果表示画面を作成します。
    検索結果表示画面 については、HTML や CSS でデザインの調整をしてください。

下記は、WOVN の Widget API (WOVN.io Javascript) を利用して作成した検索機能の例です。

See the Pen サイト内検索-1 by wovn-support (@Saki-Tamaru) on CodePen.

See the Pen サイト内検索-2 by wovn-support (@Saki-Tamaru) on CodePen.

「分類」を利用する場合、下記の例のように taxonomyName オプションを追加することで対応が可能です。

See the Pen サイト内検索-3 by wovn-support (@Saki-Tamaru) on CodePen.

注意
「分類」を利用する場合、プロジェクト上で「分類」設定を先に行ってください。（後述）

注意
'taxonomy value'　には、数字、文字列、数字配列、文字配列を利用できます。

  1. WOVN.io へログイン後、対象プロジェクトを選択します。

  2. 管理画面左側メニュー「設定」から、「サイト内検索」→「検索インデックス」 → 「インデックスを更新」を実行します。

  3. 上部メニュー「検索のテスト」から検索処理のテスト画面へアクセスし、目的のコンテンツが検索されたことを確認します。

技術仕様

フォーマット

検索結果には、次のデータが含まれます。

  • URL
  • ページタイトル
  • ハイライト:キーワードが見つかったコンテンツのセクション

```js

[ { "title": "API Test -WOVN.io HelpCenter", "url": "https://wovn-support.zendesk.com/hc/ja/articles/4492390577433-API-Test", "highlight": "WOVN.io HelpCenter \nPrivate category\nAh\nAPI Test -WOVN.io HelpCenter\n© 2022 Wovn Technologies" }, { "title": "Domain integration function -WOVN.io HelpCenter", "url": "https://wovn-support.zendesk.com/hc/ja/articles/360039851152-%E3%83%89%E3%83%A1%E3%82%A4%E3%83%B3%E7%B5%B1%E5%90%88%E6%A9%9F%E8%83%BD", "highlight": "layer such as\n/test/site/page.html\n, the domain integration function can still be used." }, ... ]

```

実装後の調整

検索処理の実装完了後、翻訳結果の品質を必要に応じて調整します。
検索結果が想定より多い場合、または少ない場合は、下記の調整を行ってください。

検索結果表示画面のデザイン調整

検索結果表示画面 については、サイトの HTML や CSS でのデザインの調整が必要です。

各ページの翻訳結果の調整

サイト内検索機能（サイト内検索 API）は、WOVN.io 経由で翻訳したテキストを直接検索します。
エンドユーザーの期待通りの検索結果を得るためには、ユーザーが検索に利用するキーワードと各ページの翻訳で使われているワードをなるべく一致させることが重要です。

対象ページの指定

WOVN.io で翻訳しているページのうち、一部のページのみが検索対象の場合は、「対象ページの指定」指定を行ってください。
指定がない場合、WOVN.io で翻訳している全てのページが検索の対象になります。

support-site-search-page-scope.png

  1. 管理画面左側メニュー「設定」から、「サイト内検索」→「ページ範囲」を開きます。
  2. 「特定のページのみ」のラジオボタンにチェックを入れ、検索対象をディレクトリ単位で指定します。

対象コンテンツの指定

検索対象の各ページの中で、検索対象に "したい" コンテンツと、検索対象に "したくない" コンテンツを指定します。
この指定がない場合、ページ内の全てのコンテンツが検索の対象となります。

  1. 管理画面左側メニュー「設定」から、「サイト内検索」→「コンテンツ範囲」を開きます。
  2. 検索対象に含めるコンテンツと含めないコンテンツ、それぞれを「コンテンツを追加」ボタンを押下して設定します。
    HTML の XPath 形式で入力します。

ページ分類の指定

Web サイトのメタデータを関連付けることで、検索結果のフィルタリングを行えます。
たとえば、記事ページのうち A というカテゴリのページは検索対象にする、B というカテゴリのページは検索対象にしない、といった設定が可能です。

よくあるご質問

スクリプト方式で導入していますが、サイト内検索機能（サイト内検索 API）を利用できますか？

はい、利用できます。
スクリプト方式 、 ライブラリ方式 、 プロキシ方式 、 WordPress プラグイン方式 のいずれかで導入済みであれば、問題なく利用できます。

導入事例はありますか？

当サイト（WOVN.io  ヘルプセンター）のサイト内検索機能は本 API を利用して構築しており、英語のキーワードで検索頂けます。ぜひお試しください。

この記事は役に立ちましたか？
0人中0人がこの記事が役に立ったと言っています
ページの先頭へ戻る

関連記事