Referensi API Pencarian Video v7
Peringatan
API Pencarian Bing berpindah dari Cognitive Services ke Layanan Pencarian Bing. Mulai 30 Oktober 2020, setiap instans baru Bing Search perlu diprovisikan dengan mengikuti proses yang didokumentasikan di sini. Bing Search API yang diprovisikan menggunakan Cognitive Services akan didukung selama tiga tahun ke depan atau hingga akhir Perjanjian Enterprise Anda, mana saja yang lebih dulu. Untuk instruksi migrasi, lihat Layanan Pencarian Bing.
API Pencarian Video memungkinkan Anda mengirim kueri pencarian ke Bing dan mendapatkan kembali daftar video yang relevan dengan kueri pencarian. Bagian ini menyediakan detail teknis tentang parameter dan header kueri yang Anda gunakan untuk meminta video dan objek respons JSON yang berisinya. Untuk contoh yang menunjukkan cara membuat permintaan, lihat Mencari Web untuk Video.
Untuk informasi tentang header yang harus disertakan permintaan, lihat Header Permintaan.
Untuk informasi tentang parameter kueri yang harus disertakan permintaan, lihat Parameter Kueri.
Untuk informasi tentang objek JSON yang mungkin disertakan oleh respons, lihat Objek Respons.
Untuk informasi tentang penggunaan dan tampilan hasil yang diizinkan, lihat persyaratan Penggunaan dan Tampilan API Pencarian 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.
Titik akhir
Untuk meminta video, kirim permintaan GET ke salah satu URL berikut:
| Titik akhir | Deskripsi |
|---|---|
| https://api.cognitive.microsoft.com/bing/v7.0/videos/search | Mengembalikan video yang relevan dengan kueri pencarian pengguna. |
| https://api.cognitive.microsoft.com/bing/v7.0/videos/details | Mengembalikan wawasan tentang video, seperti video terkait. |
| https://api.cognitive.microsoft.com/bing/v7.0/videos/trending | Mengembalikan video yang sedang tren berdasarkan permintaan pencarian yang dibuat oleh orang lain. Video dipecah menjadi berbagai kategori. Misalnya, Video Musik Teratas. Untuk daftar pasar yang mendukung video yang sedang tren, lihat Video Yang Sedang Tren. |
Untuk langganan multi-layanan, Anda harus menyertakan wilayah dalam URL. Misalnya: westus.api.cognitive.microsoft.com. Lihat Wilayah yang Didukung.
Permintaan harus menggunakan protokol HTTPS.
Catatan
Panjang URL maksimum adalah 2.048 karakter. Untuk memastikan bahwa panjang URL Anda tidak melebihi batas, panjang maksimum parameter kueri Anda harus kurang dari 1.500 karakter. Jika URL melebihi 2.048 karakter, server menampilkan 404 Tidak ditemukan.
Header
Berikut adalah header yang mungkin disertakan oleh permintaan dan respons.
| Header | Deskripsi |
|---|---|
| Terima | Header permintaan opsional. Jenis media default adalah aplikasi/json. Untuk menentukan bahwa respons menggunakan JSON-LD, atur header Terima ke application/ld+json. |
| Accept-Language | Header permintaan opsional. Daftar bahasa yang dibatasi koma untuk digunakan untuk string antarmuka pengguna. Daftar ini dalam urutan preferensi yang menurun. Untuk mengetahui informasi selengkapnya, termasuk format yang diharapkan, lihat RFC2616. Header ini dan parameter kueri setLang saling eksklusif jangan tentukan keduanya. Jika Anda mengatur header ini, Anda juga harus menentukan parameter kueri cc. Untuk menentukan pasar guna menampilkan hasil, Bing menggunakan bahasa pertama yang didukung yang ditemukannya dari daftar dan menggabungkannya dengan nilai parameter cc. Jika daftar tidak menyertakan bahasa yang didukung, Bing menemukan bahasa dan pasar terdekat yang mendukung permintaan atau menggunakan pasar agregat atau default untuk hasilnya. Untuk menentukan pasar yang digunakan Bing, lihat header BingAPIs-Market.Gunakan header ini dan parameter kueri cc hanya jika Anda menentukan beberapa bahasa. Jika tidak, gunakan parameter kueri mkt dan setLang.String antarmuka pengguna adalah string yang digunakan sebagai label di antarmuka pengguna. Ada beberapa string antarmuka pengguna di objek respons JSON. Setiap tautan ke properti Bing.com dalam objek respons menerapkan bahasa yang ditentukan. |
| BingAPIs-Market | Header respons. Pasar yang digunakan oleh permintaan. Bentuknya adalah <languageCode>-<countryCode>. Misalnya, en-US. Jika Anda menentukan pasar yang tidak tercantum dalam Kode Pasar, nilai ini mungkin berbeda dari pasar yang Anda tentukan dalam parameter kueri mkt . Hal yang sama berlaku jika Anda menentukan nilai untuk cc dan Accept-Language yang tidak dapat direkonsiliasi. |
| BingAPIs-TraceId | Header respons. ID entri log yang berisi detail permintaan. Saat terjadi kesalahan, ambil ID ini. Jika Anda tidak dapat menentukan dan mengatasi masalah tersebut, sertakan ID ini bersama dengan informasi lain yang Anda berikan kepada tim Dukungan. |
| Ocp-Apim-Subscription-Key | Header permintaan yang diperlukan. Kunci langganan yang Anda terima saat mendaftar untuk layanan ini di Cognitive Services. |
| Retry-After | Header respons. Respons mencakup header ini jika Anda melebihi jumlah kueri yang diizinkan per detik (QPS) atau per bulan (QPM). Header berisi jumlah detik yang harus Anda tunggu sebelum mengirim permintaan lain. |
| User-Agent | Header permintaan opsional. Agen pengguna yang berasal dari permintaan. Bing menggunakan agen pengguna untuk memberikan pengalaman yang dioptimalkan kepada pengguna seluler. Meskipun opsional, Anda dianjurkan untuk selalu menentukan header ini. User-agent harus berupa string yang sama dengan yang dikirim oleh browser yang umum digunakan. Untuk mengetahui informasi tentang agen pengguna, lihat RFC 2616. Berikut adalah contoh string user-agent.
|
| X-MSEdge-ClientID | Permintaan dan header respons opsional. Bing menggunakan header ini untuk memberi perilaku yang konsisten kepada pengguna di seluruh panggilan Bing API. Bing sering kali menerbangkan fitur dan peningkatan baru, dan menggunakan ID klien sebagai kunci untuk menetapkan lalu lintas pada penerbangan yang berbeda. Jika Anda tidak menggunakan ID klien yang sama untuk pengguna di beberapa permintaan, Bing dapat menetapkan pengguna ke beberapa penerbangan yang bertentangan. Ditetapkan ke beberapa penerbangan yang bertentangan dapat menyebabkan pengalaman pengguna yang tidak konsisten. Misalnya, jika permintaan kedua memiliki penetapan penerbangan yang berbeda dengan yang pertama, pengalaman tersebut mungkin tidak diharapkan. Selain itu, Bing dapat menggunakan ID klien untuk menyesuaikan hasil web dengan riwayat pencarian ID klien tersebut, memberikan pengalaman yang lebih kaya bagi pengguna. Bing juga menggunakan header ini untuk membantu meningkatkan peringkat hasil dengan menganalisis aktivitas yang dibuat oleh ID klien. Peningkatan relevansi membantu terkait kualitas hasil yang lebih baik yang disampaikan oleh Bing API dan pada gilirannya memungkinkan rasio klik-tayang yang lebih tinggi untuk konsumen API. PENTING: Meskipun opsional, Anda harus menganggap header ini diperlukan. Mempertahankan ID klien di beberapa permintaan untuk kombinasi pengguna akhir dan perangkat yang sama memungkinkan 1) konsumen API menerima pengalaman pengguna yang konsisten, dan 2) rasio klik-tayang yang lebih tinggi melalui kualitas hasil yang lebih baik dari Bing API. Berikut adalah aturan dasar penggunaan yang berlaku untuk header ini.
CATATAN: Respons Bing mungkin atau mungkin tidak menyertakan header ini. Jika respons menyertakan header ini, tangkap ID klien dan gunakan untuk semua permintaan Bing berikutnya untuk pengguna di perangkat tersebut. CATATAN: Jika Anda menyertakan X-MSEdge-ClientID, Anda tidak boleh menyertakan cookie dalam permintaan. |
| X-MSEdge-ClientIP | Header permintaan opsional. Alamat IPv4 atau IPv6 perangkat klien. Alamat IP digunakan untuk menemukan lokasi pengguna. Bing menggunakan informasi lokasi untuk menentukan perilaku pencarian yang aman. CATATAN: Meskipun opsional, Anda dianjurkan untuk selalu menentukan header ini dan header X-Search-Location. Jangan mengaburkan alamat (misalnya, dengan mengubah oktet terakhir menjadi 0). Mengaburkan alamat mengakibatkan lokasi tidak berada di dekat lokasi aktual perangkat, yang dapat mengakibatkan Bing memberikan hasil yang salah. |
| X-Search-Location | Header permintaan opsional. Daftar pasangan kunci/nilai yang dibatasi titik koma yang menjelaskan lokasi geografis klien. Bing menggunakan informasi lokasi untuk menentukan perilaku pencarian yang aman dan menampilkan konten lokal yang relevan. Tentukan pasangan kunci/nilai sebagai <kunci>:<nilai>. Berikut adalah kunci yang Anda gunakan untuk menentukan lokasi pengguna.
CATATAN: Meskipun banyak kunci bersifat opsional, semakin banyak informasi yang Anda berikan, semakin akurat hasil lokasinya. CATATAN: Meskipun opsional, Anda dianjurkan untuk selalu menentukan lokasi geografis pengguna. Menyediakan lokasi sangat penting jika alamat IP klien tidak secara akurat mencerminkan lokasi fisik pengguna (misalnya, jika klien menggunakan VPN). Untuk hasil yang optimal, Anda harus menyertakan header ini dan header X-Search-ClientIP, tetapi minimal, Anda harus menyertakan header ini. |
Catatan
Ingatlah bahwa Ketentuan Penggunaan memerlukan kepatuhan terhadap semua hukum yang berlaku, termasuk mengenai penggunaan header ini. Misalnya, di wilayah hukum tertentu, seperti Eropa, ada persyaratan untuk mendapatkan persetujuan pengguna sebelum menempatkan perangkat pelacakan tertentu pada perangkat pengguna.
Parameter kueri
Berikut ini mencantumkan parameter kueri yang mungkin disertakan oleh permintaan. Lihat kolom Wajib untuk parameter yang diperlukan. Anda harus mengodekan nilai parameter kueri ke dalam URL. Untuk informasi tentang parameter kueri yang digunakan untuk memfilter video yang Bing kembalikan, lihat Memfilter parameter kueri.
| Nama | Nilai | Jenis | Diperlukan |
|---|---|---|---|
| cc | Kode negara 2 karakter negara tempat hasilnya berasal. Untuk daftar nilai yang mungkin, lihat Kode Pasar. Jika Anda mengatur parameter ini, Anda juga harus menentukan header Accept-Language. Bing menggunakan bahasa pertama yang didukung yang ditemukannya dalam bahasa yang ditentukan dan menggabungkannya dengan kode negara untuk menentukan pasar untuk mengembalikan hasil. Jika daftar bahasa tidak menyertakan bahasa yang didukung, Bing menemukan bahasa dan pasar terdekat yang mendukung permintaan tersebut. Atau, Bing dapat menggunakan pasar agregat atau default untuk hasilnya. Gunakan parameter kueri ini dan Accept-Language header hanya jika Anda menentukan beberapa bahasa. Jika tidak, Anda harus menggunakan mkt parameter kueri dan setLang .Parameter ini dan parameter kueri mkt saling eksklusif—jangan tentukan keduanya. |
String | Tidak |
| jumlah | Jumlah video yang akan dikembalikan dalam respons. Jumlah aktual yang dikirimkan mungkin kurang dari yang diminta. Defaultnya adalah 35. Maksimum adalah 105. Anda dapat menggunakan parameter ini bersama dengan offset parameter ke hasil halaman. Misalnya, jika antarmuka pengguna Anda menyajikan 20 video per halaman, atur count ke 20 dan offset ke 0 untuk mendapatkan halaman pertama hasil. Untuk setiap halaman berikutnya, kenaikan offset sebesar 20 (misalnya, 0, 20, 40).Gunakan parameter ini hanya dengan API Pencarian Video. Jangan tentukan parameter ini saat memanggil TRENDING Videos API atau Web Search API. |
UnsignedShort | Tidak |
| id | ID yang secara unik mengidentifikasi video. Bidang Objek videoIdvideo berisi ID tempat Anda mengatur parameter ini.Untuk titik akhir /videos/search, Anda menggunakan parameter ini untuk memastikan bahwa video yang ditentukan adalah video pertama dalam daftar video yang Bing kembalikan. Untuk titik akhir /videos/details, Anda menggunakan parameter ini untuk mengidentifikasi video untuk mendapatkan wawasan. |
String | Tidak |
| Modul | Daftar wawasan yang dibatasi koma untuk diminta. Berikut adalah nilai yang mungkin tidak peka huruf besar/kecil.
Jika Anda menentukan wawasan dan tidak ada data untuk itu, objek respons tidak menyertakan bidang terkait. Misalnya, jika Anda menentukan RelatedVideos dan tidak ada, respons tidak menyertakan relatedVideos bidang .Meskipun istilah kueri pengguna tidak diperlukan, Anda harus selalu menyertakannya karena membantu meningkatkan relevansi dan hasilnya. Gunakan parameter ini hanya saat memanggil /videos/details titik akhir. Jangan tentukan parameter ini saat memanggil /videos titik akhir atau WEB Search API. |
String | Ya |
| mkt | Pasar tempat hasilnya berasal. Biasanya, mkt adalah negara tempat pengguna membuat permintaan. Namun, itu bisa menjadi negara yang berbeda jika pengguna tidak berada di negara tempat Bing memberikan hasil. Pasar harus dalam bentuk <kode> negara kode>< bahasa. Misalnya, en-US. String tidak peka huruf besar/kecil. Untuk daftar nilai pasar yang mungkin, lihat Kode Pasar.CATATAN: Jika diketahui, Anda didorong untuk selalu menentukan pasar. Menentukan pasar membantu Bing merutekan permintaan dan menampilkan respons yang sesuai dan optimal. Jika Anda menentukan pasar yang tidak tercantum dalam Kode Pasar, Bing menggunakan kode pasar yang paling sesuai berdasarkan pemetaan internal yang dapat berubah. Parameter ini dan parameter kueri cc saling eksklusif—jangan tentukan keduanya. |
String | Tidak |
| offset | Offset berbasis nol yang menunjukkan jumlah video yang akan dilewati sebelum mengembalikan video. Defaultnya adalah 0. Offset harus kurang dari (totalEstimatedMatches - count).Gunakan parameter ini bersama dengan count parameter ke hasil halaman. Misalnya, jika antarmuka pengguna Anda menampilkan 20 video per halaman, atur count ke 20 dan offset ke 0 untuk mendapatkan halaman pertama hasil. Untuk setiap halaman berikutnya, kenaikan offset sebesar 20 (misalnya, 0, 20, 40).Dimungkinkan bagi beberapa halaman untuk menyertakan beberapa tumpang tindih dalam hasil. Untuk mencegah duplikat, lihat nextOffset. Gunakan parameter ini hanya dengan API Pencarian Video. Jangan tentukan parameter ini saat memanggil TRENDING Videos API atau Web Search API. |
Pendek Tidak Ditandatangani | Tidak |
| q | String kueri pencarian pengguna. String kueri tidak boleh kosong. String kueri mungkin berisi Bing Operator Tingkat Lanjut. Misalnya, untuk membatasi video ke domain tertentu, gunakan operator site: . Gunakan parameter ini hanya dengan API Pencarian Video. Jangan tentukan parameter ini saat memanggil TRENDING Videos API. |
String | Ya |
| safeSearch | Memfilter video untuk konten dewasa. Berikut ini adalah kemungkinan nilai filter.
CATATAN: Jika safeSearch diatur ke Nonaktif, Bing mengabaikannya dan menggunakan Moderat.CATATAN: Jika permintaan berasal dari pasar yang diperlukan safeSearch kebijakan dewasa Bing diatur ke Ketat, Bing mengabaikan safeSearch nilai dan menggunakan Strict.CATATAN: Jika Anda menggunakan operator kueri site:, ada kemungkinan respons berisi konten dewasa terlepas dari untuk apa parameter kueri safeSearch ditetapkan. Gunakan site: hanya jika Anda mengetahui konten di situs dan skenario Anda mendukung kemungkinan konten dewasa. |
String | Tidak |
| setLang | Bahasa yang digunakan untuk string antarmuka pengguna. Anda dapat menentukan bahasa menggunakan kode 2 huruf atau 4 huruf. Menggunakan kode 4 huruf lebih disukai. Untuk daftar kode bahasa yang didukung, lihat Bing bahasa yang didukung. Bing memuat string yang dilokalkan jika setlang berisi kode kultur netral 2 huruf (fr) yang valid atau kode budaya khusus 4 huruf (fr-ca) yang valid. Misalnya, untuk fr-ca, Bing memuat string kode kultur netral fr.Jika setlang tidak valid (misalnya, zh) atau Bing tidak mendukung bahasa (misalnya, af, af-na), Bing default ke en (Inggris). Untuk menentukan kode 2 huruf, atur parameter ini ke kode bahasa ISO 639-1. Untuk menentukan kode 4 huruf, gunakan formulir bahasa negara/wilayah> di mana <bahasa> adalah kode bahasa ISO 639-1 (budaya netral) dan <negara/wilayah> adalah kode negara/wilayah ISO 3166 (budaya tertentu).<>< Misalnya, gunakan en-US untuk bahasa Inggris Amerika Serikat. Meskipun opsional, Anda harus selalu menentukan bahasa. Biasanya, Anda mengatur setLang ke bahasa yang sama dengan yang ditentukan oleh mkt kecuali pengguna ingin string antarmuka pengguna ditampilkan dalam bahasa yang berbeda.Parameter dan header Accept-Language ini saling eksklusif—jangan tentukan keduanya. String antarmuka pengguna adalah string yang digunakan sebagai label di antarmuka pengguna. Ada beberapa string antarmuka pengguna di objek respons JSON. Selain itu, setiap tautan ke properti Bing.com dalam objek respons menerapkan bahasa yang ditentukan. |
String | Tidak |
| textDecorations | Nilai Boolean yang menentukan apakah string tampilan berisi penanda dekorasi seperti karakter penyorotan hit. Jika true, string dapat menyertakan penanda. Defaultnya adalah false. Untuk menentukan apakah akan menggunakan karakter Unicode atau tag HTML sebagai penanda, lihat parameter kueri textFormat . Untuk informasi tentang penyorotan temuan, lihat Penyorotan Klik. |
Boolean | Tidak |
| textFormat | Jenis penanda yang digunakan untuk dekorasi teks (lihat textDecorations parameter kueri).Berikut ini adalah nilai yang mungkin.
Defaultnya adalah Raw. Untuk daftar penanda, lihat Penyorotan Temuan. Untuk string tampilan yang berisi karakter HTML yang dapat dilepaskan seperti <, , >dan &, jika textFormat diatur ke HTML, Bing lolos dari karakter yang sesuai (misalnya, < diloloskan ke <).Untuk informasi tentang memproses string dengan karakter Unicode yang disematkan, lihat Penyorotan Temuan. |
String | Tidak |
Memfilter parameter kueri
Berikut ini adalah parameter kueri filter opsional yang bisa Anda gunakan untuk memfilter video yang Bing kembalikan. Anda harus mengodekan URL parameter kueri.
Gunakan parameter kueri ini hanya dengan API Pencarian Video. Jangan tentukan parameter ini saat memanggil TRENDING Videos API dan Search API.
Objek respons
Catatan
Untuk mematuhi Direktif Hak Cipta UE baru di Prancis, API Bing Web, Berita, Video, Gambar, dan semua Pencarian Kustom harus menghilangkan beberapa konten dari sumber Berita UE tertentu untuk pengguna Prancis. Konten yang dihapus dapat mencakup gambar dan video gambar mini, pratinjau video, dan cuplikan yang menyertai hasil pencarian dari sumber ini. Akibatnya, API Bing dapat melayani lebih sedikit hasil dengan gambar dan video gambar mini, pratinjau video, dan cuplikan kepada pengguna Prancis.
Berikut adalah objek respons JSON yang mungkin disertakan oleh respons. Jika permintaan berhasil, objek tingkat atas dalam respons adalah objek Video jika titik akhir adalah /video/search, VideoDetails jika titik akhir adalah /videos/details, dan TrendingVideos jika titik akhir adalah /videos/trending. Jika permintaan gagal, objek tingkat atas adalah objek ErrorResponse.
| Objek | Deskripsi |
|---|---|
| Kategori | Menentukan kategori video yang sedang tren. |
| Kesalahan | Menentukan kesalahan yang terjadi. |
| ErrorResponse | Objek tingkat atas yang disertakan respons saat permintaan gagal. |
| Gambar | Menentukan gambar mini. |
| MediaSize | Menentukan ukuran isi media. |
| Pivot | Menentukan segmen pivot. |
| Publisher | Menentukan penerbit atau pembuat. |
| Kueri | Menentukan string kueri pencarian. |
| Subkategori | Mendefinisikan subkataan video. |
| Hal | Menentukan nama entitas utama yang ditampilkan dalam video. |
| Gambar mini | Menentukan gambar mini. |
| Petak | Menentukan petak peta video. |
| TrendingVideos | Objek tingkat atas yang disertakan respons saat permintaan video yang sedang tren berhasil. |
| Video | Menentukan video yang relevan dengan kueri. |
| VideoDetails | Objek tingkat atas yang disertakan respons saat permintaan wawasan video berhasil. |
| Video | Objek tingkat atas yang disertakan respons saat permintaan video berhasil. |
| VideoModule | Mendefinisikan daftar video. |
Kategori
Menentukan kategori video yang sedang tren.
| Elemen | Deskripsi | Jenis |
|---|---|---|
| Subkategori | Daftar subkataan. Misalnya, Video Musik Teratas. | Subkataan[] |
| Judul | Nama kategori video. Misalnya, Video Musik. | String |
Kesalahan
Mendefinisikan kesalahan yang terjadi.
| Elemen | Deskripsi | Jenis |
|---|---|---|
| code | Kode kesalahan yang mengidentifikasi kategori kesalahan. Untuk daftar kode yang mungkin, lihat Kode Kesalahan. | String |
| message | Deskripsi kesalahan. | String |
| moreDetails | Deskripsi yang menyediakan informasi tambahan tentang kesalahan tersebut. | String |
| parameter | Parameter kueri dalam permintaan yang menyebabkan kesalahan. | String |
| subCode | Kode kesalahan yang mengidentifikasi kesalahan. Misalnya, jika code InvalidRequest, subCode mungkin berupa ParameterInvalid atau ParameterInvalidValue. |
String |
| value | Nilai parameter kueri yang tidak valid. | String |
ErrorResponse
Objek tingkat atas yang disertakan respons saat permintaan gagal.
| Nama | Nilai | Jenis |
|---|---|---|
| _type | Ketik petunjuk. | String |
| errors | Daftar kesalahan yang menjelaskan alasan permintaan gagal. | Error[] |
Gambar
Menentukan gambar mini.
| Nama | Nilai | Jenis |
|---|---|---|
| contentUrl | URL ke gambar di situs web sumber. | String |
| Deskripsi | Sebuah atribusi. | String |
| Judul | Deskripsi video. | String |
| thumbnailUrl | URL ke gambar mini gambar. Untuk informasi tentang mengubah ukuran gambar, lihat Mengubah ukuran dan memotong gambar mini. | String |
MediaSize
Menentukan ukuran konten media.
| Nama | Nilai | Jenis |
|---|---|---|
| tinggi | Tinggi konten media, dalam piksel. | Bilangan bulat |
| lebar | Lebar konten media, dalam piksel. | Bilangan bulat |
Pivot
Menentukan segmen pivot.
| Nama | Nilai | Jenis |
|---|---|---|
| Pivot | Segmen dari kueri asli untuk dipivot. | String |
| Saran | Daftar string kueri yang disarankan untuk pivot. | Kueri |
Publisher
Menentukan penerbit atau pembuat.
| Nama | Nilai | Jenis |
|---|---|---|
| name | Nama penerbit atau pembuat. | String |
Kueri
Menentukan istilah kueri pencarian.
| Nama | Nilai | Jenis |
|---|---|---|
| displayText | Versi tampilan istilah kueri. | String |
| searchUrl | URL yang Anda gunakan untuk mendapatkan hasil pencarian terkait. Sebelum menggunakan URL, Anda harus menambahkan parameter kueri yang sesuai dan menyertakan header Ocp-Apim-Subscription-Key . Gunakan URL ini jika Anda menampilkan hasilnya di antarmuka pengguna Anda sendiri. Jika tidak, gunakan webSearchUrl URL. |
String |
| Teks | Istilah kueri. | String |
| gambar mini | URL ke gambar mini gambar terkait. Objek mencakup bidang ini hanya untuk saran pivot dan pencarian terkait. |
Gambar mini |
| webSearchUrl | URL yang membawa pengguna ke halaman hasil pencarian Bing untuk kueri. | String |
Subkategori
Mendefinisikan subkataan video.
| Elemen | Deskripsi | Jenis |
|---|---|---|
| Ubin | Daftar video yang sedang tren di subkataan. Setiap petak berisi gambar mini video dan kueri Bing yang mengembalikan video dan video terkait lainnya. | Ubin[] |
| Judul | Nama subkataan. Misalnya, Video Viral Minggu Ini. | String |
Hal
Menentukan entitas utama yang ditampilkan dalam video.
| Nama | Nilai | Jenis |
|---|---|---|
| name | Nama entitas utama yang ditampilkan dalam video. | String |
Gambar mini
Menentukan URL ke gambar mini gambar.
| Elemen | Deskripsi | Jenis |
|---|---|---|
| url | URL ke gambar mini gambar. | String |
Petak petak
Menentukan petak peta video.
| Elemen | Deskripsi | Jenis |
|---|---|---|
| Gambar | URL ke gambar mini video. | Gambar |
| Query | Kueri yang mengembalikan halaman hasil pencarian Bing dengan video subjek. Misalnya, jika kategorinya adalah Video Musik Teratas, kueri mengembalikan video musik teratas. | Kueri |
TrendingVideos
Objek tingkat atas yang disertakan respons saat permintaan video yang sedang tren berhasil.
| Elemen | Deskripsi | Jenis |
|---|---|---|
| bannerTiles | Daftar video paling populer yang sedang tren. | Ubin[] |
| Kategori | Daftar video yang dikategorikan. Misalnya, video musik dan video viral. | Kategori[] |
Video
Menentukan video yang relevan dengan kueri.
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.
| Nama | Nilai | Jenis |
|---|---|---|
| allowHttpsEmbed | Nilai Boolean yang menentukan apakah Anda dapat menyematkan video (lihat embedHtml bidang) pada halaman yang menggunakan protokol HTTPS. |
Boolean |
| allowMobileEmbed | Nilai Boolean yang menentukan apakah Anda dapat menyematkan video (lihat embedHtml bidang ) di perangkat seluler. Jika true, Anda dapat menggunakan HTML pada perangkat seluler. |
Boolean |
| Pencipta | Nama pembuat video. Hanya respons API Pencarian Video yang menyertakan bidang ini. |
Publisher |
| contentUrl | URL ke video di situs web host. | String |
| datePublished | Tanggal dan waktu yang Bing menemukan video. Tanggal dalam format, YYYY-MM-DDTHH:MM:SS. | String |
| Deskripsi | Deskripsi singkat tentang video. | String |
| Durasi | Durasi atau panjang video. Misalnya, PT2M50S. Untuk informasi tentang format, lihat https://en.wikipedia.org/wiki/ISO_8601#Durations. | String |
| embedHtml | Iframe yang memungkinkan Anda menyematkan dan menjalankan video di halaman web Anda. | String |
| encodingFormat | Jenis mime video (misalnya, mp4). | String |
| tinggi | Tinggi video, dalam piksel. | Bilangan bulat |
| hostPageDisplayUrl | URL tampilan halaman web yang menghosting video. Gunakan URL ini di antarmuka pengguna Anda untuk mengidentifikasi halaman web host yang berisi video. URL tidak terbentuk dengan baik dan tidak boleh digunakan untuk mengakses halaman web host. Untuk mengakses halaman web host, gunakan hostPageUrl URL. |
String |
| hostPageUrl | URL ke halaman web yang menghosting video. URL dan contentUrl URL ini mungkin URL yang sama. |
String |
| id | ID yang mengidentifikasi video ini secara unik dalam daftar video. Hanya respons WEB Search API yang menyertakan bidang ini. Untuk informasi tentang cara menggunakan bidang ini, lihat Menggunakan Peringkat untuk Menampilkan Hasil di panduan API Pencarian Web. |
String |
| isAccessibleForFree | Nilai Boolean yang menunjukkan apakah video memerlukan pembayaran atau langganan berbayar untuk dilihat. Jika true, video gratis untuk ditonton. Jika tidak, jika salah, pembayaran atau langganan diperlukan. CATATAN: Jika Bing tidak dapat menentukan apakah pembayaran diperlukan, objek mungkin tidak menyertakan bidang ini. Untuk memastikan bahwa Bing hanya mengembalikan video gratis, atur parameter kueri harga ke Gratis. |
Boolean |
| isSuperfresh | Nilai Boolean yang menunjukkan apakah video baru-baru ini ditemukan oleh Bing. Jika true, video baru-baru ini ditemukan. Untuk mendapatkan video yang ditemukan dalam 24 jam terakhir atau minggu lalu, gunakan parameter kueri kesegaran . |
Boolean |
| mainEntity | Nama entitas utama yang ditampilkan dalam video. Objek hanya menyertakan bidang ini ketika scenario adalah SingleDominantVideo (lihat Video). |
Hal |
| motionThumbnailUrl | URL ke gambar mini animasi yang menampilkan pratinjau video. Biasanya, Anda akan menggunakan URL ini untuk memutar pratinjau video saat pengguna melakukan mouse di atas gambar mini video di halaman hasil Anda. | String |
| nama | Nama video. | String |
| penerbit | Daftar penerbit yang menerbitkan video. | Publisher |
| gambar mini | Lebar dan tinggi gambar mini (lihat thumbnailUrl). |
MediaSize |
| thumbnailUrl | URL ke gambar mini video. Untuk informasi tentang mengubah ukuran gambar, lihat Mengubah ukuran dan memotong gambar mini. | String |
| videoId | ID yang mengidentifikasi video ini secara unik dalam daftar video. Anda dapat menggunakan ID dalam permintaan berikutnya untuk memastikan bahwa video ini adalah video pertama yang dikembalikan dalam daftar video. Untuk memastikan video adalah video pertama dalam daftar, atur parameter kueri id permintaan ke ID ini. | String |
| viewCount | Berapa kali video telah ditonton di situs sumber. | Bilangan bulat |
| webSearchUrl | URL yang membawa pengguna ke Bing hasil pencarian video dan memutar video. | String |
| lebar | Lebar video, dalam piksel. | Bilangan bulat |
VideoDetails
Objek tingkat atas yang disertakan respons saat permintaan wawasan video berhasil.
Parameter kueri modul memengaruhi bidang yang Bing sertakan dalam respons. Jika Anda mengatur modules ke RelatedVideos, maka objek ini hanya relatedVideos menyertakan bidang .
| Nama | Nilai | Jenis |
|---|---|---|
| _type | Ketik petunjuk. | String |
| relatedVideos | Daftar video yang mirip dengan video yang ditentukan. | VideoModule |
| videoResult | Video asli yang Anda minta wawasannya (ini adalah video yang Anda atur parameter kueri id ke dalam permintaan wawasan Anda). | Video |
Video
Objek tingkat atas yang disertakan respons saat permintaan video berhasil.
Jika layanan mencurigai penolakan serangan layanan, permintaan berhasil (kode status HTTP adalah 200 OK), tetapi isi respons kosong.
| Nama | Nilai | Jenis |
|---|---|---|
| _type | Ketik petunjuk. | String |
| id | ID yang secara unik mengidentifikasi jawaban video. Untuk informasi tentang cara menggunakan bidang ini, lihat Menggunakan Peringkat untuk Menampilkan Hasil di panduan API Pencarian Web. |
String |
| isFamilyFriendly | Nilai Boolean yang menentukan apakah satu atau beberapa video berisi konten dewasa. Jika tidak ada video yang berisi konten dewasa, isFamilyFriendly diatur ke true. Jika tidak, jika satu atau beberapa video berisi konten dewasa, isFamilyFriendly diatur ke false.Jika false, gambar mini video di-pixel (fuzzy). CATATAN: Hanya respons WEB Search API yang menyertakan bidang ini (respons API Pencarian Video tidak menyertakan bidang ini). |
Boolean |
| nextOffset | Nilai offset tempat Anda mengatur parameter kueri offset . Jika Anda mengatur offset ke 0 dan count ke 30 pada permintaan pertama Anda, lalu mengatur offset ke 30 pada permintaan kedua Anda, beberapa hasil dalam respons kedua mungkin duplikat respons pertama.Untuk mencegah duplikat, atur offset ke nilai nextOffset. |
Bilangan bulat |
| pivotSuggestions | Daftar pivot yang mengegmentasi kueri asli. Misalnya, jika kueri adalah Cleaning Gutters, Bing mungkin mengelompokkan kueri ke dalam Pembersihan dan Gutters. Pivot Pembersihan mungkin berisi saran kueri seperti Penginstalan Gutter dan Perbaikan Gutter, dan pivot Gutters mungkin berisi saran kueri seperti Pembersihan Atap dan Pembersihan Jendela. |
Pivot[] |
| queryExpansions | Daftar kueri yang diperluas yang mempersempit kueri asli. Misalnya, jika kuerinya adalah Cleaning+Gutters, kueri yang diperluas mungkin adalah: Gutter Cleaning Tools, Cleaning Gutters From the Ground, Gutter Cleaning Machine, dan Easy Gutter Cleaning. | Kueri[] |
| Skenario | Skenario yang mencerminkan niat kueri. Berikut ini adalah nilai yang mungkin.
Hanya respons WEB Search API yang menyertakan bidang ini. |
String |
| totalEstimatedMatches | Perkiraan jumlah video yang cocok dengan kueri. Gunakan angka ini bersama dengan parameter kueri hitungan dan offset untuk halaman hasilnya. Hanya respons API Pencarian Video yang menyertakan bidang ini. |
Long |
| value | Daftar video yang relevan dengan kueri. | Video[] |
| webSearchUrl | URL ke hasil pencarian Bing untuk video yang diminta. | String |
VideoModule
Menentukan daftar video.
| Elemen | Deskripsi | Jenis |
|---|---|---|
| nilai | Daftar video. | Video[] |
Kode kesalahan
Berikut adalah kemungkinan kode status HTTP yang ditampilkan permintaan.
| Kode Status | Deskripsi |
|---|---|
| 200 | Berhasil. |
| 400 | Salah satu parameter kueri hilang atau tidak valid. |
| 401 | Kunci langganan hilang atau tidak valid. |
| 403 | Pengguna diautentikasi (misalnya, mereka menggunakan kunci langganan yang valid) tetapi tidak memiliki izin ke sumber daya yang diminta. Bing juga dapat menampilkan status ini jika penelepon melebihi kuota kueri per bulan. |
| 410 | Permintaan yang digunakan HTTP, bukan protokol HTTPS. HTTPS adalah satu-satunya protokol yang didukung. |
| 429 | Penelepon melebihi kueri mereka per kuota kedua. |
| 500 | Kesalahan server tidak terduga. |
Jika permintaan gagal, respons berisi objek ErrorResponse, yang berisi daftar objek Kesalahan yang menjelaskan apa yang menyebabkan kesalahan. Jika kesalahan terkait dengan parameter, bidang parameter mengidentifikasi parameter yang menjadi masalah. Dan jika kesalahan terkait dengan nilai parameter, bidang value mengidentifikasi nilai yang tidak valid.
{
"_type": "ErrorResponse",
"errors": [
{
"code": "InvalidRequest",
"subCode": "ParameterMissing",
"message": "Required parameter is missing.",
"parameter": "q"
}
]
}
{
"_type": "ErrorResponse",
"errors": [
{
"code": "InvalidAuthorization",
"subCode": "AuthorizationMissing",
"message": "Authorization is required.",
"moreDetails": "Subscription key is not recognized."
}
]
}
Berikut adalah kemungkinan nilai kode kesalahan dan kode sub-kesalahan.
| Kode | SubCode | Deskripsi |
|---|---|---|
| ServerError | UnexpectedError ResourceError NotImplemented |
Kode status HTTP adalah 500. |
| InvalidRequest | ParameterMissing ParameterInvalidValue HttpNotAllowed Diblokir |
Bing menampilkan InvalidRequest setiap kali bagian mana pun dari permintaan tidak valid. Misalnya, parameter yang diperlukan hilang atau nilai parameter tidak valid. Jika kesalahannya adalah ParameterMissing atau ParameterInvalidValue, kode status HTTP adalah 400. Jika Anda menggunakan protokol HTTP alih-alih HTTPS, Bing menampilkan HttpNotAllowed, dan kode status HTTP adalah 410. |
| RateLimitExceeded | Tidak ada sub-kode | Bing menampilkan RateLimitExceed setiap kali Anda melebihi kuota kueri per detik (QPS) atau kueri per bulan (QPM) Anda. Jika Anda melebihi QPS, Bing menampilkan kode status HTTP 429, dan jika Anda melebihi QPM, Bing menampilkan 403. |
| InvalidAuthorization | AuthorizationMissing AuthorizationRedundancy |
Bing menampilkan InvalidAuthorization saat Bing tidak dapat mengautentikasi pemanggil. Misalnya, header Ocp-Apim-Subscription-Key hilang atau kunci langganan tidak valid.Redundansi terjadi jika Anda menentukan lebih dari satu metode autentikasi. Jika kesalahannya adalah InvalidAuthorization, kode status HTTP adalah 401. |
| InsufficientAuthorization | AuthorizationDisabled AuthorizationExpired |
Bing menampilkan InsufficientAuthorization saat pemanggil tidak memiliki izin untuk mengakses sumber daya. Ini dapat terjadi jika kunci langganan telah dinonaktifkan atau telah kedaluwarsa. Jika kesalahannya adalah InsufficientAuthorization, kode status HTTP adalah 403. |
Kode pasar
Tabel berikut mencantumkan nilai kode pasar yang dapat Anda gunakan untuk menentukan mkt parameter kueri. Bing hanya akan menampilkan konten untuk pasar ini. Daftar ini dapat berubah.
Untuk daftar kode negara yang mungkin Anda tentukan dalam cc parameter kueri, lihat Kode negara.
| Negara/Wilayah | Bahasa | Kode pasar |
|---|---|---|
| Argentina | Spanyol | es-AR |
| Australia | Inggris | en-AU |
| Austria | Jerman | de-AT |
| Belgia | Belanda | nl-BE |
| Belgia | Prancis | fr-BE |
| Brasil | Portugis | pt-BR |
| Kanada | Inggris | en-CA |
| Kanada | Prancis | fr-CA |
| Cile | Spanyol | es-CL |
| Denmark | Dansk | da-DK |
| Finlandia | Suomi | fi-FI |
| Prancis | Prancis | fr-FR |
| Jerman | Jerman | de-DE |
| Hong Kong SAR | Mandarin Tradisional | zh-HK |
| India | Inggris | en-IN |
| Indonesia | Inggris | en-ID |
| Italia | Italia | it-IT |
| Jepang | Jepang | ja-JP |
| Korea | Korea | ko-KR |
| Malaysia | Inggris | en-MY |
| Meksiko | Spanyol | es-MX |
| Belanda | Belanda | nl-NL |
| Selandia Baru | Inggris | en-NZ |
| Republik Rakyat Tiongkok | Mandarin | zh-CN |
| Polandia | Polski | pl-PL |
| Portugal | Portugis | pt-PT |
| Republik Filipina | Inggris | en-PH |
| Rusia | Rusia | ru-RU |
| Arab Saudi | Arab | ar-SA |
| Afrika Selatan | Inggris | en-ZA |
| Spanyol | Spanyol | es-ES |
| Swedia | Swedia | sv-SE |
| Swiss | Prancis | fr-CH |
| Swiss | Jerman | de-CH |
| Taiwan | Mandarin Tradisional | zh-TW |
| Turki | Turki | tr-TR |
| Inggris Raya | Inggris | en-GB |
| Amerika Serikat | Inggris | en-US |
| Amerika Serikat | Spanyol | es-US |
Kode negara
Berikut ini adalah kode negara yang dapat Anda tentukan dalam cc parameter kueri. Daftar ini dapat berubah.
| Negara/Wilayah | Kode negara |
|---|---|
| Argentina | AR |
| Australia | AU |
| Austria | AT |
| Belgia | BE |
| Brasil | BR |
| Kanada | CA |
| Cile | CL |
| Denmark | DK |
| Finlandia | FI |
| Prancis | FR |
| Jerman | DE |
| Hong Kong SAR | HK |
| India | IN |
| Indonesia | ID |
| Italia | IT |
| Jepang | JP |
| Korea | KR |
| Malaysia | MY |
| Meksiko | MX |
| Belanda | NL |
| Selandia Baru | NZ |
| Norwegia | NO |
| Republik Rakyat Tiongkok | CN |
| Polandia | PL |
| Portugal | PT |
| Republik Filipina | PH |
| Rusia | RU |
| Arab Saudi | SA |
| Afrika Selatan | ZA |
| Spanyol | ES |
| Swedia | SE |
| Swiss | CH |
| Taiwan | TW |
| Turki | TR |
| Inggris Raya | GB |
| Amerika Serikat | US |
Bing bahasa yang didukung
Berikut ini adalah Bing bahasa yang didukung yang dapat Anda tentukan dalam setLang parameter kueri. Daftar ini dapat berubah.
| Bahasa yang didukung | Kode Bahasa |
|---|---|
| Arab | ar |
| Basque | eu |
| Bengali | bn |
| Bulgaria | bg |
| Katalan | ca |
| Tionghoa (Aksara Sederhana) | zh-hans |
| Tionghoa (Aksara Tradisional) | zh-hant |
| Kroasia | jam |
| Cheska | cs |
| Denmark | da |
| Belanda | nl |
| Inggris | en |
| Kerajaan English-United | en-gb |
| Esti | et |
| Suomi | fi |
| Prancis | fr |
| Galisia | gl |
| Jerman | de |
| Gujarat | gu |
| Ibrani | he |
| Hindi | hi |
| Hungaria | hu |
| Islandia | is |
| Italia | it |
| Jepang | Jp |
| Kannada | kn |
| Korea | ko |
| Latvi | lv |
| Lituavi | lt |
| Melayu | ms |
| Malayalam | ml |
| Marathi | mr |
| Norwegia (Bokmål) | nb |
| Polandia | pl |
| Portugis (Brasil) | pt-br |
| Portugis (Portugal) | pt-pt |
| Punjabi | pa |
| Rumania | ro |
| Rusia | ru |
| Serbia (Sililik) | sr |
| Slovakia | sk |
| Slovenia | sl |
| Spanyol | es |
| Swedia | sv |
| Tamil | ta |
| Telugu | te |
| Thailand | th |
| Turki | tr |
| Ukraina | uk |
| Vietnam | vi |