Referensi WEB Search API 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 Web memungkinkan Anda mengirim kueri pencarian ke Bing dan mendapatkan kembali hasil pencarian yang menyertakan tautan ke halaman web, gambar, dan lainnya. Bagian ini menyediakan detail teknis tentang halaman web, pencarian terkait, dan hasil peringkat selain parameter kueri yang memengaruhi hasil pencarian. Untuk contoh yang memperlihatkan cara membuat permintaan, lihat Mencari di web.
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 Isi Respons. Referensi ini berisi objek JSON khusus untuk jawaban web. Untuk detail tentang objek JSON untuk jenis jawaban lain yang mungkin disertakan hasil pencarian, lihat dokumentasi referensi khusus API. Misalnya, jika hasil pencarian berisi gambar dan jawaban berita, lihat API Pencarian Gambar dan API Pencarian Berita.
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 hasil pencarian web, kirim permintaan GET ke:
https://api.cognitive.microsoft.com/bing/v7.0/search
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. |
| Pragma | Header permintaan opsional Secara default, Bing menampilkan konten yang di-cache, jika tersedia. Untuk mencegah Bing menampilkan konten yang di-cache, atur header Pragma ke no-cache (misalnya, Pragma: no-cache). |
| 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 adalah parameter kueri yang dapat disertakan dalam permintaan. Kolom Wajib diisi menunjukkan bahwa Anda harus menentukan parameter. Anda harus mengodekan nilai parameter kueri ke dalam URL.
| Nama | Nilai | Jenis | Diperlukan |
|---|---|---|---|
| answerCount | Jumlah jawaban yang Anda inginkan untuk disertakan respons. Jawaban yang Bing kembali didasarkan pada peringkat. Misalnya, jika Bing mengembalikan halaman web, gambar, video, dan relatedSearches untuk permintaan dan Anda mengatur parameter ini ke dua (2), responsnya mencakup halaman web dan gambar. Jika Anda menyertakan responseFilter parameter kueri dalam permintaan yang sama dan mengaturnya ke halaman web dan berita, respons hanya akan menyertakan halaman web.Untuk informasi tentang mempromosikan jawaban berpangkat ke dalam respons, lihat mempromosikan. |
Bilangan Bulat Tidak Bertanda | Tidak |
| 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 ditemukan 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 hasil yang akan dikembalikan dalam respons. Defaultnya adalah 10 dan nilai maksimumnya adalah 50. Jumlah aktual yang dikirimkan mungkin kurang dari yang diminta. Gunakan parameter ini bersama dengan offset parameter ke hasil halaman. Untuk informasi selengkapnya, lihat Halaman Web halaman.Misalnya, jika antarmuka pengguna Anda menampilkan 10 hasil pencarian per halaman, atur count ke 10 dan offset ke 0 untuk mendapatkan halaman pertama hasil. Untuk setiap halaman berikutnya, bertambah offset 10 (misalnya, 0, 10, 20). Dimungkinkan bagi beberapa halaman untuk menyertakan beberapa tumpang tindih dalam hasil. |
UnsignedShort | Tidak |
| Kesegaran | Filter hasil pencarian menurut nilai usia tidak peka huruf besar/kecil berikut:
Untuk mendapatkan artikel yang ditemukan oleh Bing selama jangka waktu tertentu, tentukan rentang tanggal dalam formulir, YYYY-MM-DD.. YYYY-MM-DD. Contohnya: &freshness=2019-02-01..2019-05-30 Untuk membatasi hasil ke satu tanggal, atur parameter ini ke tanggal tertentu. Contohnya:&freshness=2019-02-04 |
String | Tidak |
| 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 hasil pencarian yang akan dilewati sebelum mengembalikan hasil. 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 10 hasil pencarian per halaman, atur count ke 10 dan offset ke 0 untuk mendapatkan halaman pertama hasil. Untuk setiap halaman berikutnya, bertambah offset 10 (misalnya, 0, 10, 20). dimungkinkan bagi beberapa halaman untuk menyertakan beberapa tumpang tindih dalam hasil. |
Pendek Tidak Ditandatangani | Tidak |
| Mempromosikan | Daftar jawaban yang dibatasi koma yang Anda inginkan untuk disertakan respons terlepas dari peringkatnya. Misalnya, jika Anda mengatur answerCount) ke dua (2) sehingga Bing mengembalikan dua jawaban peringkat teratas, tetapi Anda juga ingin respons menyertakan berita, Anda akan diatur promote ke berita. Jika jawaban peringkat teratas adalah halaman web, gambar, video, dan relatedSearches, respons mencakup halaman web dan gambar karena berita bukan jawaban berpangkat. Tetapi jika Anda mengatur promote ke video, Bing akan mempromosikan jawaban video menjadi respons dan mengembalikan halaman web, gambar, dan video.Jawaban yang ingin Anda promosikan tidak dihitung terhadap batas answerCount. Misalnya, jika jawaban pangkat adalah berita, gambar, dan video, dan Anda mengatur answerCount ke 1 dan promote ke berita, respons berisi berita dan gambar. Atau, jika jawaban pangkat adalah video, gambar, dan berita, respons berisi video dan berita.Berikut ini adalah nilai yang mungkin.
CATATAN: Gunakan hanya jika Anda menentukan answerCount. |
String | Tidak |
| q | Istilah kueri pencarian pengguna. Istilah ini mungkin tidak kosong. Istilah ini mungkin berisi Operator Tingkat Lanjut Bing. Misalnya, untuk membatasi hasil ke domain tertentu, gunakan operator site: . |
String | Ya |
| responseFilter | Daftar jawaban yang dibatasi koma untuk disertakan dalam respons. Jika Anda tidak menentukan parameter ini, respons menyertakan semua jawaban pencarian yang ada data yang relevan. Berikut ini adalah kemungkinan nilai filter.
Jika Anda ingin mengecualikan jenis konten tertentu, seperti gambar, dari respons, Anda dapat mengecualikannya dengan awalan tanda hubung (minus) ke nilai responseFilter. Pisahkan jenis yang dikecualikan dengan koma: &responseFilter=-images,-videos Meskipun Anda dapat menggunakan filter ini untuk mendapatkan satu jawaban, Anda harus menggunakan titik akhir khusus jawaban untuk mendapatkan hasil yang lebih kaya. Misalnya, untuk hanya menerima gambar, kirim permintaan ke salah satu titik akhir IMAGE Search API . Jawaban RelatedSearches dan SpellSuggestions tidak mendukung titik akhir terpisah seperti yang dilakukan API Pencarian Gambar (hanya API Pencarian Web yang mengembalikannya). Untuk menyertakan jawaban yang sebaliknya akan dikecualikan karena peringkat, lihat parameter kueri promosi . |
String | Tidak |
| safeSearch | memfilter halaman web untuk konten dewasa. Berikut ini adalah kemungkinan nilai filter.
CATATAN: Untuk hasil video, jika safeSearch diatur ke Nonaktif, Bing mengabaikannya dan menggunakan Moderat.CATATAN: Jika permintaan berasal dari pasar yang diperlukan oleh kebijakan dewasa Bing bahwa safeSearch diatur ke Strict, Bing mengabaikan nilai safeSearch 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 bentuk 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 harus 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 Temuan. |
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 |
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 SearchResponse. Jika permintaan gagal, objek tingkat atas adalah objek ErrorResponse.
Daftar ini berisi objek JSON yang khusus untuk jawaban web. Untuk detail tentang objek JSON untuk jenis jawaban lain yang mungkin disertakan hasil pencarian, lihat dokumentasi referensi khusus API. Misalnya, jika hasil pencarian berisi gambar dan jawaban berita, lihat API Gambar dan API Berita.
| Objek | Deskripsi |
|---|---|
| Komputasi | Mendefinisikan ekspresi dan jawabannya. |
| Entitas | Mendefinisikan entitas seperti seseorang, tempat, atau hal. |
| Kesalahan | Menentukan kesalahan yang terjadi. |
| ErrorResponse | Objek tingkat atas yang disertakan respons saat permintaan gagal. |
| Dapat diidentifikasi | Menentukan ID sumber daya. |
| LicenseAttribution | Menentukan aturan kontrak untuk atribusi lisensi. |
| LinkAttribution | Menentukan aturan kontraktual untuk atribusi tautan. |
| MediaAttribution | Mendefinisikan aturan kontraktual untuk atribusi media. |
| Kueri | Menentukan string kueri. |
| QueryContext | Menentukan konteks kueri yang Bing digunakan untuk permintaan, jika string kueri yang ditentukan berisi kesalahan ejaan. |
| RankingGroup | Menentukan grup hasil pencarian, seperti jalur utama. |
| RankingItem | Menentukan item grup peringkat yang akan ditampilkan. |
| RankingResponse | Menentukan tempat konten halaman hasil pencarian harus ditempatkan dan dalam urutan apa. |
| RelatedSearchAnswer | Menentukan daftar kueri terkait yang dibuat oleh orang lain. |
| SearchResponse | Objek tingkat atas yang disertakan respons saat permintaan berhasil. |
| SpellSuggestions | Menentukan string kueri yang disarankan yang kemungkinan mewakili niat pengguna. |
| TextAttribution | Menentukan aturan kontraktual untuk atribusi teks biasa. |
| Zona Waktu | Menentukan tanggal dan waktu satu atau beberapa lokasi geografis. |
| TimeZoneInformation | Menentukan informasi zona waktu tentang lokasi geografis. |
| WebAnswer | Menentukan daftar tautan halaman web yang relevan. |
| Halaman web | Menentukan halaman web yang relevan dengan kueri. |
Entitas
Mendefinisikan entitas seperti seseorang, tempat, atau hal.
| Nama | Nilai | Jenis |
|---|---|---|
| bingId | ID yang secara unik mengidentifikasi entitas ini. | String |
| contractualRules | Daftar aturan yang harus Anda patuhi jika Anda menampilkan entitas. Misalnya, aturan dapat mengatur pengambilan deskripsi entitas. Aturan kontrak berikut mungkin berlaku. Tidak semua entitas menyertakan aturan. Jika entitas menyediakan aturan kontrak, Anda harus mematuhinya. Untuk informasi selengkapnya tentang menggunakan aturan kontrak, lihat Mengambil Data. |
Objek[] |
| deskripsi | Deskripsi singkat tentang entitas. | String |
| entityPresentationInfo | Informasi tambahan tentang entitas seperti petunjuk yang dapat Anda gunakan untuk menentukan jenis entitas. Untuk menentukan jenis entitas, gunakan entityScenario bidang dan entityTypeHint . Misalnya, bidang membantu Anda menentukan apakah entitas tersebut adalah entitas dominan atau disambiguasi dan apakah itu orang atau film. Entitas adalah entitas dominan jika Bing percaya bahwa hanya satu entitas yang memenuhi permintaan. Jika beberapa entitas dapat memenuhi permintaan, entitas adalah entitas disambiguasi dan pengguna perlu memilih entitas yang mereka minati. |
EntityPresentationInfo |
| gambar | Gambar entitas. | Gambar |
| name | Nama entitas. | String |
| webSearchUrl | URL yang membawa pengguna ke halaman hasil pencarian Bing untuk entitas ini. | String |
EntityAnswer
Menentukan jawaban entitas.
| Nama | Nilai | Jenis |
|---|---|---|
| queryScenario | Skenario kueri yang didukung. Bidang ini diatur ke DominantEntity atau DisambiguationItem. Bidang diatur ke DominantEntity jika Bing menentukan bahwa hanya satu entitas yang memenuhi permintaan. Misalnya, buku, film, orang, atau atraksi. Jika beberapa entitas dapat memenuhi permintaan, bidang diatur ke DisambiguationItem. Misalnya, jika permintaan menggunakan judul generik waralaba film, jenis entitas kemungkinan adalah DisambiguationItem. Tetapi, jika permintaan menentukan judul tertentu dari waralaba, jenis entitas kemungkinan adalah DominantEntity. | String |
| nilai | Daftar entitas. | Entitas[] |
EntityPresentationInfo
Menentukan informasi tambahan tentang entitas seperti petunjuk jenis.
| Nama | Nilai | Jenis |
|---|---|---|
| entityScenario | Skenario yang didukung. | String |
| entityTypeDisplayHint | Versi tampilan petunjuk entitas. Misalnya, jika entityTypeHints artis, bidang ini dapat diatur ke Penyanyi Amerika. |
String |
| entityTypeHint | Daftar petunjuk yang menunjukkan jenis entitas. Daftar ini dapat berisi satu petunjuk seperti Film atau daftar petunjuk seperti Place, LocalBusiness, Restaurant. Setiap petunjuk berturut-turut dalam array mempersempit jenis entitas. Untuk daftar jenis yang mungkin, lihat Jenis Entitas. Jika objek tidak menyertakan bidang ini, Generik diasumsikan. |
Untai[] |
Komputasi
Mendefinisikan ekspresi dan jawabannya.
| Elemen | Deskripsi | Jenis |
|---|---|---|
| Ekspresi | Ekspresi matematika atau konversi. Jika kueri berisi permintaan untuk mengonversi satuan pengukuran (misalnya, meter ke kaki), bidang ini berisi unit dari dan value berisi satuan ke .Jika kueri berisi ekspresi matematika seperti 2+2, bidang ini berisi ekspresi dan value berisi jawabannya.Perhatikan bahwa ekspresi matematika dapat dinormalisasi. Misalnya, jika kueri adalah sqrt(4^2+8^2), ekspresi yang dinormalisasi mungkin sqrt((4^2)+(8^2)). Jika kueri pengguna adalah pertanyaan matematika dan parameter kueri textDecorations diatur ke true, string ekspresi mungkin menyertakan penanda pemformatan. Misalnya, jika kueri pengguna adalah log(2), ekspresi yang dinormalisasi menyertakan penanda subskrip. Untuk informasi selengkapnya, lihat Penyorotan Temuan. |
String |
| value | Jawaban ekspresi. | 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[] |
Dapat diidentifikasi
Menentukan identitas sumber daya.
| Nama | Nilai | Jenis |
|---|---|---|
| id | Pengidentifikasi. | String |
Gambar
Mendefinisikan gambar.
Catatan
Karena format URL dan parameter dapat berubah tanpa pemberitahuan, semua URL gambar harus digunakan apa adanya; Anda tidak boleh mengambil dependensi pada format atau parameter URL. Pengecualiannya adalah parameter dan nilai yang dibahas oleh Mengubah ukuran dan memangkas gambar mini.
| Nama | Nilai | Jenis |
|---|---|---|
| tinggi | Tinggi gambar sumber, dalam piksel. | Pendek Tidak Ditandatangani |
| hostPageUrl | URL halaman web yang menyertakan gambar. URL ini dan contentUrl mungkin URL yang sama. |
String |
| nama | String teks opsional yang berisi informasi acak tentang gambar. | String |
| penyedia | Sumber gambar. Array akan berisi satu item. Anda harus mengaitkan gambar ke penyedia. Misalnya, Anda dapat menampilkan nama penyedia saat kursor mengarahkan kursor ke atas gambar atau membuat gambar menjadi tautan klik-tayang ke situs web penyedia tempat gambar ditemukan. |
Organisasi[] |
| thumbnailUrl | URL ke gambar mini gambar. Untuk informasi tentang mengubah ukuran gambar, lihat Mengubah ukuran dan memotong gambar mini. | String |
| lebar | Lebar gambar sumber, dalam piksel. | Pendek Tidak Ditandatangani |
LicenseAttribution
Menentukan aturan kontrak untuk atribusi lisensi.
| Nama | Nilai | Jenis |
|---|---|---|
| _type | Petunjuk jenis, yang diatur ke LicenseAttribution. | String |
| lisensi | Lisensi tempat konten dapat digunakan. | Lisensi |
| licenseNotice | Lisensi untuk ditampilkan di samping bidang yang ditargetkan. Misalnya, "Teks di bawah lisensi CC-BY-SA". Gunakan nama lisensi dan URL di license bidang untuk membuat hyperlink ke situs web yang menjelaskan detail lisensi. Kemudian, ganti nama lisensi dalam licenseNotice string (misalnya, CC-BY-SA) dengan hyperlink yang baru saja Anda buat. |
String |
| mustBeCloseToContent | Nilai Boolean yang menentukan apakah konten aturan harus ditempatkan di dekat bidang tempat aturan diterapkan. Jika true, konten harus ditempatkan dalam jarak dekat. Jika false, atau bidang ini tidak ada, konten dapat ditempatkan atas kebijakan pemanggil. | Boolean |
| targetPropertyName | Nama bidang tempat aturan berlaku. | String |
LinkAttribution
Menentukan aturan kontraktual untuk atribusi tautan.
| Nama | Nilai | Jenis |
|---|---|---|
| _type | Petunjuk jenis, yang diatur ke LinkAttribution. | String |
| mustBeCloseToContent | Nilai Boolean yang menentukan apakah konten aturan harus ditempatkan di dekat bidang tempat aturan diterapkan. Jika true, konten harus ditempatkan dalam jarak dekat. Jika false, atau bidang ini tidak ada, konten dapat ditempatkan berdasarkan kebijaksanaan pemanggil. | Boolean |
| targetPropertyName | Nama bidang tempat aturan diterapkan. Jika target tidak ditentukan, atribusi berlaku untuk entitas secara keseluruhan dan harus ditampilkan segera setelah presentasi entitas. Jika ada beberapa aturan atribusi teks dan tautan yang tidak menentukan target, Anda harus menggabungkannya dan menampilkannya menggunakan label "Data dari: ". Misalnya, "Data dari <nama penyedia1> | < nama penyedia2>". |
String |
| teks | Teks atribusi. | String |
| url | URL ke situs web penyedia. Gunakan text URL dan untuk membuat hyperlink. |
String |
MediaAttribution
Menentukan aturan kontrak untuk atribusi media.
| Nama | Nilai | Jenis |
|---|---|---|
| _type | Petunjuk jenis, yang diatur ke MediaAttribution. | String |
| mustBeCloseToContent | Nilai Boolean yang menentukan apakah konten aturan harus ditempatkan di dekat bidang tempat aturan diterapkan. Jika true, konten harus ditempatkan dalam jarak dekat. Jika false, atau bidang ini tidak ada, konten dapat ditempatkan berdasarkan kebijaksanaan pemanggil. | Boolean |
| targetPropertyName | Nama bidang tempat aturan diterapkan. | String |
| url | URL yang Anda gunakan untuk membuat hyperlink konten media. Misalnya, jika target adalah gambar, Anda akan menggunakan URL untuk membuat gambar dapat diklik. | String |
Metatag
Menentukan metadata halaman web.
| Nama | Nilai | Jenis |
|---|---|---|
| konten | Metadata. | String |
| nama | Nama metadata. | String |
Organisasi
Mendefinisikan penerbit.
Perhatikan bahwa penerbit dapat memberikan nama atau situs web mereka atau keduanya.
| Nama | Nilai | Jenis |
|---|---|---|
| name | Nama penerbit. | String |
| url | URL ke situs web penerbit. Perhatikan bahwa penerbit mungkin tidak menyediakan situs web. |
String |
Kueri
Menentukan kueri pencarian.
Objek SpellSuggestions menggunakan objek ini untuk menyarankan string kueri yang kemungkinan mewakili niat pengguna. Ini juga digunakan oleh RelatedSearchAnswer untuk mengembalikan kueri terkait yang telah dibuat pengguna lain.
| Nama | Nilai | Jenis |
|---|---|---|
| displayText | Versi tampilan istilah kueri. Versi istilah kueri ini mungkin berisi karakter khusus yang menyoroti istilah pencarian yang ditemukan dalam string kueri. String berisi karakter penyorotan hanya jika penyorotan klik yang diaktifkan kueri (lihat parameter kueri textDecorations ). Untuk detail tentang penyorotan temuan, lihat Penyorotan Klik. | String |
| Teks | String kueri. Gunakan string ini sebagai istilah kueri dalam permintaan pencarian baru. | String |
| webSearchUrl | URL yang membawa pengguna ke halaman hasil pencarian Bing untuk kueri. Hanya hasil pencarian terkait yang menyertakan bidang ini. |
String |
QueryContext
Menentukan string kueri yang Bing gunakan untuk permintaan tersebut.
| Elemen | Deskripsi | Jenis |
|---|---|---|
| adultIntent | Nilai Boolean yang menunjukkan apakah kueri yang ditentukan memiliki niat dewasa. Nilainya benar jika kueri memiliki niat dewasa. Jika true, dan parameter kueri safeSearch permintaan diatur ke Strict, respons hanya berisi hasil berita, jika berlaku. |
Boolean |
| alterationOverrideQuery | String kueri yang digunakan untuk memaksa Bing menggunakan string asli. Misalnya, jika string kueri saling downwind, string kueri penimpaan adalah +saling downwind. Ingatlah untuk mengodekan string kueri, yang menghasilkan %2Bsaling+downwind. objek menyertakan bidang ini hanya jika string kueri asli berisi kesalahan ejaan. |
String |
| alteredQuery | String kueri yang Bing digunakan untuk melakukan kueri. Bing menggunakan string kueri yang diubah jika string kueri asli berisi kesalahan ejaan. Misalnya, jika string kueri adalah saling downwind, string kueri yang diubah adalah sailing downwind.Objek menyertakan bidang ini hanya jika string kueri asli berisi kesalahan ejaan. |
String |
| askUserForLocation | Nilai Boolean yang menunjukkan apakah Bing memerlukan lokasi pengguna untuk memberikan hasil yang akurat. Jika Anda menentukan lokasi pengguna menggunakan header X-MSEdge-ClientIP dan X-Search-Location, Anda dapat mengabaikan bidang ini. Untuk kueri dengan info lokasi, seperti "cuaca hari ini" atau "restoran di dekat saya" yang membutuhkan lokasi pengguna untuk memberikan hasil yang akurat, bidang ini diatur ke true. Untuk kueri dengan info lokasi yang menyertakan lokasi (misalnya, "Cuaca Seattle"), bidang ini diatur ke false. Bidang ini juga diatur ke false untuk kueri yang tidak mengetahui lokasi, seperti "best seller." |
Boolean |
| originalQuery | String kueri seperti yang ditentukan dalam permintaan. | String |
RankingGroup
Menentukan grup hasil pencarian, seperti jalur utama.
| Nama | Nilai | Jenis |
|---|---|---|
| items | Daftar item hasil pencarian untuk ditampilkan dalam grup. | RankingItem[] |
RankingItem
Menentukan item hasil pencarian untuk ditampilkan. Untuk informasi selengkapnya tentang cara menggunakan ID, lihat Menggunakan Peringkat untuk Menampilkan Hasil.
| Nama | Nilai | Jenis |
|---|---|---|
| answerType | Jawaban yang berisi item yang akan ditampilkan. Misalnya, Berita. Gunakan jenis untuk menemukan jawaban di objek SearchResponse . Jenisnya adalah nama SearchResponse bidang. |
String |
| resultIndex | Indeks berbasis nol item dalam jawabannya. Jika item tidak menyertakan bidang ini, tampilkan semua item dalam jawabannya. Misalnya, tampilkan semua artikel berita di jawaban Berita. |
Bilangan bulat |
| value | ID yang mengidentifikasi jawaban untuk menampilkan atau item jawaban untuk ditampilkan. Jika ID mengidentifikasi jawaban, tampilkan semua item jawabannya. | Dapat diidentifikasi |
RankingResponse
Menentukan tempat konten halaman hasil pencarian harus ditempatkan dan dalam urutan apa.
| Nama | Nilai | Jenis |
|---|---|---|
| mainline | Hasil pencarian untuk ditampilkan di garis utama. | RankingGroup |
| pole | Hasil pencarian yang harus diberikan perawatan yang paling terlihat (misalnya, ditampilkan di atas garis utama dan bilah samping). | RankingGroup |
| sidebar | Hasil pencarian ditampilkan di bilah samping. | RankingGroup |
RelatedSearchAnswer
Menentukan daftar kueri terkait yang dibuat oleh orang lain.
| Nama | Nilai | Jenis |
|---|---|---|
| id | ID yang secara unik mengidentifikasi jawaban pencarian terkait. Objek menyertakan bidang ini hanya jika jawaban Peringkat menentukan bahwa Anda menampilkan semua pencarian terkait dalam grup. Untuk informasi selengkapnya tentang cara menggunakan ID, lihat Menggunakan Peringkat untuk Menampilkan Hasil. |
String |
| value | Daftar kueri terkait yang dibuat oleh orang lain. | Kueri[] |
SearchResponse
Objek tingkat atas respons untuk permintaan pencarian.
Secara default, Search API menyertakan semua jawaban kecuali:
Kueri menentukan parameter kueri responseFilter untuk membatasi jawaban
Satu atau beberapa komponen pencarian tidak mengembalikan hasil (misalnya, tidak ada hasil berita yang relevan dengan kueri)
Kunci langganan tidak memiliki akses ke komponen pencarian.
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 |
| Perhitungan | Jawaban untuk ekspresi matematika atau ekspresi konversi unit. | Komputasi |
| entities | Daftar entitas yang relevan dengan kueri pencarian. | EntityAnswer |
| Gambar | Daftar gambar yang relevan dengan kueri pencarian. | Citra |
| Berita | Daftar artikel berita yang relevan dengan kueri pencarian. | Berita |
| queryContext | String kueri yang Bing digunakan untuk permintaan. Respons hanya menyertakan konteks jika string kueri berisi kesalahan ejaan atau memiliki niat dewasa. |
QueryContext |
| rankingResponse | Urutan yang Bing menyarankan Agar Anda menampilkan hasil pencarian. | RankingResponse |
| relatedSearches | Daftar kueri terkait yang dibuat oleh orang lain. | RelatedSearchAnswer |
| spellSuggestions | String kueri yang kemungkinan mewakili niat pengguna. | SpellSuggestions |
| zona waktu | Tanggal dan waktu satu atau beberapa lokasi geografis. | Zona Waktu |
| Video | Daftar video yang relevan dengan kueri pencarian. | Video |
| Laman web | Daftar halaman web yang relevan dengan kueri pencarian. | WebAnswer |
SpellSuggestions
Menentukan string kueri yang disarankan yang kemungkinan mewakili niat pengguna.
Hasil pencarian mencakup respons ini jika Bing menentukan bahwa pengguna mungkin berniat mencari sesuatu yang berbeda. Misalnya, jika pengguna mencari alon brown, Bing dapat menentukan bahwa pengguna kemungkinan bermaksud mencari Alton Brown sebagai gantinya (berdasarkan pencarian sebelumnya oleh orang lain dari Alon Brown).
| Nama | Nilai | Jenis |
|---|---|---|
| id | ID yang secara unik mengidentifikasi jawaban saran ejaan. Anda menggunakan bidang ini saat Anda menggunakan respons peringkat untuk menampilkan saran ejaan. Untuk informasi selengkapnya tentang cara menggunakan ID, lihat Menggunakan Peringkat untuk Menampilkan Hasil. |
String |
| value | Daftar string kueri yang disarankan yang dapat mewakili niat pengguna. Daftar ini hanya berisi satu Query objek. |
Kueri[] |
TextAttribution
Menentukan aturan kontrak untuk atribusi teks biasa.
| Nama | Nilai | Jenis |
|---|---|---|
| _type | Petunjuk jenis, yang diatur ke TextAttribution. | String |
| teks | Teks atribusi. Atribusi teks berlaku untuk entitas secara keseluruhan dan harus ditampilkan segera setelah presentasi entitas. Jika ada beberapa aturan atribusi teks atau tautan yang tidak menentukan target, Anda harus menggabungkannya dan menampilkannya menggunakan label "Data dari: ". |
String |
TimeZone
Menentukan data dan waktu satu atau beberapa lokasi geografis.
| Nama | Nilai | Jenis |
|---|---|---|
| otherCityTimes | Daftar tanggal dan waktu zona waktu terdekat. | TimeZoneInformation[] |
| primaryCityTime | Data dan waktu, dalam UTC, dari lokasi geografis yang ditentukan dalam kueri. Jika kueri menentukan lokasi geografis tertentu (misalnya, kota), objek ini berisi nama lokasi geografis dan tanggal dan waktu lokasi saat ini, di UTC. Jika kueri menentukan lokasi geografis umum, seperti negara bagian atau negara, objek ini berisi tanggal dan waktu kota utama atau negara bagian yang ditemukan dalam status atau negara yang ditentukan. Jika lokasi berisi zona waktu tambahan, otherCityTimes bidang berisi data dan waktu kota atau status yang terletak di zona waktu lain. |
TimeZoneInformation |
TimeZoneInformation
Menentukan tanggal dan waktu untuk lokasi geografis.
WebAnswer
Menentukan daftar tautan halaman web yang relevan.
| Nama | Nilai | Jenis |
|---|---|---|
| id | ID yang secara unik mengidentifikasi jawaban web. Objek menyertakan bidang ini hanya jika jawaban Peringkat menyarankan agar Anda menampilkan semua hasil web dalam grup. Untuk informasi selengkapnya tentang cara menggunakan ID, lihat Menggunakan Peringkat untuk Menampilkan Hasil. |
String |
| someResultsRemoved | Nilai Boolean yang menunjukkan apakah respons mengecualikan beberapa hasil dari jawaban. Jika Bing mengecualikan beberapa hasil, nilainya benar. | Boolean |
| totalEstimatedMatches | Perkiraan jumlah halaman web yang relevan dengan kueri. Gunakan nomor ini bersama dengan parameter kueri hitungan dan offset untuk halaman hasilnya. | Long |
| value | Daftar halaman web yang relevan dengan kueri. | Halaman Web[] |
| webSearchUrl | URL ke hasil pencarian Bing untuk halaman web yang diminta. | String |
Halaman web
Menentukan halaman web yang relevan dengan kueri.
| Nama | Nilai | Jenis |
|---|---|---|
| tentang | Hanya untuk penggunaan internal. | Object |
| dateLastCrawled | Terakhir kali Bing merayapi halaman web. Tanggal dalam bentuk, YYYY-MM-DDTHH:MM:SS. Misalnya, 2015-04-13T05:23:39. | String |
| deepLinks | Daftar tautan ke isi terkait yang Bing temukan di situs web yang berisi halaman web ini. Objek Webpage dalam konteks ini hanya namemencakup bidang , , urlurlPingSuffix, dan snippet . |
Halaman web[] |
| displayUrl | URL tampilan halaman web. URL dimaksudkan hanya untuk tujuan tampilan dan tidak terbentuk dengan baik. | String |
| id | ID yang secara unik mengidentifikasi halaman web ini dalam daftar hasil web. Objek menyertakan bidang ini hanya jika jawaban Peringkat menentukan bahwa Anda mencampur halaman web dengan hasil pencarian lainnya. Setiap halaman web berisi ID yang cocok dengan ID dalam jawaban Peringkat. Untuk informasi selengkapnya, lihat Menggunakan Peringkat untuk Menampilkan Hasil. |
String |
| nama | Nama halaman web. Gunakan nama ini bersama dengan url untuk membuat hyperlink yang ketika diklik membawa pengguna ke halaman web. |
String |
| Menyebutkan | Hanya untuk penggunaan internal. | Object |
| searchTags | Daftar tag pencarian yang ditentukan pemilik halaman web pada halaman web. API hanya mengembalikan tag pencarian terindeks. Bidang nameMetaTag objek berisi tag pencarian terindeks. Tag pencarian dimulai dengan search.* (misalnya, search.assetId). Bidang content berisi nilai tag. |
MetaTag[] |
| Potongan | Cuplikan teks dari halaman web yang menjelaskan isinya. | String |
| Url | URL ke halaman web. Gunakan URL ini bersama dengan name untuk membuat hyperlink yang ketika diklik membawa pengguna ke halaman web. |
String |
Jenis Entitas
Bagian ini berisi kemungkinan petunjuk entitas. Petunjuk dikelompokkan menurut kategori entitas.
Berikut ini adalah jenis entitas dasar.
- Generik
- Orang
- Tempat
- Media
- Organisasi
Berikut ini adalah petunjuk entitas yang termasuk dalam jenis dasar Tempat.
- Daya tarik
- Kota
- Benua
- Negara
- Hotel
- Rumah
- LocalBusiness
- Wilayah
- MinorRegion
- Neighborhood
- Lainnya
- PointOfInterest
- KodePos
- RadioStation
- Wilayah
- Restaurant
- Provinsi
- StreetAddress
- SubRegion
- TouristAttraction
- Perjalanan
Berikut ini adalah petunjuk entitas yang termasuk dalam jenis dasar Media.
- Buku
- Film
- TelevisiSeason
- Tayangan Televisi
- VideoGame
Berikut ini adalah petunjuk entitas terkait peristiwa.
- Kejadian
Berikut ini adalah petunjuk entitas terkait profesi.
- Actor
- Artis
- Pengacara
Berikut ini adalah petunjuk entitas terkait pendidikan.
- CollegeOrUniversity
- Sekolah
- Spesialisasi
Berikut ini adalah petunjuk entitas yang tidak terkait.
- Binatang
- Mobil
- Obat
- Makanan
- Produk
- SportsTeam
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 |
| Norwegia | Norwegia | no-NO |
| Republik Rakyat Tiongkok | Mandarin | zh-CN |
| Polandia | Polski | pl-PL |
| Republik Filipina | Inggris | en-PH |
| Rusia | Rusia | ru-RU |
| 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 |