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

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

警告

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

このクイックスタートを使用して、Bing Video Search API を呼び出してみましょう。このシンプルな C# アプリケーションでは、HTTP 動画検索クエリを API に送信し、その JSON 応答を表示します。このアプリケーションは C# で記述されていますが、この API はほとんどのプログラミング言語と互換性のある RESTful Web サービスです。

このサンプルのソースコードは、追加のエラー処理と機能、コードの注釈を含め、GitHub で入手できます。

前提条件

お使いのコンピューターを、.NET Core が実行されるように設定する必要があります。インストールの手順については、.NET Core のダウンロードページを参照してください。このアプリケーションは、Windows、Linux、macOS 上、または Docker コンテナーで実行できます。お好みのコードエディターをインストールしてください。次の説明では、オープンソースのクロスプラットフォームエディターである Visual Studio Code を使用しています。しかし、他の使い慣れたツールを使用しても構いません。

Azure リソースを作成する

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

Bing Search v7 リソース

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

マルチサービスリソース

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

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

最初に新しいアプリケーションを作成します。コマンドプロンプトを開き、アプリケーション用の新しいディレクトリを作成します。それを、現在のディレクトリとしてください。コンソールウィンドウに次のコマンドを入力します。

dotnet new console --name VideoSearchClient

次の using ディレクティブを Main メソッドの先頭に追加して、C# コンパイラによって Task と JSON の型が認識されるようにする必要があります。

using System;
using System.Net.Http;
using System.Threading.Tasks;
using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Serialization;

サブスクリプションキー、エンドポイント、検索語句の変数を追加します。 uriBase 値には、次のコードのグローバルエンドポイントを使用するか、Azure portal に表示される、お使いのリソースのカスタムサブドメインエンドポイントを使用できます。

// Replace the accessKey string value with your valid access key.
const string _accessKey = "enter your key here";

// Or use the custom subdomain endpoint displayed in the Azure portal for your resource.
const string _uriBase = "https://api.cognitive.microsoft.com/bing/v7.0/videos/search";

const string _searchTerm = "kittens";

次に、Main メソッドを更新して、Async メソッドを使用できるようにします。 async 修飾子を追加し、戻り値の型を Task に変更します。

static async Task Main(string[] args)
{
    
}

これで、何も実行しないが、非同期に実行するプログラムが用意できました。これを改善しましょう。

Bing Video Search API 応答が保持されるデータ構造を作成する

動画の検索結果が含まれる SearchResult と Video クラスを定義します。 JSON の結果から他のフィールドが必要な場合は、後でプロパティを追加することができます。

class SearchResult
{
    [JsonPropertyName("totalEstimatedMatches")]
    public int TotalEstimatedMatches { get; set; }

    [JsonPropertyName("value")]
    public List<Video> Videos { get; set; }
}

class Video
{
    [JsonPropertyName("name")]
    public string Name { get; set; }

    [JsonPropertyName("description")]
    public string Description { get; set; }

    [JsonPropertyName("thumbnailUrl")]
    public string ThumbnailUrl { get; set; }

    [JsonPropertyName("contentUrl")]
    public string ContentUrl { get; set; }
}

動画検索要求の作成と処理

API への呼び出しを実行するには、HttpClient を使用します。まず、ヘッダー Ocp-Apim-Subscription-Key とアクセスキーを追加する必要があります。

using var client = new HttpClient();
client.BaseAddress = new Uri(_uriBase);
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", _accessKey);

検索要求の URI を構築します。文字列に追加する前に、検索語句 _searchTerm を書式設定します。

var response = await client.GetAsync($"?q={Uri.EscapeDataString(_searchTerm)}");

結果の処理

応答が成功していた場合は、JSON データを処理できます。前に作成した SearchResult に JSON 文字列を逆シリアル化します。結果 (存在する場合) に対してループ処理を行い、結果をコンソールに出力します。

if (response.IsSuccessStatusCode)
{
    var json = await response.Content.ReadAsStringAsync();
    var result = JsonSerializer.Deserialize<SearchResult>(json);

    foreach (var video in result.Videos)
    {
        Console.WriteLine($"Name: {video.Name}");
        Console.WriteLine($"ContentUrl: {video.ContentUrl}");
        Console.WriteLine();
    }
}

JSON の応答例

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

{
    "_type": "Videos",
    "instrumentation": {},
    "readLink": "https://api.cognitive.microsoft.com/api/v7/videos/search?q=kittens",
    "webSearchUrl": "https://www.bing.com/videos/search?q=kittens",
    "totalEstimatedMatches": 1000,
    "value": [
        {
            "webSearchUrl": "https://www.bing.com/videos/search?q=kittens&view=...",
            "name": "Top 10 cute kitten videos compilation",
            "description": "HELP HOMELESS ANIMALS AND WIN A PRIZE BY CHOOSING...",
            "thumbnailUrl": "https://tse4.mm.bing.net/th?id=OVP.n1aE_Oikl4MtzBb...",
            "datePublished": "2014-11-12T22:47:36.0000000",
            "publisher": [
                {
                    "name": "Fabrikam"
                }
            ],
            "creator": {
                "name": "Marcus Appel"
            },
            "isAccessibleForFree": true,
            "contentUrl": "https://www.fabrikam.com/watch?v=8HVWitAW-Qg",
            "hostPageUrl": "https://www.fabrikam.com/watch?v=8HVWitAW-Qg",
            "encodingFormat": "h264",
            "hostPageDisplayUrl": "https://www.fabrikam.com/watch?v=8HVWitAW-Qg",
            "width": 480,
            "height": 360,
            "duration": "PT3M52S",
            "motionThumbnailUrl": "https://tse4.mm.bing.net/th?id=OM.j4QyJAENJphdZQ_1501386166&pid=Api",
            "embedHtml": "<iframe width=\"1280\" height=\"720\" src=\"https://www.fabrikam.com/embed/8HVWitAW-Qg?autoplay=1\" frameborder=\"0\" allowfullscreen></iframe>",
            "allowHttpsEmbed": true,
            "viewCount": 7513633,
            "thumbnail": {
                "width": 300,
                "height": 168
            },
            "videoId": "655D98260D012432848F6558260D012432848F",
            "allowMobileEmbed": true,
            "isSuperfresh": false
        },
        . . .
    ],
    "nextOffset": 36,
    "queryExpansions": [
        {
            "text": "Kittens Meowing",
            "displayText": "Meowing",
            "webSearchUrl": "https://www.bing.com/videos/search?q=Kittens+Meowing...",
            "searchLink": "https://api.cognitive.microsoft.com/api/v7/videos/search...",
            "thumbnail": {
                "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Kittens+Meowing&pid..."
            }
        },
        {
            "text": "Funny Kittens",
            "displayText": "Funny",
            "webSearchUrl": "https://www.bing.com/videos/search?q=Funny+Kittens...",
            "searchLink": "https://api.cognitive.microsoft.com/api/v7/videos/search...",
            "thumbnail": {
                "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Funny+Kittens&..."
            }
        },
        . . .
    ],
    "pivotSuggestions": [
        {
            "pivot": "kittens",
            "suggestions": [
                {
                    "text": "Cat",
                    "displayText": "Cat",
                    "webSearchUrl": "https://www.bing.com/videos/search?q=Cat...",
                    "searchLink": "https://api.cognitive.microsoft.com/api/v7/videos/search?...",
                    "thumbnail": {
                        "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Cat&pid=Api..."
                    }
                },
                {
                    "text": "Feral Cat",
                    "displayText": "Feral Cat",
                    "webSearchUrl": "https://www.bing.com/videos/search?q=Feral+Cat...",
                    "searchLink": "https://api.cognitive.microsoft.com/api/v7/videos/search...",
                    "thumbnail": {
                        "thumbnailUrl": "https://tse3.mm.bing.net/th?q=Feral+Cat&pid=Api&..."
                    }
                }
            ]
        }
    ],
    "relatedSearches": [
        {
            "text": "Kittens Being Born",
            "displayText": "Kittens Being Born",
            "webSearchUrl": "https://www.bing.com/videos/search?q=Kittens+Being+Born...",
            "searchLink": "https://api.cognitive.microsoft.com/api/v7/videos/search?...",
            "thumbnail": {
                "thumbnailUrl": "https://tse1.mm.bing.net/th?q=Kittens+Being+Born&pid=..."
            }
        },
        . . .
    ]
}

次のステップ

シングルページ Web アプリの作成

次の方法で共有

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

前提条件

Azure リソースを作成する

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

Bing Video Search API 応答が保持されるデータ構造を作成する

動画検索要求の作成と処理

結果の処理

JSON の応答例

次のステップ

関連項目

その他のリソース

次の方法で共有

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

前提条件

Azure リソースを作成する

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

Bing Video Search API 応答が保持されるデータ構造を作成する

動画検索要求の作成と処理

結果の処理

JSON の応答例

次のステップ

関連項目

その他のリソース

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