Bing Video Search API への検索要求の送信

[アーティクル]
12/03/2019

警告

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

この記事では、Bing Video Search API に送信される要求のパラメーターと属性、およびそこから返される JSON 応答オブジェクトについて説明します。

Azure リソースを作成する

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

Bing Search v7 リソース

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

マルチサービスリソース

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

Bing Autosuggest API で検索語句の候補を表示する

ユーザーが検索語句を入力するための検索ボックスを用意する場合は、Bing Autosuggest API を使用することでエクスペリエンスが向上します。この API は、検索語句をユーザーが入力している最中に、その一部分に基づいてクエリ文字列の候補を返します。

ユーザーが検索語句を入力した後、それを URL エンコードしたうえで、q クエリパラメーターを設定します。たとえば「sailing dinghies」と入力された場合、q を sailing+dinghies または sailing%20dinghies に設定します。

要求を送信する

ビデオ検索の結果を取得するには、次のエンドポイントに GET 要求を送信します。

https://api.cognitive.microsoft.com/bing/v7.0/videos/search

要求では、HTTPS プロトコルを使う必要があります。

すべての要求をサーバーから送信することをお勧めします。クライアントアプリケーションの一部としてキーを配布すると、悪意のあるサードパーティがアクセスする可能性が高くなります。また、サーバーから呼び出しを行うと、API の将来のバージョンでアップグレードする場所が 1 つで済みます。

要求では、ユーザーの検索語句が含まれている q クエリパラメーターを指定する必要があります。必須ではありませんが、要求では mkt クエリパラメーターも指定するべきです。このパラメーターは、結果取得元の市場を示します。 pricing などの省略可能なクエリパラメーターの一覧については、「クエリパラメーター」をご覧ください。すべてのクエリパラメーターの値は、URL でエンコードする必要があります。

要求では、Ocp-Apim-Subscription-Key ヘッダーを指定する必要があります。省略可能ですが、次のヘッダーも指定することをお勧めします。

クライアント IP と場所のヘッダーは、場所に対応したコンテンツを返すために重要です。

すべての要求ヘッダーと応答ヘッダーのリストについては、「Headers」(ヘッダー) を参照してください。

検索要求の例

すべての推奨されるクエリパラメーターとヘッダーを含む検索要求を次に示します。いずれかの Bing API を初めて呼び出す場合は、クライアント ID ヘッダーを含めないでください。クライアント ID を含めるのは、過去に Bing API を呼び出したことがあり、かつユーザーとデバイスの組み合わせに対応するクライアント ID が Bing から返されたことがある場合だけです。

GET https://api.cognitive.microsoft.com/bing/v7.0/videos/search?q=sailing+dinghies&mkt=en-us HTTP/1.1  
Ocp-Apim-Subscription-Key: 123456789ABCDE  
User-Agent: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822)  
X-Search-ClientIP: 999.999.999.999  
X-Search-Location: lat:47.60357;long:-122.3295;re:100  
X-MSEdge-ClientID: <blobFromPriorResponseGoesHere>  
Host: api.cognitive.microsoft.com

JSON の応答例

前述の要求への応答は次のようになります。例では、Bing に固有の応答ヘッダーも示されています。

Note

URL の書式とパラメーターは、予告なしで変更されることがあるため、すべての URL をそのまま使用してください。明記されている場合を除いて、URL の書式またはパラメーターに依存しないでください。

BingAPIs-TraceId: 76DD2C2549B94F9FB55B4BD6FEB6AC
X-MSEdge-ClientID: 1C3352B306E669780D58D607B96869
BingAPIs-Market: en-US

{
    "_type" : "Videos",
    "webSearchUrl" : "https:\/\/www.bing.com\/cr?IG=81EF7545D5694...",
    "totalEstimatedMatches" : 1000,
    "value" : [
        {
            "name" : "How to sail - What to Wear for Dinghy Sailing",
            "description" : "An informative video on what to wear when...",
            "webSearchUrl" : "https:\/\/www.bing.com\/cr?IG=81EF7545D56...",
            "thumbnailUrl" : "https:\/\/tse4.mm.bing.net\/th?id=OVP.DYWCvh...",
            "datePublished" : "2014-03-04T11:51:53",
            "publisher" : [
                {
                    "name" : "Fabrikam"
                }
            ],
            "creator" : {
                "name" : "Marcus Appel"
            },
            "contentUrl" : "https:\/\/www.fabrikam.com\/watch?v=vzmPjHZ--g",
            "hostPageUrl" : "https:\/\/www.bing.com\/cr?IG=81EF7545D56944...",
            "encodingFormat" : "h264",
            "hostPageDisplayUrl" : "https:\/\/www.fabrikam.com\/watch?v=vzmPjBZ--g",
            "width" : 1280,
            "height" : 720,
            "duration" : "PT2M47S",
            "motionThumbnailUrl" : "https:\/\/tse3.mm.bing.net\/th?id=OM.Y6...",
            "embedHtml" : "<iframe width=\"1280\" height=\"720\" src=\"https:...><\/iframe>",
            "allowHttpsEmbed" : true,
            "viewCount" : 8743,
            "thumbnail" : {
                "width" : 300,
                "height" : 168
            },
            "videoId" : "6DB795E11A6E3CBAAD636DB795E11E3CBAAD63",
            "allowMobileEmbed" : true,
            "isSuperfresh" : false
        },
        . . .
    ],
    "nextOffset" : 0,
    "pivotSuggestions" : [
        {
            "pivot" : "sailing",
            "suggestions" : []
        },
        {
            "pivot" : "dinghies",
            "suggestions" : [
                {
                    "text" : "Sailing Cruising",
                    "displayText" : "Cruising",
                    "webSearchUrl" : "https:\/\/www.bing.com\/cr?IG=81EF754...",
                    "searchLink" : "https:\/\/api.cognitive.microsoft.com...",
                    "thumbnail" : {
                        "thumbnailUrl" : "https:\/\/tse4.mm.bing.net\/th?q=Sailing..."
                    }
                },
                . . .
            ]
        }
    ]
}

次のステップ

API を試してみます。 Video Search API テストコンソールに関するページを参照してください。

応答オブジェクトの使用に関する詳細については、Web でのビデオ検索に関するページを参照してください。

関連検索などのビデオに関する分析情報を取得する方法の詳細については、ビデオの分析情報の取得に関するページを参照してください。

ソーシャルメディアで注目されているビデオの詳細については、急上昇中の動画に関するページを参照してください。

次の方法で共有