構成ファイルを使用してプログラム可能検索エンジンを作成する

このページでは、プログラム可能検索エンジンの設定ファイルの基本概念について説明します。

  1. 概要
  2. プログラム可能検索エンジンとは
  3. コンポーネントの連携の仕組み
  4. 検索エンジンの作成
  5. プログラム可能検索エンジンのファイルの編集
  6. 適切なフォーマットを選択する

概要

コントロール パネルで必要なレベルのカスタマイズが不可能な場合は、プログラム可能な検索の XML 形式の使用を検討してください。XML 形式を使用すると、より詳細に管理でき、柔軟性が高く、より強力な機能を利用できます。

プログラム可能検索エンジンの設定ファイルを使用するには、まずプログラム可能検索エンジンのコントロール パネルを使用して基本的な検索エンジンを作成します。検索エンジンを作成したら、コントロール パネルの [概要] ページからアノテーションとコンテキスト XML ファイルをダウンロードできます。

XML の基本

XML（拡張マークアップ言語）は汎用のマークアップ言語です。読み上げ可能なタグの付いたテキストです。たとえば、プログラム可能検索の XML 形式には <Context> </Context> タグと <LookAndFeel> </LookAndFeel> タグが含まれます。

他の XML ファイルと同様に、プログラム可能検索エンジンの仕様は、XML 構文（<element attribute="value">content</element>）に従い、正しい形式である必要があります。XML には次のルールがあります。

  • XML の場合、トップレベルのタグの前に XML 宣言（<?xml version="1.0"?>）を付ける必要がありますが、プログラム可能検索エンジンの設定ファイルではそれを必要としません。
  • すべての要素には、開始タグ（<tag>）と終了タグ（</tag>）が必要です。
  • すべてのタグを正しくネストする必要があります。<sandwich><filling> peanut butter</sandwich></filling> のような XML コードは使用できません。代わりに <sandwich><filling> peanut butter</filling></sandwich> のようにします。
  • XML では大文字と小文字が区別されるため、手順ではタグの大文字と小文字の使い方とスペルに注意して正しいものを使用してください。
  • 属性値はすべて二重引用符（<element attribute="value">）で囲む必要があります。
  • すべての属性は、終了タグ（</element>）ではなく開始タグ（<element attribute="value">）で定義する必要があります。

コメントタグ（<!-- your comment here -->）を使用してメモを自分で作成することができます。プログラム可能検索エンジンでは、そのテキスト行は XML コードとして解析されません。リマインダーや説明を記述するだけでなく、コメントを使用して一時的に XML コードの一部を無効にすることもできます（たとえば、特定の効果をテストする場合や、問題をトラブルシューティングする場合など）。ただし、コントロール パネルからダウンロードするファイルには、これらのコメントは保持されません。コメントを残したい場合は、コメントをした XML ファイルをコントロール パネルにアップロードした後も、コピーを保存しておく必要があります。

シンプルなテキスト エディタを使用して、XML ファイルを作成、編集できます。テキスト ファイルを .xml 拡張子で保存するだけです（例: cse_badminton.xml）。

トップへ戻る

プログラム可能検索エンジンとは

プログラム可能検索エンジンには、主に 2 つのコンポーネントがあり、それぞれが XML ファイルで制御されます。

  • コンテキスト: コンテキスト XML ファイルには、検索エンジンの基本機能を記述します。検索エンジンの全般設定（画像検索やプロモーションを有効にするかどうかなど）を指定します。検索エンジンごとに、独自のコンテキスト ファイルがあります。コンテキスト XML ファイルの詳細検索エンジンに最適なファイル形式を選択する方法について詳しくは、検索エンジンに適した形式の選択をご覧ください。
  • アノテーション: アノテーションの XML ファイルには、検索エンジンで検索したいウェブページやウェブサイトのリストと、検索結果でこれらのサイトの掲載順位を決定するオプションを指定します。各サイトとその関連情報はアノテーションと呼ばれます。アノテーション XML ファイルの詳細。

これらのファイルをゼロから作成することはおすすめしません。代わりに、コントロール パネルの [概要] ページからダウンロードしてください。

上記の主要コンポーネントに加えて、検索エンジンには以下の補助ファイルも使用できます。

  • プロモーション: プロモーション XML ファイルには、事前に定義された一連の検索語句によってトリガーされる一連のカスタム検索結果が記載されています。ユーザーが検索クエリと完全に一致する検索語句を入力すると、ページの上部にプロモーションが表示されます。プロモーションを使用すると、ユーザーの検索語句に直接答えたり、重要な情報を参照したり、検索結果の一番上には表示されていないものの特に関連性のあるウェブページに誘導したりできます。プロモーションは、コントロール パネルの [プロモーション] タブで定義します。プロモーションの詳細
  • 類義語: 類義語 XML ファイルを使用すると、ユーザーのクエリを拡張して、検索キーワードのパターンが含まれるようになります。たとえば、ユーザーが「simian」を検索すると、検索エンジンは「monkey」と「ape」も検索します。コントロール パネルの [類義語] タブでは、類義語を定義します。類義語の詳細については、こちらをご覧ください。

コンポーネントの連携の仕組み

コンテキスト XML ファイルでは、使用するアノテーション ファイルを指定せず、アノテーション XML はコンテキスト ファイルを参照しません。プログラム可能検索エンジンでは、ラベルを使用してコンテキストとアノテーションを関連付けます。コンテキスト XML ファイルには検索エンジンを識別するラベルが含まれ、アノテーション XML にリストされる各アノテーションには、それが属する検索エンジンを識別する 1 つ以上のラベルがタグ付けされます。コンテキスト ファイルのラベル名を変更する場合は、そのラベルでタグ付けされたすべてのアノテーションを変更する必要があります。

複数のアノテーション ファイルをアップロードすることもできますが、コントロール パネルからダウンロードすると、プログラム可能検索エンジンによってすべてのアノテーション ファイルが 1 つのアノテーション ファイルに統合されます。アノテーション ファイルを使用すると、同じサイトをさまざまな検索エンジン用に柔軟にカスタマイズできます。たとえば、検索エンジンによって検索を一部のサイトに制限したり、別の検索エンジンでそれらのサイトを除外したり、別の検索エンジンでそれらのサイトを宣伝したりする可能性があります。

context.xml

次に、適用先の検索エンジンを識別するラベルを含む context.xml ファイルの例を示します。

<BackgroundLabels>
  <Label name="_include_" mode="FILTER"/>
  <Label name="_exclude_" mode="ELIMINATE"/>
<BackgroundLabels>

annotations.xml

以下に、各サイト（アノテーション）とラベルの関連付けを示すアノテーション ファイルの例を示します。

<Annotation about="code.google.com/*" score="1">
  <Label name="_include_"/>
</Annotation>

トップへ戻る

高度なプログラム可能検索エンジンの作成

高度なエンジンを作成する手順は次のとおりです。

  1. ニーズに適した 形式を決定します。
  2. 検索エンジンの仕様を定義します。
  3. プログラム可能検索エンジンで検索するサイトを指定する。
  4. プログラム可能検索エンジンに検索結果のランキング方法を指定する。

プログラム可能検索エンジンのファイルの編集

XML ファイルで作業するには、コントロール パネルの [概要] ページから XML 仕様をダウンロードします。ファイルを最初から作成しないでください。手順は次のとおりです。

  1. コントロール パネルの [概要] ページからコンテキスト ファイルまたはアノテーション ファイルをダウンロードします。[検索機能] セクションの [ダウンロード] ボタンをクリックします。
  2. UNIX スタイルの改行を処理できるテキスト エディタを使用します（WordPad、Emacs、TextMate は動作しますが、NotePad は動作しません）。ファイル拡張子 .xml（例: cx_global.xml）で保存していれば、どのような名前を付けるかは問いません。
  3. 編集したバージョンが想定どおりに機能せず、以前のバージョンに戻す必要がある場合は、ダウンロードしたファイルのバックアップ コピーを作成してください。

    コピーを作成せず、編集したバージョンが正しく動作しない場合は、ファイルをデバッグするか、検索エンジンを最初から作成し直す必要があります。楽しくありません。

  4. XML ファイルを編集して保存します。テキスト エディタでファイルを Unicode テキスト ドキュメントとして保存し、他のファイル形式で保存していないことを確認してください。
  5. [概要] ページの [検索機能] セクションでファイルをアップロードします。

適切なフォーマットを選択する

プログラム可能検索エンジンの作成を始める前に、ニーズに最適なフォーマットを決めましょう。必要以上にパワフルで複雑なフォーマットはおすすめしません。また、すぐに成長できないフォーマットを使用したいとも考えません。

次の表を参考に、適切な形式を選択してください。

作成方法 使用 ～であるため 制限事項 詳細
サイト数が少ない 1 つまたは複数の検索エンジン コントロール パネル テキスト エディタでファイルを作成してアップロードする代わりに、テキスト ボックスに入力するだけでプログラム可能検索エンジンを簡単に作成できます。 コントロール パネルは、主にプログラム可能検索エンジンの知識や、サイトの数が少ない検索エンジンの作成に慣れるのに役立ちます。 スタートガイド
多数のサイトを使用する、フィードを使用する複雑な検索エンジン コンテキスト ファイルとアノテーション ファイル

プログラム可能検索エンジンのファイルを使用すると、検索エンジンをより詳細に制御でき、サイトの定義と管理のタスクがはるかに容易になります。

コンテキスト ファイルとアノテーション ファイルを使用して検索エンジンを作成する予定であっても、コントロール パネルについてよく理解しておくことをおすすめします。

 検索エンジンをカスタマイズすればするほど、複雑さは増します。プログラム可能検索の要素と属性について簡単に学ぶ必要がありますが、時間をかける必要があります。

デベロッパー ガイドの残りの部分をお読みください。残念ながら、特に興味深い参考資料ではありません。

 コンテキスト: 検索エンジンの仕様の定義、アノテーション: サイトの選択

トップへ戻る