Referensi API Pencarian Berita v5

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.

Catatan

Versi baru API ini tersedia. Lihat Bing News Search API v7. Untuk informasi tentang peningkatan, lihat panduan peningkatan.

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.

Titik akhir

Untuk meminta artikel berita, kirim permintaan GET ke salah satu URL berikut:

URL Deskripsi
https://api.cognitive.microsoft.com/bing/v5.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/v5.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/v5.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.

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 untuk mengembalikan hasil, Bing menggunakan bahasa pertama yang didukung yang ditemukannya dari daftar dan menggabungkannya dengan cc nilai parameter. 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.
  • Windows Phone—Mozilla/5.0 (kompatibel; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822)

  • Android—Mozilla/5.0 (Linux; U; Android 2.3.5; en-us; SCH-I500 Build/GINGERBREAD) AppleWebKit/533.1 (KHTML; seperti Gecko) Version/4.0 Mobile Safari/533.1

  • iPhone—Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 seperti Mac OS X) AppleWebKit/536.26 (KHTML; seperti Gecko) Mobile/10B142 iPhone4;1 BingWeb/3.03.1428.20120423

  • PC—Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; Touch; rv:11.0) seperti Gecko

  • iPad—Mozilla/5.0 (iPad; CPU OS 7_0 seperti Mac OS X) AppleWebKit/537.51.1 (KHTML, seperti Gecko) Version/7.0 Mobile/11A465 Safari/9537.53
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.
  • Setiap pengguna yang menggunakan aplikasi Anda pada perangkat harus memiliki ID klien buatan Bing yang unik.

    Jika Anda tidak menyertakan header ini dalam permintaan, Bing membuat ID dan menampilkannya di header respons X-MSEdge-ClientID. Satu-satunya waktu yang TIDAK diizinkan untuk menyertakan header ini dalam permintaan adalah pertama kalinya pengguna menggunakan aplikasi Anda di perangkat tersebut.

  • PERHATIAN: Anda harus memastikan bahwa ID Klien ini tidak dapat ditautkan ke informasi akun pengguna yang dapat diautentikasi.

  • Gunakan ID klien untuk setiap permintaan Bing API yang dibuat aplikasi Anda untuk pengguna ini di perangkat.

  • Pertahankan ID klien. Untuk mempertahankan ID di aplikasi browser, gunakan cookie HTTP persisten untuk memastikan ID digunakan di semua sesi. Jangan gunakan cookie sesi. Untuk aplikasi lain seperti aplikasi seluler, gunakan penyimpanan persisten perangkat untuk mempertahankan ID.

    Lain kali pengguna menggunakan aplikasi Anda di perangkat tersebut, dapatkan ID klien yang Anda pertahankan.

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-Search-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.

  • lat—Diperlukan. Garis lintang lokasi klien, dalam derajat. Garis lintang harus lebih besar dari atau sama dengan -90.0 dan kurang dari atau sama dengan +90.0. Nilai negatif menunjukkan garis lintang selatan dan nilai positif menunjukkan garis lintang utara.

  • long—Diperlukan. Bujur lokasi klien, dalam derajat. Bujur harus lebih besar dari atau sama dengan -180.0 dan kurang dari atau sama dengan +180.0. Nilai negatif menunjukkan bujur barat dan nilai positif menunjukkan bujur timur.

  • re—Diperlukan. Radius, dalam meter, yang menentukan akurasi horizontal koordinat. Berikan nilai yang ditampilkan oleh layanan lokasi perangkat. Nilai umum mungkin 22m untuk GPS/Wi-Fi, 380m untuk triangulasi menara sel, dan 18.000m untuk pencarian IP terbalik.

  • ts—Opsional. Tanda waktu UTC UNIX saat klien berada di lokasi tersebut. (Tanda waktu UNIX adalah jumlah detik sejak 1 Januari 1970.)

  • head—Opsional. Judul relatif atau arah perjalanan klien. Tentukan arah perjalanan sebagai derajat dari 0 hingga 360, menghitung searah jarum jam relatif terhadap utara sejati. Tentukan kunci ini hanya jika kunci sp bukan nol.

  • sp—Opsional. Kecepatan horizontal (kecepatan), dalam meter per detik, perangkat klien bepergian.

  • alt—Opsional. Ketinggian perangkat klien, dalam meter.

  • —bersifat Opsional. Radius, dalam meter, yang menentukan akurasi vertikal koordinat. Tentukan kunci ini hanya jika Anda menentukan kunci alt.

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. Lihat kolom Wajib untuk parameter yang diperlukan. Nilai parameter kueri harus dikodekan 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 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
Kategori Kategori artikel yang akan dikembalikan. Misalnya, artikel Olahraga atau artikel Hiburan. Untuk daftar kategori yang mungkin, lihat Kategori Berita menurut Pasar.

CATATAN: Parameter ini hanya berlaku untuk permintaan kategori berita.

Jika Anda tidak menentukan parameter ini, respons mencakup keduanya:
  • Artikel utama biasanya diterbitkan dalam 24 jam terakhir dari kategori apa pun; namun, beberapa artikel mungkin lebih tua.

    Jika artikel adalah judul, bidang judul artikel diatur ke true. Secara default, respons mencakup hingga 12 artikel dan kluster utama. Untuk menentukan jumlah artikel judul yang akan dikembalikan, atur headlineCount parameter kueri.

  • Artikel dari setiap kategori induk (hingga empat artikel dan kluster dari setiap kategori).

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 maksimum yang dapat Anda tentukan 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 menyajikan 20 artikel per halaman, Anda akan mengatur count ke 20 dan offset ke 0 untuk mendapatkan halaman pertama hasil. Untuk setiap halaman berikutnya, Anda akan offset bertambah 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, responsnya 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, parameter ini diabaikan.
UnsignedShort Tidak
Kesegaran Memfilter artikel berita menurut usia. Usia mengacu pada tanggal dan waktu yang Bing menemukan artikel. Berikut ini adalah kemungkinan nilai filter.
  • Hari—Mengembalikan artikel berita yang ditemukan dalam 24 jam terakhir

  • Minggu—Mengembalikan artikel berita yang ditemukan dalam 7 hari terakhir

  • Bulan—Mengembalikan artikel berita yang ditemukan dalam 30 hari terakhir
  • Tahun—Mengembalikan gambar yang ditemukan dalam setahun terakhir

CATATAN: Berita yang Sedang Tren mengabaikan parameter ini.
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, parameter ini diabaikan.

CATATAN: Parameter ini hanya berlaku untuk 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> 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 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 menyajikan 20 artikel per halaman, Anda akan mengatur count ke 20 dan offset ke 0 untuk mendapatkan halaman pertama hasil. Untuk setiap halaman berikutnya, Anda akan offset bertambah 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, responsnya 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, parameter ini diabaikan.
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, gunakan URL di bidang gambar contentUrl 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.

Hanya API Pencarian Berita yang mendukung parameter ini. Jangan tentukan parameter ini saat memanggil API Pencarian Web.

CATATAN: Berita yang Sedang Tren mengabaikan parameter ini.
Boolean Tidak
q String kueri pencarian pengguna. Jika string kueri kosong (misalnya, q=), respons menyertakan berita teratas.

String kueri mungkin berisi Bing Operator Tingkat Lanjut. Misalnya, untuk membatasi berita ke domain tertentu, gunakan operator situs: .

Jangan sertakan parameter ini jika Anda mendapatkan artikel berita berdasarkan kategori.

CATATAN: Berita yang Sedang Tren mengabaikan parameter ini.
String Ya
safeSearch Filter yang digunakan untuk memfilter artikel berita untuk konten dewasa. Berikut ini adalah kemungkinan nilai filter.
  • Nonaktif—Mengembalikan artikel berita dengan teks, gambar, atau video dewasa.

  • Sedang—Mengembalikan artikel berita dengan teks dewasa; namun, artikel tidak menyertakan gambar atau video dewasa.

  • Ketat—Jangan mengembalikan artikel berita dengan teks, gambar, atau video dewasa.

Jika tidak ditentukan, defaultnya adalah 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.
String Tidak
setLang Bahasa yang digunakan untuk string antarmuka pengguna. Tentukan bahasa menggunakan kode bahasa ISO 639-1 2 huruf. Misalnya, kode bahasa untuk bahasa Inggris adalah EN. Defaultnya adalah EN (Inggris).

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; jika tidak, salah. 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.
  • Mentah—Gunakan karakter Unicode untuk menandai konten yang memerlukan pemformatan khusus. Karakter Unicode berada dalam rentang E000 hingga E019. Misalnya, Bing menggunakan E000 dan E001 untuk menandai awal dan akhir istilah kueri untuk penyorotan temuan.

  • HTML—Gunakan tag HTML untuk menandai konten yang memerlukan pemformatan khusus. Misalnya, gunakan <tag b> untuk menyorot istilah kueri dalam string tampilan.

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 &lt;).

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 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.
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 Menentukan topik berita yang sedang tren.
TrendingTopics Menentukan objek tingkat atas yang disertakan respons saat permintaan topik yang sedang tren berhasil.

Kesalahan

Menentukan kesalahan yang terjadi.

Elemen Deskripsi Jenis
code Kode kesalahan yang mengidentifikasi kesalahan. Untuk daftar kode yang mungkin, lihat Kode Kesalahan. String
message Deskripsi kesalahan. String
parameter Parameter kueri dalam permintaan yang menyebabkan kesalahan. String
value Nilai parameter kueri yang tidak valid. String

ErrorResponse

Menentukan objek tingkat atas yang disertakan respons saat permintaan gagal.

Nama Nilai Jenis
_type Ketik petunjuk. String
errors Array objek Kesalahan yang menjelaskan alasan permintaan gagal. Error[]

Gambar

Menentukan gambar mini gambar terkait berita.

Nama Nilai Jenis
penyedia Array objek Organisasi yang mengidentifikasi pemilik gambar. Organisasi
gambar mini Tautan ke gambar mini gambar terkait berita. Gambar mini
url URL ke gambar. String

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 WEB Search API.
String
readLink URL yang mengembalikan jawaban ini. Untuk menggunakan URL, Anda harus menambahkan parameter kueri yang sesuai dan menyertakan header Ocp-Apim-Subscription-Key .

API Pencarian Berita dan API Pencarian Web menyertakan bidang ini. Biasanya, Anda akan menggunakan URL saat disertakan dalam respons Pencarian dan Anda ingin mengkueri API Pencarian Berita secara langsung.
String
relatedTopics Daftar artikel berita yang terkait dengan kueri pencarian. RelatedTopic[]
totalEstimatedMatches Perkiraan jumlah artikel berita yang relevan dengan kueri. Gunakan angka ini bersama dengan parameter kueri hitungan dan offset untuk halaman hasilnya.

Respons hanya mencakup bidang ini saat memanggil API Pencarian Berita. WEB Search API tidak menyertakan bidang ini dalam respons.
Long
value Array objek NewsArticle yang berisi informasi tentang artikel berita yang relevan dengan 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[]
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; jika tidak, false (atau tidak ada).

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 WEB Search API.
String
Gambar Gambar yang terkait dengan artikel baru.

Objek Image dalam konteks ini hanya thumbnail berisi bidang .
Gambar
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

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 String kueri terkait yang mengembalikan artikel berita terkait. String
webSearchUrl URL yang membawa pengguna ke hasil pencarian Bing untuk kueri terkait. 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 Organization objek yang mengidentifikasi penyedia gambar.
Gambar
isBreakingNews Nilai Boolean yang menunjukkan apakah topik tersebut dianggap sebagai berita terkini. Nilainya benar jika topik dianggap sebagai berita terkini; jika tidak, salah. Boolean
Nama Judul topik yang sedang tren. String
query String kueri pencarian yang mengembalikan topik yang sedang tren ini. Kueri
webSearchUrl URL ke hasil pencarian Bing untuk topik berita yang sedang tren. 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[]

Kategori Berita menurut Pasar

Berikut ini adalah daftar kemungkinan kategori berita yang dapat Anda atur parameter kueri kategorinya . Anda dapat mengatur category ke kategori induk seperti Entertainment atau salah satu subkategorinya seperti Entertainment_MovieAndTV. Jika Anda mengatur category ke kategori induk, itu termasuk artikel dari satu atau beberapa subkategorinya. Jika Anda mengatur category ke subkataan, itu hanya menyertakan artikel dari subkataan.

Pasar Kategori yang Didukung
Inggris Raya (en-GB)
  • Bisnis
  • Hiburan
  • Kesehatan
  • Politik
  • ScienceAndTechnology
  • Olahraga
  • UK
  • Dunia
Amerika Serikat (id-ID)
  • Bisnis
  • Hiburan

    • Entertainment_MovieAndTV
    • Entertainment_Music
  • Kesehatan
  • Politik
  • ScienceAndTechnology

    • Teknologi
    • Ilmu
  • Olahraga

    • Sports_Golf
    • Sports_MLB
    • Sports_NBA
    • Sports_NFL
    • Sports_NHL
    • Sports_Soccer
    • Sports_Tennis
    • Sports_CFB
    • Sports_CBB
  • US

    • US_Northeast
    • US_South
    • US_Midwest
    • US_West
  • Dunia

    • World_Africa
    • World_Americas
    • World_Asia
    • World_Europe
    • World_MiddleEast

Kode kesalahan

Berikut ini adalah kemungkinan kode status HTTP yang dapat dikembalikan oleh permintaan.

Kode Status Deskripsi
200 Panggilan berhasil.
400 Salah satu parameter kueri hilang atau tidak valid.
401 Kunci langganan hilang atau tidak valid.
403 Pengguna diautentikasi (misalnya, menggunakan kunci langganan yang valid) tetapi mereka tidak memiliki izin ke sumber daya yang diminta.

Jika penelepon melebihi kuota kueri per bulan, Bing juga dapat mengembalikan status ini.
410 Permintaan yang digunakan HTTP, bukan protokol HTTPS. HTTPS adalah satu-satunya protokol yang didukung.
429 Penelepon melebihi kueri mereka per kuota kedua.

Jika permintaan gagal, isi respons akan berisi ErrorResponse objek . Objek respons akan menyertakan kode kesalahan dan deskripsi kesalahan. Jika kesalahan terkait dengan parameter, parameter bidang akan mengidentifikasi parameter yang menjadi masalah. Dan jika kesalahan terkait dengan nilai parameter, value bidang akan mengidentifikasi nilai yang tidak valid.

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "RequestParameterMissing", 
      "message": "Required parameter is missing.", 
      "parameter": "q" 
    }
  ]
}


{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "AuthorizationMissing", 
      "message": "Authorization is required.", 
    }
  ]
}

Berikut ini adalah kemungkinan kode kesalahan.

Kode kesalahan Deskripsi
RequestParameterMissing Permintaan tidak memiliki parameter yang diperlukan. Bidang parameter mengidentifikasi parameter yang hilang.
RequestParameterInvalidValue Nilai parameter tidak valid. Bidang parameter mengidentifikasi parameter yang berisi nilai yang tidak valid, dan value bidang berisi nilai yang tidak valid.
ResourceAccessDenied Pemanggil tidak memiliki izin untuk mengakses sumber daya. Kesalahan ini dapat terjadi jika kunci langganan telah dinonaktifkan atau telah kedaluwarsa.
ExceededVolume Penelepon melebihi kuota kueri per bulan (QPM).
ExceededQpsLimit Penelepon melebihi kueri mereka per detik (QPS).
Nonaktifkan Pemanggil tidak memiliki izin untuk mengakses sumber daya.
UnexpectedError Terjadi kesalahan tak terduga pada server. Coba lagi nanti.
DataSourceErrors Terjadi kesalahan saat mengakses sumber daya.
AuthorizationMissing Bing tidak dapat mengautentikasi pemanggil. Kesalahan ini dapat terjadi jika Ocp-Apim-Subscription-Key header hilang.
HttpNotAllowed Permintaan menggunakan protokol HTTP alih-alih protokol HTTPS; Bing hanya mendukung HTTPS.
InvalidAuthorization Bing tidak dapat mengautentikasi pemanggil. Ini dapat terjadi jika kunci langganan tidak valid.
InsufficientScope Pemanggil tidak memiliki izin untuk mengakses sumber daya. Kesalahan ini dapat terjadi jika kunci langganan telah kedaluwarsa.

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