Yahoo!検索プラグイン開発ツールを使った表示用プラグイン開発の流れ

こんにちは、検索開発部の西条です。
Yahoo!検索では4月13日にYahoo!検索プラグイン開発ツールをリリースしました。これによりどなたでも自由にYahoo!検索プラグインを開発することで、検索結果をカスタマイズできるようになりました。今回は開発ツールの中から、検索結果の表示内容をカスタマイズする表示用プラグインの開発の流れについて説明していきます。

■ 表示用プラグインの開発に必要なもの

それでは早速、開発ツールにアクセスしてみましょう（提供終了）。開発に必要なものはYahoo! JAPAN IDのみですべての開発はWeb上でできますので、ほかに準備するものはありません。もし自分で管理しているサイトをお持ちであれば、メタデータを埋め込むことによりご自身のサイトが検索結果に現れたときに表示内容をカスタマイズすることができます。メタデータの埋め込み方法については「Yahoo!検索プラグインとメタデータの埋め込み」も参考にしてください。

Yahoo!検索プラグイン開発ツール

■　表示用プラグインの開発

1. 基本情報の入力

まずは表示用プラグインの名称や説明、それから表示形式(標準型または展開型)を決めます。利用規約の同意も必要になりますので一読いただき、チェックを入れて次に進みます。

2. URL情報の入力

次にどのURLに対してプラグインを発動させるかを決めるためのURLマッチングパターンを入力します。検索結果に現れたサイトがここで指定したURLパターンにマッチすれば表示用プラグインが発動します。複数のURLマッチングパターンを設定することもできます。
表示用プラグインの動作結果をプレビューするためのテストURLを設定します。URLマッチングパターンから該当するURLを自動的に取得することができます。設定したテストURLの検索結果での表示結果がプレビュー領域に表示されますので、プレビューを見ながら開発、デバッグ作業ができます。
また、検索結果は画像を表示することができますが、表示用プラグインが発動したURLのドメインと異なる場合はここで画像取得ドメインを設定する必要があります。

表示用プラグインのプレビュー

3. データサービスの選択

表示用プラグインで使用するデータサービスを選択します。データサービスは表示用プラグインで使用できるデータの集まりで、ページのタイトルやサマリーなどYSTにインデックスされている基本的なデータ、RDFaやMicroformatsでマークアップされたデータ、YSTに直接フィードされたデータがあります。またこれ以外にもウェブページやAPIから取得したデータをデータサービスとして作成し使用することができます。

4. 表示の調整

ここで表示内容をカスタマイズしていきます。表示内容はPHPの連想配列に表示したい内容をデータサービスから選択して設定していきます。例えば[image]というキーには画像のURLを設定します。表示用プラグインでは一般的なPHP関数の一部が使えますので表示内容をより柔軟にカスタマイズすることもできます。表示用プラグインで使用できるPHPクラスと関数は「開発ガイド(Yahoo!検索プラグイン PHPホワイトリスト)」に記載しています。

表示の調整

5. 完了

これで表示用プラグインの開発が完了しました。これで表示用プラグインを実際の検索結果で使えますが、他の利用者からも利用できるように設定すると、公開用のURLが作られますので、それを共有することで他の利用者にも使ってもらうことができます。またプラグイン一覧への掲載を申請することもできます。

表示用プラグインの開発の流れを説明しましたが簡単に開発できることを見ていただけたと思います。今回は標準型プラグインの例を示しましたが、展開型プラグインは表示内容のレイアウトが決まっていませんのでさらに自由な検索結果を作ることができます。またデータサービスを独自で作ることにより、別のサイトから情報を取得して検索結果に表示することもできます。是非、Yahoo!検索プラグイン開発ツールを使って表示用プラグインの開発に挑戦してみてください。

Yahoo!デベロッパーネットワークには、上記以外にも開発者向けの情報を掲載しております。ご参照いただければ幸いです。

Yahoo!デベロッパーネットワークは こちら