Referensi API Pencarian Gambar Kustom v7

  • Artikel
  • 24 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 Gambar Kustom memungkinkan Anda mengirim kueri pencarian ke Bing dan mendapatkan kembali daftar gambar yang relevan dari iringan Web yang ditentukan instans Pencarian Kustom Anda. Untuk informasi tentang mengonfigurasi instans Pencarian Kustom, lihat Mengonfigurasi pengalaman pencarian kustom Anda.

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 respons 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 gambar dari instans Pencarian Kustom Anda, kirim permintaan GET ke URL berikut:

https://api.cognitive.microsoft.com/bingcustomsearch/v7.0/images/search

Permintaan harus menggunakan protokol HTTPS.

Catatan

Panjang URL maksimum adalah 2.048 karakter. Untuk memastikan bahwa panjang URL Anda tidak melebihi batas, panjang maksimum parameter kueri Anda harus kurang dari 1.500 karakter. Jika URL melebihi 2.048 karakter, server menampilkan 404 Tidak ditemukan.

Header

Berikut adalah header yang mungkin disertakan oleh permintaan dan respons.

Header Deskripsi
Terima Header permintaan opsional.

Jenis media default adalah aplikasi/json. Untuk menentukan bahwa respons menggunakan JSON-LD, atur header Terima ke application/ld+json.
Accept-Language Header permintaan opsional.

Daftar bahasa yang dibatasi koma untuk digunakan untuk string antarmuka pengguna. Daftar ini dalam urutan preferensi yang menurun. Untuk mengetahui informasi selengkapnya, termasuk format yang diharapkan, lihat RFC2616.

Header ini dan parameter kueri setLang saling eksklusif jangan tentukan keduanya.

Jika Anda mengatur header ini, Anda juga harus menentukan parameter kueri cc. Untuk menentukan pasar guna menampilkan hasil, Bing menggunakan bahasa pertama yang didukung yang ditemukannya dari daftar dan menggabungkannya dengan nilai parameter cc. Jika daftar tidak menyertakan bahasa yang didukung, Bing menemukan bahasa dan pasar terdekat yang mendukung permintaan atau menggunakan pasar agregat atau default untuk hasilnya. Untuk menentukan pasar yang digunakan Bing, lihat header BingAPIs-Market.

Gunakan header ini dan parameter kueri cc hanya jika Anda menentukan beberapa bahasa. Jika tidak, gunakan parameter kueri mkt dan setLang.

String antarmuka pengguna adalah string yang digunakan sebagai label di antarmuka pengguna. Ada beberapa string antarmuka pengguna di objek respons JSON. Setiap tautan ke properti Bing.com dalam objek respons menerapkan bahasa yang ditentukan.
BingAPIs-Market Header respons.

Pasar yang digunakan oleh permintaan. Bentuknya adalah <languageCode>-<countryCode>. Misalnya, en-US.

Jika Anda menentukan pasar yang tidak tercantum dalam Kode Pasar, nilai ini mungkin berbeda dari pasar yang Anda tentukan dalam parameter kueri mkt . Hal yang sama berlaku jika Anda menentukan nilai untuk cc dan Accept-Language yang tidak dapat direkonsiliasi.
BingAPIs-TraceId Header respons.

ID entri log yang berisi detail permintaan. Saat terjadi kesalahan, ambil ID ini. Jika Anda tidak dapat menentukan dan mengatasi masalah tersebut, sertakan ID ini bersama dengan informasi lain yang Anda berikan kepada tim Dukungan.
Ocp-Apim-Subscription-Key Header permintaan yang diperlukan.

Kunci langganan yang Anda terima saat mendaftar untuk layanan ini di Cognitive Services.
Retry-After Header respons.

Respons mencakup header ini jika Anda melebihi jumlah kueri yang diizinkan per detik (QPS) atau per bulan (QPM). Header berisi jumlah detik yang harus Anda tunggu sebelum mengirim permintaan lain.
User-Agent Header permintaan opsional.

Agen pengguna yang berasal dari permintaan. Bing menggunakan agen pengguna untuk memberikan pengalaman yang dioptimalkan kepada pengguna seluler. Meskipun opsional, Anda dianjurkan untuk selalu menentukan header ini.

User-agent harus berupa string yang sama dengan yang dikirim oleh browser yang umum digunakan. Untuk mengetahui informasi tentang agen pengguna, lihat RFC 2616.

Berikut adalah contoh string user-agent.
  • 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-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—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.

  • 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 banyak kunci bersifat opsional, semakin banyak informasi yang Anda berikan, semakin akurat hasil lokasinya.

CATATAN: Meskipun opsional, Anda dianjurkan untuk selalu menentukan lokasi geografis pengguna. Menyediakan lokasi sangat penting jika alamat IP klien tidak secara akurat mencerminkan lokasi fisik pengguna (misalnya, jika klien menggunakan VPN). Untuk hasil yang optimal, Anda harus menyertakan header ini dan header X-Search-ClientIP, tetapi minimal, Anda harus menyertakan header ini.

Catatan

Ingatlah bahwa Ketentuan Penggunaan memerlukan kepatuhan terhadap semua hukum yang berlaku, termasuk mengenai penggunaan header ini. Misalnya, di wilayah hukum tertentu, seperti Eropa, ada persyaratan untuk mendapatkan persetujuan pengguna sebelum menempatkan perangkat pelacakan tertentu pada perangkat pengguna.

Parameter kueri

Berikut ini adalah parameter kueri yang mungkin disertakan oleh permintaan. Lihat kolom Wajib untuk parameter yang diperlukan. Anda harus mengodekan nilai parameter kueri ke dalam URL. Untuk informasi tentang parameter kueri yang Anda gunakan untuk memfilter gambar yang Bing kembalikan, lihat Filter Parameter Kueri.

Nama Nilai Jenis Diperlukan
cc Kode negara dua karakter negara tempat hasilnya berasal. Untuk daftar nilai yang mungkin, lihat Kode Pasar.

Jika Anda mengatur parameter ini, Anda juga harus menentukan header Accept-Language. Bing menggunakan bahasa pertama yang didukung yang ditemukannya dalam bahasa yang ditentukan dan menggabungkannya dengan kode negara untuk menentukan pasar untuk mengembalikan hasil. Jika daftar bahasa tidak menyertakan bahasa yang didukung, Bing menemukan bahasa dan pasar terdekat yang mendukung permintaan tersebut. Atau, Bing dapat menggunakan pasar agregat atau default untuk hasilnya.

Gunakan parameter kueri ini dan Accept-Language header hanya jika Anda menentukan beberapa bahasa. Jika tidak, Anda harus menggunakan mkt parameter kueri dan setLang .

Parameter ini dan parameter kueri mkt saling eksklusif—jangan tentukan keduanya.		 String Tidak
jumlah Jumlah gambar yang akan dikembalikan dalam respons. Jumlah aktual yang dikirimkan mungkin kurang dari yang diminta. Defaultnya adalah 35. Nilai maksimum adalah 150.

Anda menggunakan parameter ini bersama dengan offset parameter ke hasil halaman. Misalnya, jika antarmuka pengguna Anda menampilkan 20 gambar 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).		 UnsignedShort Tidak
customConfig Pengidentifikasi unik yang mengidentifikasi instans pencarian kustom Anda.

 String Ya
mkt Pasar tempat hasilnya berasal. Biasanya, mkt adalah negara tempat pengguna membuat permintaan. Namun, itu bisa menjadi negara yang berbeda jika pengguna tidak berada di negara tempat Bing memberikan hasil. Pasar harus dalam bentuk <kode> 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 gambar yang akan dilewati sebelum mengembalikan gambar. Defaultnya adalah 0. Offset harus kurang dari (totalEstimatedMatches - count).

Untuk halaman hasil, gunakan parameter ini bersama dengan count parameter . Misalnya, jika antarmuka pengguna Anda menampilkan 20 gambar per halaman, atur count ke 20 dan offset ke 0 untuk mendapatkan halaman pertama hasil. Untuk setiap halaman berikutnya, kenaikan offset sebesar 20 (misalnya, 0, 20, 40).

Dimungkinkan bagi beberapa halaman untuk menyertakan beberapa tumpang tindih dalam hasil. Untuk mencegah duplikat, lihat nextOffset.		 Pendek Tidak Ditandatangani Tidak
q Istilah kueri pencarian pengguna. Istilah tidak boleh kosong.

CATATAN: String kueri tidak boleh berisi operator tingkat lanjut Bing. Menyertakannya dapat berdampak buruk pada pengalaman pencarian kustom.		 String Ya
safeSearch Memfilter gambar untuk konten dewasa. Berikut ini adalah kemungkinan nilai filter.
  • Nonaktif—Menampilkan gambar dengan konten dewasa.
  • Sedang—Jangan sertakan gambar dengan konten dewasa.
  • Ketat—Jangan sertakan gambar dengan konten dewasa.

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 -<negara/wilayah> di mana 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

Memfilter parameter kueri

Berikut ini adalah parameter kueri filter opsional yang bisa Anda gunakan untuk memfilter gambar yang Bing kembalikan. Anda harus mengodekan URL parameter kueri.

Nama Nilai Jenis
Aspek Filter gambar menurut rasio aspek berikut:
  • Persegi—Mengembalikan gambar dengan rasio aspek standar
  • Wide—Mengembalikan gambar dengan rasio aspek layar lebar
  • Tinggi—Mengembalikan gambar dengan rasio aspek tinggi
  • Semua—Jangan filter berdasarkan aspek. Menentukan nilai ini sama dengan tidak menentukan aspect parameter.
 untai
Warna Filter gambar menurut opsi warna berikut:
  • ColorOnly—Mengembalikan gambar warna
  • Monokrom—Mengembalikan gambar hitam dan putih

Mengembalikan gambar dengan salah satu warna dominan berikut:
  • Hitam
  • Biru
  • Cokelat
  • Abu-abu
  • Hijau
  • Oranye
  • Pink
  • Ungu
  • Merah
  • Teal
  • Putih
  • Kuning
 untai
Tinggi Filter gambar yang memiliki tinggi yang ditentukan, dalam piksel.

Anda dapat menggunakan filter ini dengan size filter untuk mengembalikan gambar kecil yang memiliki tinggi 150 piksel.		 UnsignedShort
imageContent Filter gambar menurut jenis konten berikut:
  • Face—Menampilkan gambar yang hanya menampilkan wajah seseorang
  • Potret—Mengembalikan gambar yang hanya menampilkan kepala dan bahu seseorang
  • NonPortrait—Mengembalikan gambar yang tidak menampilkan kepala dan bahu seseorang
 untai
imageType Filter gambar menurut jenis gambar berikut:
  • AnimatedGif—Hanya mengembalikan GIF animasi

  • Clipart—Hanya mengembalikan gambar clip art

  • Garis—Hanya mengembalikan gambar garis

  • Foto—Hanya kembalikan foto (tidak termasuk gambar garis, Gif animasi, dan clip art)

  • Grafik—Mengembalikan gambar grafis

  • Belanja—Kembalikan hanya gambar yang berisi item di mana Bing mengetahui pedagang yang menjual item. Opsi ini hanya berlaku di pasar en-US.

  • Transparan—Hanya mengembalikan gambar dengan latar belakang transparan.
 untai
Lisensi Filter gambar menurut jenis lisensi berikut:
  • Apa pun—Mengembalikan gambar yang berada di bawah jenis lisensi apa pun. Respons tidak menyertakan gambar yang tidak menentukan lisensi atau lisensi tidak diketahui.

  • Publik—Mengembalikan gambar di mana pembuat telah mengesampingkan hak eksklusif mereka, sejauh yang diizinkan oleh hukum.

  • Bagikan—Mengembalikan gambar yang mungkin dibagikan dengan orang lain. Mengubah atau mengedit gambar mungkin tidak diizinkan. Selain itu, memodifikasi, berbagi, dan menggunakan gambar untuk tujuan komersial mungkin tidak diizinkan. Biasanya, opsi ini mengembalikan gambar terbanyak.

  • ShareCommercially—Mengembalikan gambar yang dapat dibagikan dengan orang lain untuk tujuan pribadi atau komersial. Mengubah atau mengedit gambar mungkin tidak diizinkan.

  • Modifikasi—Mengembalikan gambar yang mungkin dimodifikasi, dibagikan, dan digunakan. Mengubah atau mengedit gambar mungkin tidak diizinkan. Memodifikasi, berbagi, dan menggunakan gambar untuk tujuan komersial mungkin tidak diizinkan.

  • ModifyCommercially—Mengembalikan gambar yang dapat dimodifikasi, dibagikan, dan digunakan untuk tujuan pribadi atau komersial. Biasanya, opsi ini mengembalikan gambar terkecil.

  • Semua—Jangan filter menurut jenis lisensi. Menentukan nilai ini sama dengan tidak menentukan license parameter.

Untuk informasi selengkapnya tentang jenis lisensi ini, lihat Memfilter Gambar Menurut Jenis Lisensi.		 untai
maxFileSize Filter gambar yang kurang dari atau sama dengan ukuran file yang ditentukan.

Ukuran file maksimum yang dapat Anda tentukan adalah 520.192 byte. Jika Anda menentukan nilai yang lebih besar, API menggunakan 520.192. Ada kemungkinan bahwa respons dapat mencakup gambar yang sedikit lebih besar dari maksimum yang ditentukan.

Anda dapat menentukan filter ini dan minFileSize untuk memfilter gambar dalam rentang ukuran file.		 Bilangan bulat
maxHeight Filter gambar yang memiliki tinggi kurang dari atau sama dengan tinggi yang ditentukan. Tentukan tinggi dalam piksel.

Anda dapat menentukan filter ini dan minHeight untuk memfilter gambar dalam rentang tinggi.

Filter ini dan height filter saling eksklusif.		 Bilangan bulat
maxWidth Filter gambar yang memiliki lebar kurang dari atau sama dengan lebar yang ditentukan. Tentukan lebar dalam piksel.

Anda dapat menentukan filter ini dan maxWidth untuk memfilter gambar dalam rentang lebar.

Filter ini dan width filter saling eksklusif.		 Bilangan bulat
minFileSize Filter gambar yang lebih besar dari atau sama dengan ukuran file yang ditentukan.

Ukuran file maksimum yang dapat Anda tentukan adalah 520.192 byte. Jika Anda menentukan nilai yang lebih besar, API menggunakan 520.192. Ada kemungkinan bahwa respons dapat mencakup gambar yang sedikit lebih kecil dari minimum yang ditentukan.

Anda dapat menentukan filter ini dan maxFileSize untuk memfilter gambar dalam rentang ukuran file.		 Bilangan bulat
minHeight Filter gambar yang memiliki tinggi lebih besar dari atau sama dengan tinggi yang ditentukan. Tentukan tinggi dalam piksel.

Anda dapat menentukan filter ini dan maxHeight untuk memfilter gambar dalam rentang tinggi.

Filter ini dan height filter saling eksklusif.		 Bilangan bulat
minWidth Filter gambar yang memiliki lebar lebih besar dari atau sama dengan lebar yang ditentukan. Tentukan lebar dalam piksel.

Anda dapat menentukan filter ini dan maxWidth untuk memfilter gambar dalam rentang lebar.

Filter ini dan width filter saling eksklusif.		 Bilangan bulat
Ukuran Filter gambar menurut ukuran berikut:
  • Kecil—Mengembalikan gambar yang kurang dari 200x200 piksel

  • Sedang—Mengembalikan gambar yang lebih besar dari atau sama dengan 200x200 piksel tetapi kurang dari 500x500 piksel

  • Besar—Mengembalikan gambar yang 500x500 piksel atau lebih besar

  • Wallpaper—Kembalikan gambar wallpaper.

  • Semua—Jangan memfilter menurut ukuran. Menentukan nilai ini sama dengan tidak menentukan size parameter.

Anda dapat menggunakan parameter ini bersama dengan height parameter atau width . Misalnya, Anda dapat menggunakan height dan size untuk meminta gambar kecil yang tingginya 150 piksel.		 untai
Lebar Filter gambar yang memiliki lebar yang ditentukan, dalam piksel.

Anda dapat menggunakan filter ini dengan size filter untuk mengembalikan gambar kecil yang memiliki lebar 150 piksel.		 UnsignedShort

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 Gambar . Jika permintaan gagal, objek tingkat atas adalah objek ErrorResponse.

Objek Deskripsi
Kesalahan Menentukan kesalahan yang terjadi.
ErrorResponse Objek tingkat atas yang disertakan respons saat permintaan gagal.
Gambar Menentukan gambar yang relevan dengan kueri.
Citra Objek tingkat atas yang disertakan respons saat permintaan gambar berhasil.
MediaSize Menentukan ukuran isi media.
Instrumentasi Menentukan URL instrumentasi Bing.
Pivot Menentukan segmen pivot.
Kueri Menentukan string kueri pencarian.
Gambar mini Menentukan gambar mini.

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 yang relevan dengan kueri.

Catatan

Karena format URL dan parameter dapat berubah tanpa pemberitahuan, gunakan semua URL 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
accentColor Angka heksadesimal tiga byte yang mewakili warna yang mendominasi gambar. Gunakan warna sebagai latar belakang sementara di klien Anda hingga gambar dimuat. untai
contentSize Ukuran file gambar. Format string adalah {size} {units}. Misalnya, 12345 B menunjukkan bahwa ukuran gambar adalah 12.345 byte. untai
contentUrl URL ke gambar di situs web sumber. untai
datePublished Tanggal dan waktu, dalam UTC, yang Bing menemukan gambar. Tanggal dalam format, YYYY-MM-DDTHH:MM:SS. untai
encodingFormat Jenis mime gambar (misalnya, jpeg). untai
Tinggi Tinggi gambar sumber, dalam piksel. Pendek Tidak Ditandatangani
hostPageDisplayUrl URL tampilan halaman web yang menghosting gambar.

Gunakan URL ini di antarmuka pengguna Anda untuk mengidentifikasi halaman web host yang berisi gambar. URL tidak terbentuk dengan baik dan tidak boleh digunakan untuk mengakses halaman web host. Untuk mengakses halaman web host, gunakan hostPageUrl URL.		 untai
hostPageUrl URL halaman web yang menyertakan gambar.

URL ini dan contentUrl mungkin URL yang sama.		 untai
imageId ID yang secara unik mengidentifikasi gambar ini. Jika Anda ingin gambar menjadi gambar pertama dalam respons, atur parameter kueri id ke ID ini dalam permintaan Anda. untai
nama Judul gambar. untai
gambar mini Lebar dan tinggi gambar mini (lihat thumbnailUrl). MediaSize
thumbnailUrl URL ke gambar mini gambar. Untuk informasi tentang mengubah ukuran gambar, lihat Mengubah ukuran dan memotong gambar mini. String
webSearchUrl URL ke hasil pencarian Bing untuk gambar ini. untai
Lebar Lebar gambar sumber, dalam piksel. Pendek Tidak Ditandatangani

Gambar

Objek tingkat atas yang disertakan respons saat permintaan gambar berhasil.

Nama Nilai Jenis
_type Petunjuk jenis, yang diatur ke Gambar. untai
nextOffset Nilai offset tempat Anda mengatur parameter kueri offset .

Jika Anda mengatur offset ke 0 dan count ke 30 dalam permintaan pertama Anda, lalu mengatur offset ke 30 dalam permintaan kedua Anda, beberapa hasil dalam respons kedua mungkin duplikat respons pertama.

Untuk mencegah duplikat, atur offset ke nilai nextOffset.		 Bilangan bulat
pivotSuggestions Daftar segmen dalam kueri asli. Misalnya, jika kuerinya adalah Red Flowers, Bing mungkin mensegmentasi kueri menjadi Merah dan Bunga.

Pivot Bunga mungkin berisi saran kueri seperti Peony Merah dan Aster Merah, dan pivot Merah mungkin berisi saran kueri seperti Bunga Hijau dan Bunga Kuning.		 Pivot
queryExpansions Daftar kueri yang diperluas yang mempersempit kueri asli. Misalnya, jika kuerinya adalah Microsoft Surface, kueri yang diperluas mungkin adalah: Microsoft Surface Pro 3, Microsoft Surface RT, Microsoft Surface Telepon, dan Microsoft Surface Hub. Kueri
similarTerms Daftar istilah yang mirip dengan arti istilah kueri pengguna. Kueri
totalEstimatedMatches Perkiraan jumlah gambar yang relevan dengan kueri. Gunakan angka ini bersama dengan parameter kueri hitungan dan offset untuk halaman hasilnya.

Hanya API Pencarian Gambar yang menyertakan bidang ini.		 Long
value Daftar gambar yang relevan dengan kueri.

Jika tidak ada hasil, array kosong.		 Gambar[]
webSearchUrl URL ke hasil pencarian Bing untuk gambar yang diminta. untai

MediaSize

Menentukan ukuran isi media.

Nama Nilai Jenis
tinggi Tinggi konten media, dalam piksel. Bilangan bulat
lebar Lebar konten media, dalam piksel. Bilangan bulat

Pivot

Menentukan segmen pivot.

Nama Nilai Jenis
Pivot Segmen dari kueri asli untuk dipivot. untai
Saran Daftar kueri yang disarankan untuk pivot. Kueri

Kueri

Menentukan string kueri pencarian.

Nama Nilai Jenis
tekstampak Versi tampilan istilah kueri.

Untuk kueri yang diperluas (lihat queryExpansions) dan saran pivot (lihat pivotSuggestions), bidang ini mengidentifikasi istilah yang memperluas kueri asli. Misalnya, jika kueri adalah Microsoft Surface dan kueri yang diperluas adalah Microsoft Surface RT, displayText akan berisi RT.		 untai
searchLink URL yang Anda gunakan untuk mendapatkan hasil pencarian terkait. Sebelum menggunakan URL, Anda harus menambahkan parameter kueri yang sesuai dan menyertakan header Ocp-Apim-Subscription-Key .

Gunakan URL ini jika Anda menampilkan hasilnya di antarmuka pengguna Anda sendiri. Jika tidak, gunakan webSearchUrl URL.		 String
teks Istilah kueri. untai
gambar mini URL ke gambar mini gambar terkait.

Objek mencakup bidang ini hanya untuk saran pivot dan pencarian terkait.		 Gambar mini
webSearchUrl URL yang membawa pengguna ke halaman hasil pencarian Bing untuk kueri.

Gunakan URL ini jika Anda tidak menampilkan hasilnya di antarmuka pengguna Anda sendiri. Jika tidak, gunakan searchUrl URL.

Hanya disertakan untuk pencarian terkait.		 untai

Gambar mini

Menentukan gambar mini gambar.

Elemen Deskripsi Jenis
url URL ke gambar mini gambar. untai

Kode kesalahan

Berikut adalah kemungkinan kode status HTTP yang ditampilkan permintaan.

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

Bing juga dapat menampilkan status ini jika penelepon melebihi kuota kueri per bulan.
410 Permintaan yang digunakan HTTP, bukan protokol HTTPS. HTTPS adalah satu-satunya protokol yang didukung.
429 Penelepon melebihi kueri mereka per kuota kedua.
500 Kesalahan server tidak terduga.

Jika permintaan gagal, respons berisi objek ErrorResponse, yang berisi daftar objek Kesalahan yang menjelaskan apa yang menyebabkan kesalahan. Jika kesalahan terkait dengan parameter, bidang parameter mengidentifikasi parameter yang menjadi masalah. Dan jika kesalahan terkait dengan nilai parameter, bidang value mengidentifikasi nilai yang tidak valid.

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

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "InvalidAuthorization", 
      "subCode": "AuthorizationMissing", 
      "message": "Authorization is required.", 
      "moreDetails": "Subscription key is not recognized."
    }
  ]
}

Berikut adalah kemungkinan nilai kode kesalahan dan kode sub-kesalahan.

Kode SubCode Deskripsi
ServerError UnexpectedError
ResourceError
NotImplemented		 Kode status HTTP adalah 500.
InvalidRequest ParameterMissing
ParameterInvalidValue
HttpNotAllowed
Diblokir		 Bing menampilkan InvalidRequest setiap kali bagian mana pun dari permintaan tidak valid. Misalnya, parameter yang diperlukan hilang atau nilai parameter tidak valid.

Jika kesalahannya adalah ParameterMissing atau ParameterInvalidValue, kode status HTTP adalah 400.

Jika Anda menggunakan protokol HTTP alih-alih HTTPS, Bing menampilkan HttpNotAllowed, dan kode status HTTP adalah 410.
RateLimitExceeded Tidak ada sub-kode Bing menampilkan RateLimitExceed setiap kali Anda melebihi kuota kueri per detik (QPS) atau kueri per bulan (QPM) Anda.

Jika Anda melebihi QPS, Bing menampilkan kode status HTTP 429, dan jika Anda melebihi QPM, Bing menampilkan 403.
InvalidAuthorization AuthorizationMissing
AuthorizationRedundancy		 Bing menampilkan InvalidAuthorization saat Bing tidak dapat mengautentikasi pemanggil. Misalnya, header Ocp-Apim-Subscription-Key hilang atau kunci langganan tidak valid.

Redundansi terjadi jika Anda menentukan lebih dari satu metode autentikasi.

Jika kesalahannya adalah InvalidAuthorization, kode status HTTP adalah 401.
InsufficientAuthorization AuthorizationDisabled
AuthorizationExpired		 Bing menampilkan InsufficientAuthorization saat pemanggil tidak memiliki izin untuk mengakses sumber daya. Ini dapat terjadi jika kunci langganan telah dinonaktifkan atau telah kedaluwarsa.

Jika kesalahannya adalah InsufficientAuthorization, kode status HTTP adalah 403.

Kode pasar

Tabel berikut mencantumkan nilai kode pasar yang dapat Anda gunakan untuk menentukan mkt parameter kueri. Bing hanya akan menampilkan konten untuk pasar ini. Daftar ini dapat berubah.

Untuk daftar kode negara yang mungkin Anda tentukan dalam cc parameter kueri, lihat Kode negara.

Negara/Wilayah Bahasa Kode pasar
Argentina Spanyol es-AR
Australia Inggris en-AU
Austria Jerman de-AT
Belgia Belanda nl-BE
Belgia Prancis fr-BE
Brasil Portugis pt-BR
Kanada Inggris en-CA
Kanada Prancis fr-CA
Cile Spanyol es-CL
Denmark Dansk da-DK
Finlandia Suomi fi-FI
Prancis Prancis fr-FR
Jerman Jerman de-DE
Hong Kong SAR Mandarin Tradisional zh-HK
India Inggris en-IN
Indonesia Inggris en-ID
Italia Italia it-IT
Jepang Jepang ja-JP
Korea Korea ko-KR
Malaysia Inggris en-MY
Meksiko Spanyol es-MX
Belanda Belanda nl-NL
Selandia Baru Inggris en-NZ
Republik Rakyat Tiongkok Mandarin zh-CN
Polandia Polski pl-PL
Portugal Portugis pt-PT
Republik Filipina Inggris en-PH
Rusia Rusia ru-RU
Arab Saudi Arab ar-SA
Afrika Selatan Inggris en-ZA
Spanyol Spanyol es-ES
Swedia Swedia sv-SE
Swiss Prancis fr-CH
Swiss Jerman de-CH
Taiwan Mandarin Tradisional zh-TW
Turki Turki tr-TR
Inggris Raya Inggris en-GB
Amerika Serikat Inggris en-US
Amerika Serikat Spanyol es-US

Kode negara

Berikut ini adalah kode negara yang dapat Anda tentukan dalam cc parameter kueri. Daftar ini dapat berubah.

Negara/Wilayah Kode negara
Argentina AR
Australia AU
Austria AT
Belgia BE
Brasil BR
Kanada CA
Cile CL
Denmark DK
Finlandia FI
Prancis FR
Jerman DE
Hong Kong SAR HK
India IN
Indonesia ID
Italia IT
Jepang JP
Korea KR
Malaysia MY
Meksiko MX
Belanda NL
Selandia Baru NZ
Norwegia NO
Republik Rakyat Tiongkok CN
Polandia PL
Portugal PT
Republik Filipina PH
Rusia RU
Arab Saudi SA
Afrika Selatan ZA
Spanyol ES
Swedia SE
Swiss CH
Taiwan TW
Turki TR
Inggris Raya GB
Amerika Serikat US

Bing bahasa yang didukung

Berikut ini adalah Bing bahasa yang didukung yang dapat Anda tentukan dalam setLang parameter kueri. Daftar ini dapat berubah.

Bahasa yang didukung Kode Bahasa
Arab ar
Basque eu
Bengali bn
Bulgaria bg
Katalan ca
Tionghoa (Aksara Sederhana) zh-hans
Tionghoa (Aksara Tradisional) zh-hant
Kroasia jam
Cheska cs
Denmark da
Belanda nl
Inggris en
Kerajaan English-United en-gb
Esti et
Suomi fi
Prancis fr
Galisia gl
Jerman de
Gujarat gu
Ibrani he
Hindi hi
Hungaria hu
Islandia is
Italia it
Jepang Jp
Kannada kn
Korea ko
Latvi lv
Lituavi lt
Melayu ms
Malayalam ml
Marathi mr
Norwegia (Bokmål) nb
Polandia pl
Portugis (Brasil) pt-br
Portugis (Portugal) pt-pt
Punjabi pa
Rumania ro
Rusia ru
Serbia (Sililik) sr
Slovakia sk
Slovenia sl
Spanyol es
Swedia sv
Tamil ta
Telugu te
Thailand th
Turki tr
Ukraina uk
Vietnam vi