Referensi API Pencarian Berita 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 Berita memungkinkan Anda mengirim kueri pencarian ke Bing dan mendapatkan kembali daftar artikel berita yang relevan. Bagian ini menyediakan detail teknis tentang parameter dan header kueri yang Anda gunakan untuk meminta artikel berita dan objek respons JSON yang berisinya. Untuk contoh yang memperlihatkan cara membuat permintaan, lihat Mencari Web untuk Berita.
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 respons, lihat Objek Respons.
Untuk informasi tentang penggunaan dan tampilan hasil yang diizinkan, lihat persyaratan Penggunaan dan Tampilan SEARCH API 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 artikel berita, kirim permintaan GET ke salah satu URL berikut:
| URL | Deskripsi |
|---|---|
https://api.cognitive.microsoft.com/bing/v7.0/news |
Mengembalikan artikel berita teratas menurut kategori. Misalnya, Anda dapat meminta artikel olahraga atau hiburan teratas. Untuk informasi tentang menentukan kategori, lihat parameter kueri kategori . |
https://api.cognitive.microsoft.com/bing/v7.0/news/search |
Mengembalikan artikel berita berdasarkan kueri pencarian pengguna. Jika kueri pencarian kosong, panggilan mengembalikan artikel berita teratas. |
https://api.cognitive.microsoft.com/bing/v7.0/news/trendingtopics |
Mengembalikan topik berita yang sedang tren yang sedang tren di jejaring sosial. CATATAN: Hanya tersedia di pasar en-US dan zh-CN. |
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; HTTP tidak didukung.
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 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 |
|---|---|---|---|
| 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 |
| Kategori | Kategori artikel yang akan dikembalikan. Misalnya, artikel Olahraga atau artikel Hiburan. Untuk daftar kategori yang mungkin, lihat Kategori Berita menurut Pasar. Gunakan parameter ini hanya dengan permintaan kategori berita (lihat titik akhir /news). Jika Anda tidak menentukan parameter ini, respons mencakup keduanya:
Jika Anda tidak menentukan headlineCount dan pasar mendukung delapan kategori, respons mencakup hingga 44 artikel dan kluster (12 artikel dan kluster utama ditambah artikel dan kluster khusus kategori 32). Karena kluster berisi lebih dari satu artikel, jumlah artikel dalam contoh ini, 44, bisa lebih banyak. Misalnya, respons dapat mencakup 11 artikel utama dan satu kluster, yang berisi empat artikel utama terkait dengan total 15 artikel utama. |
String | Tidak |
| jumlah | Jumlah artikel berita yang akan dikembalikan dalam respons. Jumlah aktual yang dikirimkan mungkin kurang dari yang diminta. Defaultnya adalah 10 dan nilai maksimumnya adalah 100. Untuk topik yang sedang tren, defaultnya adalah semua topik berita yang sedang tren (sekitar 55 artikel). Anda dapat menggunakan parameter ini bersama dengan offset parameter ke hasil halaman. Misalnya, jika antarmuka pengguna Anda menampilkan 20 artikel 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.CATATAN: Kluster dihitung sebagai satu item. Misalnya, jika Anda mengatur hitungan ke 10, respons dapat mencakup 9 artikel dan 1 kluster tetapi kluster mungkin berisi 5 artikel. CATATAN: Jika Anda meminta kategori berita, tentukan parameter ini hanya jika Anda menentukan parameter kategori. Jika Anda tidak menentukan parameter kategori, Bing mengabaikan parameter ini. |
UnsignedShort | Tidak |
| Kesegaran | Filter artikel berita menurut nilai usia berikut:
|
String | Tidak |
| headlineCount | Jumlah artikel dan kluster utama yang akan dikembalikan. Defaultnya adalah 12. Tentukan parameter ini hanya jika Anda tidak menentukan parameter kategori. Jika Anda menentukan parameter kategori, Bing mengabaikan parameter ini. Gunakan parameter ini hanya dengan permintaan kategori berita. |
UnsignedShort | 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> bahasa> kode negara<. Misalnya, en-US. String tidak peka huruf besar/kecil. Untuk daftar kemungkinan nilai pasar, lihat Kode Pasar.CATATAN: Jika diketahui, Anda dianjurkan 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 artikel berita yang akan dilewati sebelum mengembalikan artikel. 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 artikel 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.CATATAN: Kluster dihitung sebagai satu item. Misalnya, jika Anda mengatur hitungan ke 10, respons dapat mencakup 9 artikel dan 1 kluster tetapi kluster mungkin berisi 5 artikel. CATATAN: Jika meminta kategori berita, tentukan parameter ini hanya jika Anda menentukan parameter kategori. Jika Anda tidak menentukan parameter kategori, Bing mengabaikan parameter ini. |
Pendek Tidak Ditandatangani | Tidak |
| originalImg | Nilai Boolean yang menentukan apakah gambar contentUrl berisi URL yang menunjuk ke gambar mini gambar artikel asli atau gambar itu sendiri.Jika artikel menyertakan gambar, dan parameter ini diatur ke true, properti gambar contentUrl berisi URL yang dapat Anda gunakan untuk mengunduh gambar asli dari situs web penerbit. Jika tidak, jika parameter ini salah, URL dan thumbnailUrl gambar contentUrl keduanya menunjuk ke gambar mini yang sama.Defaultnya adalah false. Gunakan parameter ini hanya dengan API Pencarian Berita. Jangan tentukan parameter ini saat memanggil WEB Search API. Topik yang Sedang Tren mengabaikan parameter ini. |
Boolean | Tidak |
| q | Istilah kueri pencarian pengguna. Jika istilah kosong (misalnya, q=), respons menyertakan berita teratas. Istilah string mungkin berisi Bing Operator Tingkat Lanjut. Misalnya, untuk membatasi berita ke domain tertentu, gunakan operator situs: . Jika Anda mendapatkan artikel berita berdasarkan kategori, jangan sertakan parameter ini. Topik yang Sedang Tren mengabaikan parameter ini. |
String | Ya |
| safeSearch | Memfilter artikel berita untuk konten dewasa. Berikut ini adalah kemungkinan nilai filter.
Defaultnya adalah Moderate. CATATAN: Jika permintaan berasal dari pasar yang diperlukan oleh kebijakan dewasa Bing bahwa safeSearch diatur ke Strict, Bing mengabaikan nilai safeSearch dan menggunakan Strict. |
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 |
| sejak | Waktu epoch Unix (tanda waktu Unix) yang Bing gunakan untuk memilih topik yang sedang tren. Bing mengembalikan topik yang sedang tren yang ditemukan pada atau setelah tanggal dan waktu yang ditentukan, bukan tanggal topik diterbitkan. Untuk menggunakan parameter ini, tentukan sortBy juga parameter . |
Bilangan bulat | Tidak |
| sortBy | Urutan untuk mengembalikan topik yang sedang tren. Berikut adalah nilai yang mungkin tidak peka huruf besar/kecil.
Jika Anda tidak menentukan parameter ini, tidak ada urutan tertentu. Namun, kesegaran topik, kategori, keterlibatan pengguna global, dan fitur yang dipersonalisasi diperingatkan. |
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 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 Klik. Untuk string tampilan yang berisi karakter HTML yang dapat dilepaskan seperti <, , >dan &, jika textFormat diatur ke HTML, Bing keluar dari karakter yang sesuai (misalnya, < diloloskan ke <).Untuk informasi tentang memproses string dengan karakter Unicode yang disematkan, lihat Penyorotan Klik. |
String | Tidak |
Objek respons
Catatan
Untuk mematuhi Petunjuk Hak Cipta UE baru di Prancis, Bing Web, Berita, Video, Gambar, dan semua API 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 menyajikan lebih sedikit hasil dengan gambar dan video gambar mini, pratinjau video, dan cuplikan kepada pengguna Prancis.
Berikut ini adalah objek JSON yang mungkin disertakan oleh respons. Jika permintaan berhasil, objek tingkat atas dalam respons adalah objek Berita jika titik akhir adalah /news/search atau /news, dan TrendingTopicAnswer jika titik akhir adalah /news/trendingtopics. Jika permintaan gagal, objek tingkat atas adalah objek ErrorResponse.
| Objek | Deskripsi |
|---|---|
| Kesalahan | Menentukan kesalahan yang terjadi. |
| ErrorResponse | Menentukan objek tingkat atas yang disertakan respons saat permintaan gagal. |
| Gambar | Menentukan gambar mini gambar terkait berita. |
| MediaSize | Menentukan ukuran konten media. |
| Berita | Menentukan objek tingkat atas yang disertakan respons saat permintaan berita berhasil. |
| NewsArticle | Mendefinisikan artikel berita. |
| Organisasi | Menentukan penyedia yang menjalankan artikel. |
| Kueri | Menentukan string kueri pencarian. |
| RelatedTopic | Menentukan daftar artikel berita yang terkait dengan kueri pencarian. |
| Gambar mini | Menentukan tautan ke gambar terkait. |
| Topik | Mendefinisikan topik berita yang sedang tren. |
| TrendingTopics | Menentukan objek tingkat atas yang disertakan respons saat permintaan topik yang sedang tren berhasil. |
| Video Menentukan video yang terkait dengan artikel berita. |
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 gambar terkait berita.
| Nama | Nilai | Jenis |
|---|---|---|
| penyedia | Daftar pemilik gambar. | Organisasi |
| gambar mini | Tautan ke gambar mini gambar. | Gambar mini |
| url | URL ke gambar. | String |
MediaSize
Menentukan ukuran isi media.
| Nama | Nilai | Jenis |
|---|---|---|
| tinggi | Tinggi konten media, dalam piksel. | Bilangan bulat |
| lebar | Lebar konten media, dalam piksel. | Bilangan bulat |
Berita
Menentukan objek tingkat atas yang disertakan respons saat permintaan berita 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 berita. Untuk informasi tentang cara menggunakan bidang ini, lihat Menggunakan Peringkat untuk Menampilkan Hasil di panduan API Pencarian Web. |
String |
| readLink | URL yang mengembalikan jawaban ini. Untuk menggunakan URL, tambahkan parameter kueri yang sesuai dan sertakan header Ocp-Apim-Subscription-Key . WEB Search API menyertakan bidang ini. Biasanya, Anda akan menggunakan URL jika ingin mengkueri API Pencarian Berita secara langsung. |
String |
| relatedTopics | Daftar artikel berita yang terkait dengan istilah pencarian. | RelatedTopic[] |
| Semacam | Daftar opsi untuk mengurutkan artikel berita. Misalnya, urutkan menurut relevansi (default) atau tanggal. Untuk menentukan urutan urutan permintaan yang digunakan, lihat isSelected bidang . |
SortValue[] |
| totalEstimatedMatches | Perkiraan jumlah artikel berita yang relevan dengan kueri. Gunakan angka ini bersama dengan parameter kueri hitungan dan offset untuk halaman hasilnya. Hanya API Pencarian Berita yang menyertakan bidang ini (API Pencarian Web tidak). |
Long |
| value | Daftar artikel berita yang relevan dengan istilah kueri. Jika tidak ada hasil untuk permintaan, array kosong. |
NewsArticle[] |
NewsArticle
Mendefinisikan artikel berita.
| Nama | Nilai | Jenis |
|---|---|---|
| Kategori | Kategori berita yang dimiliki artikel tersebut. Misalnya, Olahraga. Jika kategori berita tidak dapat ditentukan, artikel tidak menyertakan bidang ini. Untuk daftar kategori yang mungkin, lihat Kategori Berita menurut Pasar. Jika permintaan Anda menentukan kategori Sports-Tennis, category properti mungkin berisi Sports-Tennis atau Olahraga. |
String |
| clusteredArticles | Daftar artikel berita terkait. | NewsArticle[] |
| contractualRules | Daftar aturan yang harus Anda patuhi jika Anda menampilkan artikel. Misalnya, aturan dapat mengatur apakah Anda harus memberikan atribusi. Aturan kontrak berikut mungkin berlaku. Jika artikel menyediakan aturan kontrak, Anda harus mematuhinya. CATATAN: Hanya artikel yang dikembalikan oleh WEB Search API yang berisi aturan kontrak. Artikel yang dikembalikan oleh titik akhir Berita tidak menyertakan aturan kontrak. |
Objek[] |
| datePublished | Tanggal dan waktu yang Bing menemukan artikel. Tanggal dalam format, YYYY-MM-DDTHH:MM:SS. | String |
| Deskripsi | Deskripsi singkat tentang artikel berita. | String |
| Judul | Nilai Boolean yang menunjukkan apakah artikel berita adalah judul. Jika true, artikel tersebut adalah judul. CATATAN: Artikel ini hanya menyertakan bidang ini untuk permintaan kategori berita yang tidak menentukan parameter kueri kategori . |
Boolean |
| id | ID yang secara unik mengidentifikasi artikel ini dalam daftar artikel. Untuk informasi tentang cara menggunakan bidang ini, lihat Menggunakan Peringkat untuk Menampilkan Hasil di panduan API Pencarian Web. |
String |
| Gambar | Gambar yang terkait dengan artikel baru. Objek Image dalam konteks ini hanya thumbnail berisi bidang . |
Gambar |
| Menyebutkan | Daftar entitas (tempat atau orang) yang disebutkan dalam artikel. | Hal[] |
| Nama | Nama artikel. Gunakan nama ini bersama dengan URL untuk membuat hyperlink yang saat diklik membawa pengguna ke artikel berita. |
String |
| Penyedia | Daftar penyedia yang menjalankan artikel. | Organisasi[] |
| Url | URL ke artikel berita. Gunakan URL ini bersama dengan name untuk membuat hyperlink yang saat diklik membawa pengguna ke artikel berita. |
String |
| Video | Video yang terkait dengan artikel berita. | Video |
Organisasi
Menentukan penyedia yang menjalankan artikel.
| Nama | Nilai | Jenis |
|---|---|---|
| _type | Ketik petunjuk. | String |
| nama | Nama penyedia yang menjalankan artikel. | String |
Kueri
Menentukan string kueri pencarian.
| Nama | Nilai | Jenis |
|---|---|---|
| Teks | String kueri yang mengembalikan topik yang sedang tren. | String |
RelatedTopic
Menentukan daftar artikel berita yang terkait dengan kueri pencarian.
| Nama | Nilai | Jenis |
|---|---|---|
| relatedNews | Daftar artikel berita terkait. | NewsArticle |
| Nama | Istilah kueri terkait yang mengembalikan artikel berita terkait. | String |
| webSearchUrl | URL yang membawa pengguna ke hasil pencarian Bing untuk kueri terkait. | String |
SortValue
Menentukan urutan pengurutan yang akan digunakan untuk permintaan.
| Nama | Nilai | Jenis |
|---|---|---|
| id | Pengidentifikasi yang mengidentifikasi urutan pengurutan artikel. Berikut ini adalah nilai yang mungkin.
|
String |
| isSelected | Nilai Boolean yang menentukan apakah respons menggunakan urutan pengurutan ini. Jika true, respons menggunakan urutan pengurutan ini. | Boolean |
| nama | Nama tampilan urutan pengurutan. | String |
| url | URL yang dapat Anda gunakan untuk membuat permintaan yang sama menggunakan urutan pengurutan ini. | String |
TextAttribution
Menentukan aturan kontrak untuk atribusi teks biasa.
Hal
Menentukan entitas yang disebutkan artikel.
| Nama | Nilai | Jenis |
|---|---|---|
| name | Nama entitas yang disebutkan artikel. | String |
Gambar mini
Menentukan tautan ke gambar terkait.
| Nama | Nilai | Jenis |
|---|---|---|
| contentUrl | URL ke gambar. | String |
| Tinggi | Tinggi gambar, dalam piksel. | Pendek Tidak Ditandatangani |
| Lebar | Lebar gambar, dalam piksel. | Pendek Tidak Ditandatangani |
Topik
Mendefinisikan topik berita yang sedang tren.
| Nama | Nilai | Jenis |
|---|---|---|
| Gambar | Tautan ke gambar terkait. Objek Image dalam konteks ini hanya url berisi bidang dan provider . Bidang provider adalah array objek Organisasi yang mengidentifikasi penyedia gambar. |
Gambar |
| isBreakingNews | Nilai Boolean yang menunjukkan apakah topik tersebut dianggap sebagai berita terkini. Jika topik dianggap sebagai berita terkini, nilainya benar. | Boolean |
| Nama | Judul topik yang sedang tren. | String |
| newsSearchUrl | URL ke hasil pencarian Bing News untuk istilah kueri pencarian (lihat query bidang ). |
String |
| query | Istilah kueri pencarian yang mengembalikan topik yang sedang tren ini. | Kueri |
| webSearchUrl | URL ke Bing hasil pencarian untuk istilah kueri pencarian (lihat query bidang ). |
String |
TrendingTopics
Menentukan objek tingkat atas yang disertakan respons saat permintaan topik yang sedang tren berhasil.
| Nama | Nilai | Jenis |
|---|---|---|
| value | Daftar topik berita yang sedang tren di Bing. Jika tidak ada hasil yang dikembalikan untuk permintaan, array kosong. |
Topik[] |
Video
Menentukan video yang terkait dengan artikel berita.
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 |
| embedHtml | Iframe yang memungkinkan Anda menyematkan dan menjalankan video di halaman web Anda. | String |
| 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 |
| gambar mini | Lebar dan tinggi gambar mini atau gambar mini gerakan. | MediaSize |
| thumbnailUrl | URL ke gambar mini video. Untuk informasi tentang mengubah ukuran gambar, lihat Mengubah ukuran dan memotong gambar mini. | String |
Kategori Berita menurut Pasar
Berikut ini adalah kemungkinan kategori berita yang dapat Anda atur parameter kueri kategorinya . Anda dapat mengatur category ke kategori induk seperti Hiburan atau salah satu subkategorinya seperti Entertainment_MovieAndTV. Jika Anda mengatur category ke kategori induk, itu menyertakan artikel dari satu atau beberapa subkategorinya. Jika Anda mengatur category ke subkataan, itu hanya menyertakan artikel dari subkataan.
| Pasar | Kategori yang Didukung |
|---|---|
| Australia (en-AU) |
|
| Kanada (en-CA) |
|
| Tiongkok (zh-CN) |
|
| India (en-IN) |
|
| Jepang (ja-JP) |
|
| Inggris Raya (en-GB) |
|
| Amerika Serikat (id-ID) |
|
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
/news/search Untuk titik akhir tabel berikut ini 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 |
|---|---|---|
| Denmark | Dansk | da-DK |
| Austria | Jerman | de-AT |
| Belgia | Belanda | nl-BE |
| Swiss | Jerman | de-CH |
| Jerman | Jerman | de-DE |
| Australia | Inggris | en-AU |
| Kanada | Inggris | en-CA |
| Inggris Raya | Inggris | en-GB |
| Indonesia | Inggris | en-ID |
| Irlandia | Inggris | en-IE |
| India | Inggris | en-IN |
| Malaysia | Inggris | en-MY |
| Selandia Baru | Inggris | en-NZ |
| Republik Filipina | Inggris | en-PH |
| Singapura | Inggris | en-SG |
| Amerika Serikat | Inggris | en-US |
| Inggris | umum | en-WW |
| Inggris | umum | en-XA |
| Afrika Selatan | Inggris | en-ZA |
| Argentina | Spanyol | es-AR |
| Cile | Spanyol | es-CL |
| Spanyol | Spanyol | es-ES |
| Meksiko | Spanyol | es-MX |
| Amerika Serikat | Spanyol | es-US |
| Spanyol | umum | es-XL |
| Finlandia | Suomi | fi-FI |
| Prancis | Prancis | fr-BE |
| Kanada | Prancis | fr-CA |
| Swiss | Prancis | fr-CH |
| Prancis | Prancis | fr-FR |
| Italia | Italia | it-IT |
| Hong Kong SAR | Mandarin Tradisional | zh-HK |
| Taiwan | Mandarin Tradisional | zh-TW |
| Jepang | Jepang | ja-JP |
| Korea | Korea | ko-KR |
| Belanda | Belanda | nl-NL |
| Republik Rakyat Tiongkok | Mandarin | zh-CN |
| Polandia | Polski | pl-PL |
| Brasil | Portugis | pt-BR |
| Rusia | Rusia | ru-RU |
| Swedia | Swedia | sv-SE |
| Turki | Turki | tr-TR |
Untuk titik akhir /news, tabel berikut ini mencantumkan nilai kode pasar yang dapat Anda gunakan untuk menentukan parameter kueri mkt. 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 |
|---|---|---|
| Denmark | Dansk | da-DK |
| Jerman | Jerman | de-DE |
| Australia | Inggris | en-AU |
| Inggris Raya | Inggris | en-GB |
| Amerika Serikat | Inggris | en-US |
| Inggris | umum | en-WW |
| Cile | Spanyol | es-CL |
| Meksiko | Spanyol | es-MX |
| Amerika Serikat | Spanyol | es-US |
| Finlandia | Suomi | fi-FI |
| Kanada | Prancis | fr-CA |
| Prancis | Prancis | fr-FR |
| Italia | Italia | it-IT |
| Portugis | Brasil | pt-BR |
| Republik Rakyat Tiongkok | Mandarin | zh-CN |
/news/trendingtopics Untuk titik akhir tabel berikut ini 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 dapat Anda tentukan dalam cc parameter kueri, lihat Kode Negara.
| Negara/Wilayah | Bahasa | Kode Pasar |
|---|---|---|
| Jerman | Jerman | de-DE |
| Australia | Inggris | en-AU |
| Inggris Raya | Inggris | en-GB |
| Amerika Serikat | Inggris | en-US |
| Kanada | Inggris | en-CA |
| India | Inggris | en-IN |
| Prancis | Prancis | fr-FR |
| Kanada | Prancis | fr-CA |
| Portugis | Brasil | pt-BR |
| Republik Rakyat Tiongkok | Mandarin | zh-CN |
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 |