クイックスタート:C# と Bing News Search REST API を使用してニュースを検索する

[アーティクル]
05/22/2020

警告

2020 年 10 月 30 日に、Bing Search API は Azure AI サービスから Bing Search サービスに移行されました。このドキュメントは、参考用としてのみ提供されています。更新されたドキュメントについては、Bing search API のドキュメントを参照してください。 Bing 検索用の新しい Azure リソースを作成する手順については、「Azure Marketplace から Bing Search リソースを作成する」を参照してください。

このクイックスタートを使用して、Bing News Search API を呼び出してみましょう。このシンプルな C# アプリケーションは、ニュース検索クエリを API に送信して JSON 応答を表示します。

このアプリケーションは C# で記述されていますが、この API はほとんどのプログラミング言語と互換性のある RESTful Web サービスです。

このサンプルのコード全体は、GitHub にあります。

前提条件

Visual Studio 2017 またはそれ以降の任意のエディション。
NuGet パッケージとして入手できる Json.NET フレームワーク。
Linux または MacOS を使用している場合、このアプリケーションは Mono を使用して実行できます。

Azure リソースを作成する

次のいずれかの Azure リソースを作成して、Bing News Search API の使用を開始します。

Bing Search v7 リソース

ご自身でリソースを削除するまでは Azure portal からご利用いただけます。
Free 価格レベルを使ってサービスを試用し、後から運用環境用の有料レベルにアップグレードします。

マルチサービスリソース

ご自身でリソースを削除するまでは Azure portal からご利用いただけます。
複数の Azure AI サービス全体で同じキーとエンドポイントをアプリケーションに使用します。

プロジェクトの作成と初期化

Visual Studio で、新しい C# コンソールソリューションを作成します。次に、メインコードファイルに次の名前空間を追加します。
```
using System;
using System.Text;
using System.Net;
using System.IO;
using System.Collections.Generic;
```
API エンドポイント、サブスクリプションキー、および検索用語の変数を作成します。次のコードのグローバルエンドポイントを使用するか、Azure portal に表示される、対象のリソースのカスタムサブドメインエンドポイントを使用することができます。
```
const string accessKey = "enter key here";
const string uriBase = "https://api.cognitive.microsoft.com/bing/v7.0/news/search";
const string searchTerm = "Microsoft";
```

Bing News Search 応答の書式を設定する構造体の作成

ニュースの検索結果と JSON ヘッダー情報を含む SearchResult 構造体を定義します。

struct SearchResult
{
    public String jsonResult;
    public Dictionary<String, String> relevantHeaders;
}

ニュース検索要求の作成と処理

API に対する呼び出しを実行するための BingNewsSearch() という名前のメソッドを作成し、前に作成した SearchResult 構造体に戻り値の型を設定します。

次の手順で、このメソッドにコードを追加します。
検索要求の URI を構築します。検索語句 toSearch は、書式を設定したうえで文字列に追加する必要があります。
```
static SearchResult BingNewsSearch(string toSearch){

    var uriQuery = uriBase + "?q=" + Uri.EscapeDataString(toSearch);
//...
```

Web 要求を実行し、応答を JSON 文字列として取得します。

WebRequest request = WebRequest.Create(uriQuery);
request.Headers["Ocp-Apim-Subscription-Key"] = subscriptionKey;
HttpWebResponse response = (HttpWebResponse)request.GetResponseAsync().Result;
string json = new StreamReader(response.GetResponseStream()).ReadToEnd();

検索結果オブジェクトを作成し、Bing HTTP ヘッダーを抽出します。次に searchResult を返します。

// Create the result object for return
var searchResult = new SearchResult()
{
    jsonResult = json,
    relevantHeaders = new Dictionary<String, String>()
};

// Extract Bing HTTP headers
foreach (String header in response.Headers)
{
    if (header.StartsWith("BingAPIs-") || header.StartsWith("X-MSEdge-"))
        searchResult.relevantHeaders[header] = response.Headers[header];
}
return searchResult;

応答の処理

メインメソッドで BingNewsSearch() を呼び出し、返された応答を格納します。次に、JSON をオブジェクトに逆シリアル化して、応答の値を表示できるようにします。

SearchResult result = BingNewsSearch(searchTerm);
//deserialize the JSON response
dynamic jsonObj = Newtonsoft.Json.JsonConvert.DeserializeObject(result.jsonResult);
Console.WriteLine(jsonObj["value"][0])

JSON の応答例

成功した応答は、次の例に示すように JSON で返されます。

{
   "_type": "News",
   "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/news\/search?q=Microsoft",
   "totalEstimatedMatches": 36,
   "sort": [
      {
         "name": "Best match",
         "id": "relevance",
         "isSelected": true,
         "url": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/news\/search?q=Microsoft"
      },
      {
         "name": "Most recent",
         "id": "date",
         "isSelected": false,
         "url": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/news\/search?q=Microsoft&sortby=date"
      }
   ],
   "value": [
      {
         "name": "Microsoft to open flagship London brick-and-mortar retail store",
         "url": "http:\/\/www.contoso.com\/article\/microsoft-to-open-flagshi...",
         "image": {
            "thumbnail": {
               "contentUrl": "https:\/\/www.bing.com\/th?id=ON.F9E4A49EC010417...",
               "width": 220,
               "height": 146
            }
         },
         "description": "After years of rumors about Microsoft opening a brick-and-mortar...", 
         "about": [
           {
             "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entiti...", 
             "name": "Microsoft"
           }, 
           {
             "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entit...", 
             "name": "London"
           }
         ], 
         "provider": [
           {
             "_type": "Organization", 
             "name": "Contoso"
           }
         ], 
          "datePublished": "2017-09-21T21:16:00.0000000Z", 
          "category": "ScienceAndTechnology"
      }, 

      . . .

      {
         "name": "Microsoft adds Availability Zones to its Azure cloud platform",
         "url": "https:\/\/contoso.com\/2017\/09\/21\/microsoft-adds-availability...",
         "image": {
            "thumbnail": {
               "contentUrl": "https:\/\/www.bing.com\/th?id=ON.0AE7595B9720...",
               "width": 700,
               "height": 466
            }
         },
         "description": "Microsoft has begun adding Availability Zones to its...",
         "about": [
            {
               "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entities\/a093e9b...",
               "name": "Microsoft"
            },
            {
               "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entities\/cf3abf7d-e379-...",
               "name": "Windows Azure"
            },
            {
               "readLink": "https:\/\/api.cognitive.microsoft.com\/api\/v7\/entities\/9cdd061c-1fae-d0...",
               "name": "Cloud"
            }
         ],
         "provider": [
            {
               "_type": "Organization",
               "name": "Contoso"
            }
         ],
         "datePublished": "2017-09-21T09:01:00.0000000Z",
         "category": "ScienceAndTechnology"
      }
   ]
}

次のステップ

単一ページの Web アプリの作成

次の方法で共有

クイックスタート:C# と Bing News Search REST API を使用してニュースを検索する

前提条件

Azure リソースを作成する

プロジェクトの作成と初期化

Bing News Search 応答の書式を設定する構造体の作成

ニュース検索要求の作成と処理

応答の処理

JSON の応答例

次のステップ

その他のリソース

次の方法で共有

クイック スタート:C# と Bing News Search REST API を使用してニュースを検索する

前提条件

Azure リソースを作成する

プロジェクトの作成と初期化

Bing News Search 応答の書式を設定する構造体の作成

ニュース検索要求の作成と処理

応答の処理

JSON の応答例

次のステップ

その他のリソース

クイックスタート:C# と Bing News Search REST API を使用してニュースを検索する