algoliasearch client android

Klien API Pencarian Algolia untuk Android

Klien API Android kami adalah yang lama, dan hanya dalam mode pemeliharaan. Kami merekomendasikan penggunaan klien API Kotlin kami yang lebih cocok untuk pengembangan Android.

Algolia Search adalah mesin pencari yang dihosting yang mampu memberikan hasil real-time dari penekanan tombol pertama.

Klien Algolia Search API untuk Android memungkinkan Anda menggunakan REST API Algolia Search dengan mudah dari kode Android Anda.

Catatan: Jika Anda menggunakan klien Android kami versi 2.x , baca panduan migrasi ke versi 3.x.

Anda dapat menelusuri dokumentasi referensi yang dibuat secara otomatis.

Proyek ini bersifat open-source di bawah Lisensi MIT.

Berkontribusi

Kontribusi Anda diterima! Harap gunakan konfigurasi pemformatan kami untuk menjaga gaya pengkodean tetap konsisten.

Dokumentasi API

Anda dapat menemukan referensi lengkapnya di website Algolia.

1. Berkontribusi

2. Memasang

3. Mulai Cepat

4. Dorong data

5. Konfigurasikan

6. Mencari

7. Daftar metode yang tersedia

8. Mendapatkan Bantuan

9. Daftar metode yang tersedia

Memulai

Memasang

Instal klien Android dengan menambahkan dependensi berikut ke file build Gradle Anda:

 dependencies {
    // [...]
    implementation ' com.algolia:algoliasearch-android:3.+ '
    // This will automatically update to the latest v3 release when you build your project
}

Mulai Cepat

Dalam 30 detik, tutorial memulai cepat ini akan menunjukkan cara mengindeks dan mencari objek.

Inisialisasi klien

Untuk memulai, Anda perlu menginisialisasi klien. Untuk melakukan ini, Anda memerlukan ID Aplikasi dan Kunci API Anda. Anda dapat menemukan keduanya di akun Algolia Anda.

 Client client = new Client ( "YourApplicationID" , "YourAPIKey" );
Index index = client . getIndex ( "your_index_name" );

Peringatan: Jika Anda membuat aplikasi asli di perangkat seluler, pastikan untuk tidak menyertakan kunci API penelusuran langsung di kode sumber . Anda sebaiknya mempertimbangkan untuk mengambil kunci dari server Anda saat aplikasi dimulai.

Dorong data

Tanpa konfigurasi sebelumnya, Anda dapat mulai mengindeks kontak di indeks contacts menggunakan kode berikut:

 Index index = client . initIndex ( "contacts" );
index . addObjectAsync ( new JSONObject ()
     . put ( "firstname" , "Jimmie" )
     . put ( "lastname" , "Barninger" )
     . put ( "followers" , 93 )
     . put ( "company" , "California Paint" ), null );
index . addObjectAsync ( new JSONObject ()
     . put ( "firstname" , "Warren" )
     . put ( "lastname" , "Speach" )
     . put ( "followers" , 42 )
     . put ( "company" , "Norwalk Crmc" ), null );

Konfigurasikan

Anda dapat menyesuaikan pengaturan untuk menyempurnakan perilaku pencarian. Misalnya, Anda dapat menambahkan peringkat khusus berdasarkan jumlah pengikut untuk lebih meningkatkan relevansi bawaan:

 JSONObject settings = new JSONObject (). append ( "customRanking" , "desc(followers)" );
index . setSettingsAsync ( settings , null );

Anda juga dapat mengonfigurasi daftar atribut yang ingin Anda indeks berdasarkan urutan kepentingannya (yang paling penting terlebih dahulu).

Catatan: Algolia dirancang untuk menyarankan hasil saat Anda mengetik, yang berarti Anda biasanya akan mencari berdasarkan awalan. Dalam hal ini, urutan atribut sangat penting untuk menentukan pukulan mana yang terbaik.

 JSONObject settings = new JSONObject ()
      . put ( "searchableAttributes" , "lastname" )
      . put ( "searchableAttributes" , "firstname" )
      . put ( "searchableAttributes" , "company" );
index . setSettingsAsync ( settings , null );

Mencari

Anda sekarang dapat mencari kontak berdasarkan firstname , lastname , company , dll. (bahkan dengan kesalahan ketik):

 CompletionHandler completionHandler = new CompletionHandler () {
    @ Override
    public void requestCompleted ( JSONObject content , AlgoliaException error ) {
        // [...]
    }
};
// Search for a first name
index . searchAsync ( new Query ( "jimmie" ), completionHandler );
// Search for a first name with typo
index . searchAsync ( new Query ( "jimie" ), completionHandler );
// Search for a company
index . searchAsync ( new Query ( "california paint" ), completionHandler );
// Search for a first name and a company
index . searchAsync ( new Query ( "jimmie paint" ), completionHandler );

Daftar metode yang tersedia

Personalisasi

• Tambahkan strategi
• Dapatkan strategi

Mencari

• Indeks pencarian
• Cari nilai faset
• Cari beberapa indeks
• Telusuri indeks

Pengindeksan

• Tambahkan objek
• Simpan objek
• Objek pembaruan sebagian
• Hapus objek
• Ganti semua objek
• Hapus oleh
• Hapus objek
• Dapatkan objek
• Kumpulan khusus

Pengaturan

• Dapatkan pengaturan
• Tetapkan pengaturan
• Salin pengaturan

Kelola indeks

• Daftar indeks
• Hapus indeks
• Salin indeks
• Pindahkan indeks

Kunci API

• Buat Kunci API yang aman
• Tambahkan Kunci API
• Perbarui Kunci API
• Hapus Kunci API
• Pulihkan Kunci API
• Dapatkan izin Kunci API
• Daftar Kunci API

Sinonim

• Simpan sinonim
• Sinonim kumpulan
• Hapus sinonim
• Hapus semua sinonim
• Dapatkan sinonim
• Cari sinonim
• Ganti semua sinonim
• Salin sinonim
• Ekspor Sinonim

Aturan kueri

• Simpan aturan
• Aturan kumpulan
• Dapatkan aturan
• Hapus aturan
• Aturan yang jelas
• Aturan pencarian
• Ganti semua aturan
• Salin aturan
• Aturan ekspor

Tes A/B

• Tambahkan pengujian A/B
• Dapatkan tes A/B
• Buat daftar pengujian A/B
• Hentikan pengujian A/B
• Hapus pengujian A/B

Wawasan

• ID Objek yang Diklik Setelah Pencarian
• ID Objek yang diklik
• Filter yang Diklik
• ID Objek yang Dikonversi Setelah Pencarian
• ID Objek yang Dikonversi
• Filter yang Dikonversi
• ID Objek yang Dilihat
• Filter yang Dilihat

MultiCluster

• Tetapkan atau Pindahkan ID pengguna
• Dapatkan ID pengguna teratas
• Dapatkan ID pengguna
• Daftar cluster
• Daftar ID pengguna
• Hapus ID pengguna
• Cari ID pengguna

Canggih

• Dapatkan log
• Mengonfigurasi batas waktu
• Tetapkan tajuk tambahan
• Tunggu operasi

Mendapatkan Bantuan

• Butuh bantuan ? Ajukan pertanyaan ke Komunitas Algolia atau di Stack Overflow.
• Mengalami masalah? Sebelum menghubungi dukungan, kami sarankan untuk membuka FAQ kami di mana Anda akan menemukan jawaban untuk masalah paling umum dan masalah yang dihadapi klien.
• Menemukan bug? Anda dapat membuka masalah GitHub.