Mengirim permintaan pencarian ke Bing Video Search API

Peringatan

Pada 30 Oktober 2020, API Bing Search dipindahkan dari layanan Azure AI ke layanan Bing Search. Dokumentasi ini disediakan hanya untuk referensi. Untuk dokumentasi terbaru, lihat dokumentasi Bing Search API. Untuk petunjuk tentang cara membuat sumber daya Azure baru untuk pencarian Bing, lihat Membuat sumber daya Bing Search melalui Marketplace Azure.

Artikel ini menjelaskan parameter dan atribut permintaan yang dikirim ke Bing Video Search API, serta objek respons JSON yang ditampilkannya.

Membuat grup sumber daya Azure

Mulai gunakan Bing Video Search API dengan membuat salah satu sumber daya Azure berikut:

Sumber daya Bing Search v7

  • Tersedia melalui portal Microsoft Azure hingga Anda menghapus sumber daya.
  • Gunakan tingkat harga gratis untuk mencoba layanan, dan tingkatkan ke tingkat berbayar untuk produksi di kemudian hari.

Sumber daya multilayanan

  • Tersedia melalui portal Microsoft Azure hingga Anda menghapus sumber daya.
  • Gunakan kunci dan titik akhir yang sama untuk aplikasi Anda, di beberapa layanan Azure AI.

Menyarankan istilah pencarian dengan Bing Autosuggest API

Jika Anda menyediakan kotak pencarian di mana pengguna memasukkan istilah pencarian mereka, gunakan Bing Autosuggest API untuk meningkatkan pengalaman. API mengembalikan string kueri yang disarankan berdasarkan istilah pencarian parsial sebagai jenis pengguna.

Setelah pengguna memasukkan istilah pencarian mereka, URL mengodekannya sebelum mengatur parameter kueri q. Misalnya, jika pengguna memasukkan sailing dinghies, atur q ke sailing+dinghies atau sailing%20dinghies.

Mengirim permintaan

Untuk mendapatkan hasil pencarian Video, Anda akan mengirim permintaan GET ke titik akhir berikut:

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

Permintaan tersebut harus menggunakan protokol HTTPS.

Disarankan agar semua permintaan berasal dari server. Mendistribusikan kunci sebagai bagian dari aplikasi klien memberikan lebih banyak peluang bagi pihak ketiga yang berbahaya untuk mengaksesnya. Melakukan panggilan dari server juga menyediakan satu titik peningkatan untuk versi API yang akan datang.

Permintaan harus menentukan parameter kueri q, yang berisi istilah pencarian pengguna. Meskipun bersifat opsional, permintaan juga harus menentukan parameter kueri pasar, yang mengidentifikasi pasar tempat Anda ingin memperoleh hasil. Untuk daftar parameter kueri opsional seperti pricing, lihat Parameter Kueri. Semua nilai parameter kueri harus dikodekan URL.

Permintaan harus menentukan header Ocp-Apim-Subscription-Key. Meskipun bersifat opsional, Anda juga dianjurkan untuk menentukan header berikut:

IP klien dan header lokasi penting untuk mengembalikan konten yang mengetahui lokasi.

Untuk daftar semua header permintaan dan respons, lihat Header.

Contoh permintaan pencarian

Berikut ini menunjukkan permintaan pencarian yang menyertakan semua parameter dan header kueri yang disarankan. Jika ini pertama kalinya Anda memanggil salah satu Bing API, jangan sertakan header ID klien. Hanya sertakan ID klien jika sebelumnya Anda telah memanggil Bing API dan Bing mengembalikan ID klien untuk kombinasi pengguna dan perangkat.

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  

Contoh respons JSON

Berikut ini menunjukkan respons terhadap permintaan sebelumnya. Contohnya juga menunjukkan header respons khusus Bing.

Catatan

Karena format dan parameter URL dapat berubah tanpa pemberitahuan, gunakan semua URL apa adanya. Anda tidak boleh mengambil dependensi pada format atau parameter URL kecuali jika dicatat.

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..."
                    }
                },
                . . .
            ]
        }
    ]
}

Langkah berikutnya

Coba API-nya. Buka Konsol Pengujian Video Search API.

Untuk detail tentang menggunakan objek respons, lihat Mencari Web untuk Video.

Untuk detail tentang mendapatkan wawasan tentang video seperti pencarian terkait, lihat Wawasan Video.

Untuk detail tentang video yang sedang populer di media sosial, lihat Video Populer.