referensi Bing Entity Search API v7

Artikel
07/26/2022
23 menit untuk membaca

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 Entitas memungkinkan Anda mengirim kueri pencarian ke Bing dan mendapatkan kembali hasil pencarian yang menyertakan entitas dan tempat. Hasil tempat mencakup restoran, hotel, atau bisnis lokal lainnya. Untuk tempat, kueri dapat menentukan nama bisnis lokal atau dapat meminta daftar (misalnya, restoran di dekat saya). Hasil entitas mencakup orang, tempat, atau benda. Tempat dalam konteks ini adalah tempat wisata, negara bagian, negara, dll.

Catatan

Respons entitas mendukung beberapa pasar, tetapi respons Places hanya mendukung lokasi Bisnis AS.

Bagian ini menyediakan detail teknis tentang objek respons, serta parameter dan header kueri yang memengaruhi hasil pencarian. Untuk contoh yang menunjukkan cara membuat permintaan, lihat Mencari entitas dan tempat di web.

Untuk mengetahui informasi tentang header yang harus disertakan oleh permintaan, lihat Header.

Untuk informasi tentang parameter kueri yang harus disertakan oleh permintaan, lihat Parameter kueri.

Untuk informasi tentang objek JSON yang disertakan respons, lihat Objek respons.

Untuk informasi tentang penggunaan dan tampilan hasil yang diizinkan, lihat Persyaratan penggunaan dan tampilan.

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 entitas, kirim permintaan GET ke:

https://api.cognitive.microsoft.com/bing/v7.0/entities

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 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.
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).
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. Gunakan ID klien untuk setiap permintaan Bing API yang dibuat aplikasi Anda untuk pengguna ini di perangkat. PERHATIAN: Anda harus memastikan bahwa ID Klien ini tidak dapat ditautkan ke informasi akun pengguna yang dapat diautentikasi. 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-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. lat—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—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— Jari-jari, 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— Stempel waktu UTC UNIX saat klien berada di lokasi. (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— Kecepatan horizontal (kecepatan), dalam meter per detik, yang dilalui perangkat klien. alt— Ketinggian perangkat klien, dalam meter. —bersifat Opsional. Radius, dalam meter, yang menentukan akurasi vertikal koordinat. Radius default ke 50 Kilometer. Tentukan kunci ini hanya jika Anda menentukan kunci `alt`. disp—Opsional. Lokasi geografis pengguna dalam formulir, disp:<City, State>. Misalnya, disp:Seattle, Washington. Ini adalah versi teks tampilan lokasi pengguna yang Anda tentukan menggunakan kunci lat/long. Jika nilai ini bertentangan dengan koordinat lat/long, Bing menggunakan nilai disp sebagai lokasi pengguna. CATATAN: Bing mengabaikan header ini jika kueri menyertakan lokasi. Misalnya, jika header ini mencerminkan lokasi pengguna sebagai San Francisco, tetapi kuerinya adalah restoran seattle, Bing mengembalikan restoran yang terletak di Seattle, Washington. CATATAN: Meskipun kunci ini bersifat opsional, semakin banyak informasi yang Anda berikan, semakin akurat hasil lokasinya. CATATAN: 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-MSEdge-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

Permintaan dapat mencakup parameter kueri berikut. Lihat kolom Wajib untuk parameter yang diperlukan. Anda harus mengodekan URL parameter kueri.

Nama	Nilai	Jenis	Diperlukan
mkt	Pasar tempat hasilnya berasal. Untuk daftar nilai pasar yang mungkin, lihat Kode Pasar. CATATAN: Kode pasar diperlukan. Menentukan pasar membantu Bing merutekan permintaan dan menampilkan respons yang sesuai dan optimal.	String	Ya
q	Istilah pencarian pengguna.	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. Entitas Tempat	String	Tidak
responseFormat	Jenis media yang digunakan untuk respons tersebut. Berikut adalah nilai yang mungkin tidak peka huruf besar/kecil. JSON JSONLD Defaultnya adalah JSON. Untuk mengetahui informasi tentang objek JSON yang ada dalam respons, lihat Objek Respons. Jika Anda menentukan JsonLd, isi respons menyertakan objek JSON-LD yang berisi hasil pencarian. Untuk mengetahui informasi tentang JSON-LD, lihat JSON-LD.	String	Tidak
safeSearch	Filter yang digunakan untuk memfilter konten dewasa. Berikut adalah kemungkinan nilai filter tidak sensitif huruf besar/kecil. Off—Menampilkan teks, gambar, atau video dewasa di halaman web. Moderate—Menampilkan teks dewasa, tetapi bukan gambar atau video dewasa di halaman web. Strict—Tidak menampilkan teks, gambar, atau video dewasa di halaman web. 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. CATATAN: Jika Anda menggunakan operator kueri `site:`, ada kemungkinan respons berisi konten dewasa terlepas dari untuk apa parameter kueri `safeSearch` ditetapkan. Gunakan `site:` hanya jika Anda mengetahui konten di situs dan skenario Anda mendukung kemungkinan konten dewasa.	String	Tidak
setLang	Bahasa yang digunakan untuk string antarmuka pengguna. Anda dapat menentukan bahasa menggunakan kode 2 huruf atau 4 huruf. Menggunakan kode 4 huruf lebih disukai. Untuk daftar kode bahasa yang didukung, lihat Bing bahasa yang didukung. Bing memuat string yang dilokalkan jika `setlang` berisi kode kultur netral 2 huruf (fr) yang valid atau kode budaya khusus 4 huruf (fr-ca) yang valid. Misalnya, untuk fr-ca, Bing memuat string kode kultur netral fr. Jika `setlang` tidak valid (misalnya, zh) atau Bing tidak mendukung bahasa (misalnya, af, af-na), Bing default ke en (Inggris). Untuk menentukan kode 2 huruf, atur parameter ini ke kode bahasa ISO 639-1. Untuk menentukan kode 4 huruf, gunakan formulir -<country/region> di mana adalah kode bahasa ISO 639-1 (budaya netral) dan <negara/wilayah> adalah kode ISO 3166 negara/wilayah (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

Objek Respons

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.

Objek	Deskripsi
Entitas	Mendefinisikan entitas seperti seseorang, tempat, atau hal.
EntityPresentationInfo	Menentukan informasi tambahan tentang entitas seperti petunjuk jenis.
Kesalahan	Menentukan kesalahan yang terjadi.
ErrorResponse	Objek tingkat atas yang disertakan respons saat permintaan gagal.
Gambar	Mendefinisikan gambar.
Lisensi	Menentukan lisensi yang mengizinkan teks atau foto dapat digunakan.
LicenseAttribution	Menentukan aturan kontrak untuk atribusi lisensi.
Tautan	Menentukan komponen hyperlink.
LinkAttribution	Menentukan aturan kontrak untuk atribusi tautan.
MediaAttribution	Menentukan aturan kontrak untuk atribusi media.
Organisasi	Mendefinisikan penerbit.
Tempat	Menentukan informasi tentang entitas lokal seperti restoran atau hotel.
PostalAddress	Menentukan alamat pos.
QueryContext	Menentukan konteks kueri yang digunakan Bing untuk permintaan tersebut.
Dapat diidentifikasi	Pengidentifikasi sumber daya
RankingGroup	Menentukan grup hasil pencarian, seperti jalur utama.
RankingItem	Menentukan item hasil pencarian untuk ditampilkan.
RankingResponse	Menentukan tempat konten halaman hasil pencarian harus ditempatkan dan dalam urutan apa.
SearchResponse	Objek tingkat atas yang disertakan respons saat permintaan berhasil.
TextAttribution	Menentukan aturan kontrak untuk atribusi teks biasa.

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 yang mengacu pada deskripsi entitas. Aturan kontrak berikut mungkin berlaku. LicenseAttribution LinkAttribution MediaAttribution TextAttribution Tidak semua entitas menyertakan aturan. Jika entitas menyediakan aturan kontraktual, 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

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[]

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

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

Lisensi

Menentukan lisensi yang mengizinkan teks atau foto dapat digunakan.

Nama	Nilai	Jenis
name	Nama lisensi.	String
url	URL ke situs web tempat pengguna bisa mendapatkan informasi selengkapnya tentang lisensi. Gunakan nama dan URL untuk membuat hyperlink.	String

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 berdasarkan kebijaksanaan pemanggil.	Boolean
targetPropertyName	Nama bidang tempat aturan diterapkan.	String

Tautan

Menentukan komponen hyperlink.

Nama	Nilai	Jenis
_type	Ketik petunjuk.	String
teks	Teks tampilan.	String
url	URL. Gunakan URL dan tampilkan teks untuk membuat hyperlink.	String

LinkAttribution

Menentukan aturan kontrak 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

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

Tempat

Menentukan informasi tentang entitas lokal, seperti restoran atau hotel.

Catatan

Respons entitas mendukung beberapa pasar, tetapi respons Places hanya mendukung lokasi Bisnis AS.

Nama	Nilai	Jenis
_type	Ketik petunjuk, yang mungkin diatur ke salah satu hal berikut: Hotel LocalBusiness Restaurant	String
address	Alamat pos tempat entitas berada.	PostalAddress
entityPresentationInfo	Informasi tambahan tentang entitas seperti petunjuk yang dapat Anda gunakan untuk menentukan jenis entitas. Misalnya, apakah itu restoran atau hotel. Bidang `entityScenario` diatur ke ListItem.	EntityPresentationInfo
name	Nama entitas.	String
telephone	Nomor telepon entitas.	String
url	URL ke situs web entitas. Gunakan URL ini bersama dengan nama entitas untuk membuat hyperlink yang saat diklik membawa pengguna ke situs web entitas.	String
webSearchUrl	URL untuk hasil pencarian Bing untuk tempat ini.	String

PostalAddress

Menentukan alamat pos.

Nama	Nilai	Jenis
addressCountry	Negara/wilayah tempat alamat jalan berada. Ini bisa berupa kode ISO dua huruf (misalnya, AS) atau nama lengkap (misalnya, Amerika Serikat).	String
addressLocality	Kota tempat alamat jalan berada. Misalnya, Seattle.	String
addressRegion	Kode negara bagian atau provinsi tempat alamat jalan berada. Ini bisa berupa kode dua huruf (misalnya, WA) atau nama lengkapnya (misalnya, Washington).	String
Lingkungan	Lingkungan tempat alamat jalan berada. Misalnya, Westlake.	String
postalCode	Kode pos atau kode pos tempat alamat jalan berada. Misalnya, 98052.	String

QueryContext

Menentukan konteks kueri yang digunakan Bing untuk permintaan tersebut.

Elemen	Deskripsi	Jenis
adultIntent	Nilai Boolean yang menunjukkan apakah kueri yang ditentukan memiliki niat dewasa. Nilainya adalah true jika kueri memiliki niat dewasa; jika tidak, false.	Boolean
alterationOverrideQuery	String kueri yang digunakan untuk memaksa Bing menggunakan string asli. Misalnya, jika string kueri saling downwind, string kueri penimpaan akan +saling downwind. Ingatlah untuk mengodekan string kueri yang menghasilkan %2Bsaling+downwind. Bidang ini disertakan hanya jika string kueri asli berisi kesalahan ejaan.	String
alteredQuery	String kueri yang digunakan oleh Bing 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 akan menjadi `sailing downwind`. Bidang ini disertakan 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 dengan info lokasi, seperti "best seller".	Boolean
originalQuery	String kueri seperti yang ditentukan dalam permintaan.	String

Dapat diidentifikasi

Nama	Nilai	Jenis
id	Pengidentifikasi sumber daya	String

RankingGroup

Menentukan grup hasil pencarian, seperti jalur utama.

Nama	Nilai	Jenis
items	Daftar hasil pencarian untuk ditampilkan dalam grup.	RankingItem

RankingItem

Menentukan item hasil pencarian untuk ditampilkan.

Nama	Nilai	Jenis
resultIndex	Indeks item berbasis nol dalam jawaban untuk ditampilkan. Jika item tidak menyertakan bidang ini, tampilkan semua item dalam jawabannya. Misalnya, tampilkan semua artikel berita di jawaban Berita.	Bilangan bulat
answerType	Jawaban yang berisi item yang akan ditampilkan. Misalnya, Berita. Gunakan jenis untuk menemukan jawaban di objek SearchResponse. Jenis tersebut adalah nama bidang SearchResponse. Namun, gunakan jenis jawaban hanya jika objek ini menyertakan bidang nilai; jika tidak, abaikan saja.	String
textualIndex	Indeks jawaban dalam textualAnswers yang akan ditampilkan.	Bilangan Bulat Tidak Bertanda
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
mainline	Hasil pencarian untuk ditampilkan di garis utama.
pole	Hasil pencarian yang harus diberikan perawatan yang paling terlihat (misalnya, ditampilkan di atas garis utama dan bilah samping).
sidebar	Hasil pencarian ditampilkan di bilah samping.

SearchResponse

Menentukan objek tingkat atas yang disertakan respons saat permintaan berhasil.

Perhatikan bahwa jika layanan mencurigai penolakan serangan layanan, permintaan akan berhasil (kode status HTTP adalah 200 OK); namun, isi respons akan kosong.

Nama	Nilai	Jenis
_type	Ketik petunjuk, yang diatur ke SearchResponse.	String
entities	Daftar entitas yang relevan dengan kueri pencarian.	Entitas
queryContext	Objek yang berisi string kueri yang digunakan Bing untuk permintaan tersebut. Obyek ini memuat string kueri seperti yang dimasukkan oleh pengguna. Ini mungkin juga berisi string kueri yang diubah yang digunakan Bing untuk kueri jika string kueri berisi kesalahan ejaan.	QueryContext

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

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

Catatan

Respons entitas mendukung beberapa pasar, tetapi respons Places hanya mendukung lokasi Bisnis AS.

Negara/Wilayah	Bahasa	Kode pasar
Australia	Inggris	en-AU
Kanada	Inggris	en-CA
Kanada	Prancis	fr-CA
Prancis	Prancis	fr-FR
Jerman	Jerman	de-DE
India	Inggris	en-IN
Italia	Italia	it-IT
Meksiko	Spanyol	es-MX
Inggris Raya	Inggris	en-GB
Amerika Serikat	Inggris	en-US
Amerika Serikat	Spanyol	es-US
Spanyol	Spanyol	es-ES
Brasil	Portugis	pt-BR

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