Live Search API の使い方

[アーティクル]
05/27/2008

Live Search Web サービスアプリケーションプログラミングインターフェイス (API) バージョン 1.1 は、拡張マークアップ言語 (XML) によるWeb サービスです。このサービスを使用すると、開発者は、プログラミングによって Live Search エンジンにクエリを送信し、検索結果を取得することができます。

Live Search サービスの要件

Live Search Web サービスを使用するには、以下のリソースが必要です。

インターネット接続、簡易オブジェクトアクセスプロトコル (SOAP) 1.1 と Hyper Text Transfer Protocol (HTTP 1.1) を使用した要求の送信機能、および XML の解析機能を持つ展開用コンピュータ。
サンプルアプリケーションを構築し実行するコンピュータ上にインストールされた Microsoft Visual Studio 2005 および Microsoft .NET Framework (Version 2.0 以降)。

注意

SOAP パケットサイズを制限しているプロキシサーバーを経由して Live Search Web サービスが呼び出される場合は、サイズの大きい SOAP パケットの送受信で問題が生じる可能性があります。たとえば、多数の検索結果を返す Live Search Web サービスを呼び出すと、サイズの大きい SOAP パケットが送信されることがあります。その場合、プロキシをバイパスするか、SOAP パケットサイズの上限を非常に大きく設定するか、要求するデータ量を制限する必要があります。
Live Search Web サービスは、SOAP、XML、および WSDL の技術をベースにした標準に基づいています。このサービスは、.NET プラットフォームと、Windows、Web、およびコンソールアプリケーション開発用の Visual Studio .NET ツールを使用した環境でテスト済みです。その他の環境およびツールキットはテストされていませんが、Live Search Web サービスプラットフォームで使用できる場合があります。

Live Search Web サービス SOAP API へのアクセス

正式な Web サービス記述言語 (WSDL) XML ドキュメントは、Live Search Web サービスが使用するメッセージの形式を定義し、ソースコードで省略された場合にサービスが提供する既定値をいくつか定義します。サービス記述は、Live Search Web サービスの動作を定義し、および開発者がサービスとやり取りする方法を指示する取り決めです。開発プロジェクトで、SOAP API にアクセスするには、Live Search Web サービス WSDL を参照する必要があります。

たとえば、Microsoft Visual Studio 2005 から Live Search Web サービス WSDL にアクセスするには、次の手順に従って操作してください。

[ファイル] メニューの [新規] をポイントし、[プロジェクト] をクリックします。
[プロジェクトタイプ] のいずれか、たとえば [Visual C# プロジェクト] を選択します。
[テンプレート] 一覧から、Windows アプリケーション、ASP .NET アプリケーション、スマートデバイスアプリケーション、またはコンソールアプリケーションの新規作成を選択します。これらのプロジェクトタイプとテンプレートについては、今回のリリースでテスト済みですが、その他のプロジェクトタイプやテンプレートも、ここでの指示に従って正常に機能する場合があります。
[ソリューションエクスプローラ] タブで、[参照設定] を右クリックし、ポップアップメニューの [Web 参照の追加] を選択します。
URL のボックスに「https://soap.search.msn.com/webservices.asmx?wsdl」と入力します。
[移動] をクリックします。
[Web 参照名] ボックスに指定される既定の Web サービス名 com.msn.search.soap を使用するか、独自の名前をそのボックスに入力することができます。[参照の追加] をクリックして、Web 参照を自分のプロジェクトに追加します。

注意

自分のプロジェクトに選択した名前と、Web サービスに選択した名前を、Microsoft Visual C# で using ディレクティブとして追加する必要があります。たとえば、Windows アプリケーションプロジェクトに WindowsLiveSearchAPISample という名前を選択し、Web 参照名として WindowsLiveSearch という名前を選択した場合、宣言に次の行を追加します。
using WindowsLiveSearchAPISample.WindowsLiveSearch;

アプリケーションの事前設定

Web 参照をプロジェクトに追加したので、アプリケーションの開発を始めることができます。アプリケーションごとに、Developer Provisioning System が指定する固有のアプリケーション ID が必要です。

アプリケーション ID の新規作成

次の手順に従って、MSN Search Web サービスの Developer Provisioning System でアプリケーション ID を作成してください。

ブラウザから https://search.msn.com/developer にアクセスします。
[Create and Manage Application IDs] をクリックします。
自分の Windows Live ID でサインインします。Live ID がない場合は、[今すぐサインアップ] をクリックして、作成します。Developer Provisioning System を利用するには、Live ID の認証が必要です。
サインイン後、[Get a new App ID] をクリックして、自分のアプリケーション用の新しいアプリケーション ID を作成します。
アプリケーションにわかりやすい名前を付けて、[Application Name] ボックスに入力します。
使用条件を読み、同意するには、[I Accept] をクリックします。この使用条件に同意しない場合は、[I Do Not Accept] をクリックします。使用条件に同意しないことを選択した場合、ページ上に表示されるアプリケーション ID は有効にはなりません。
使用条件に同意してから、アプリケーション ID を選択して、コピーし、次の例に示すように、SearchRequest オブジェクトの AppID フィールドの値として、コード内に貼り付けます。
```
searchRequest.AppID = "B7E6E8142B4B81547C86B77161967D84882261A1";
```
注意

上記に示すサンプルの AppID の場所には、必ず Developer Provisioning System が提供する固有のアプリケーション ID を使用してください。

アプリケーション ID の管理

MSN Search Web サービスの Developer Provisioning System から取得したアプリケーション ID を編集、または削除するには、次の手順に従ってください。

ブラウザから https://search.msn.com/developer にアクセスします。
[Create and Manage Application IDs] をクリックします。
自分の Windows Live ID でサインインします。Developer Provisioning System を利用するには、Live ID の認証が必要です。
サインインすると、作成したアプリケーションがすべて [Applications] の一覧に表示されます。アプリケーションの名前を変更するには、その一覧の中のアプリケーション情報の右にある [Edit] リンクをクリックします。アプリケーションを編集するページが表示されます。[Application Name] ボックスにアプリケーションの新しい名前を入力して、[Save] をクリックします。アプリケーション名を編集しない場合は、[Cancel] をクリックします。
アプリケーション一覧からアプリケーションを削除するには、一覧の中のそのアプリケーション情報の右にある [Delete] リンクをクリックします。確認のメッセージボックスが表示されます。そのアプリケーションを削除することを確認し、[OK] をクリックして、一覧からアプリケーションを削除し、メッセージボックスを閉じます。アプリケーションを削除すると、削除されたアプリケーションに関連付けられたアプリケーション ID を使用するソースコードはすべて、このサービスを使用できなくなります。

Share via