algoliasearch client android

Client API de recherche Algolia pour Android

Notre client API Android est existant et en mode maintenance uniquement. Nous vous recommandons d'utiliser notre client API Kotlin qui est mieux adapté au développement Android.

Algolia Search est un moteur de recherche hébergé capable de fournir des résultats en temps réel dès la première frappe.

Le client API Algolia Search pour Android vous permet d'utiliser facilement l'API REST Algolia Search à partir de votre code Android.

Remarque : Si vous utilisiez la version 2.x de notre client Android, lisez le guide de migration vers la version 3.x.

Vous pouvez parcourir la documentation de référence générée automatiquement.

Ce projet est open source sous licence MIT.

Contribuer

Vos contributions sont les bienvenues ! Veuillez utiliser notre configuration de formatage pour maintenir la cohérence du style de codage.

Documentation API

Vous pouvez retrouver la référence complète sur le site d’Algolia.

1. Contribuer

2. Installer

3. Démarrage rapide

4. Envoyer des données

5. Configurer

6. Recherche

7. Liste des méthodes disponibles

8. Obtenir de l'aide

9. Liste des méthodes disponibles

Commencer

Installer

Installez le client Android en ajoutant la dépendance suivante à votre fichier de build Gradle :

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

Démarrage rapide

En 30 secondes, ce didacticiel de démarrage rapide vous montrera comment indexer et rechercher des objets.

Initialiser le client

Pour commencer, vous devez initialiser le client. Pour ce faire, vous avez besoin de votre ID d'application et de votre clé API . Vous pouvez retrouver les deux sur votre compte Algolia.

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

Attention : si vous créez une application native sur mobile, veillez à ne pas inclure la clé API de recherche directement dans le code source . Vous devriez plutôt envisager de récupérer la clé sur vos serveurs lors du démarrage de l'application.

Envoyer des données

Sans aucune configuration préalable, vous pouvez démarrer l'indexation des contacts dans l'index contacts à l'aide du code suivant :

 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 );

Configurer

Vous pouvez personnaliser les paramètres pour affiner le comportement de recherche. Par exemple, vous pouvez ajouter un classement personnalisé par nombre de followers pour améliorer encore la pertinence intégrée :

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

Vous pouvez également configurer la liste des attributs que vous souhaitez indexer par ordre d'importance (le plus important en premier).

Remarque : Algolia est conçu pour suggérer des résultats au fur et à mesure que vous tapez, ce qui signifie que vous effectuerez généralement une recherche par préfixe. Dans ce cas, l’ordre des attributs est crucial pour décider quel coup est le meilleur.

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

Recherche

Vous pouvez désormais rechercher des contacts par firstname , lastname , company , etc. (même avec des fautes de frappe) :

 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 );

Liste des méthodes disponibles

Personnalisation

• Ajouter une stratégie
• Obtenez une stratégie

Recherche

• Index de recherche
• Rechercher des valeurs de facettes
• Rechercher plusieurs index
• Parcourir l'index

Indexage

• Ajouter des objets
• Enregistrer des objets
• Objets de mise à jour partielle
• Supprimer des objets
• Remplacer tous les objets
• Supprimer par
• Effacer les objets
• Obtenir des objets
• Lot personnalisé

Paramètres

• Obtenir les paramètres
• Définir les paramètres
• Paramètres de copie

Gérer les indices

• Liste des indices
• Supprimer l'index
• Copier l'index
• Déplacer l'index

Clés API

• Créer une clé API sécurisée
• Ajouter une clé API
• Mettre à jour la clé API
• Supprimer la clé API
• Restaurer la clé API
• Obtenir les autorisations de la clé API
• Répertorier les clés API

Synonymes

• Enregistrer le synonyme
• Synonymes de lots
• Supprimer le synonyme
• Effacer tous les synonymes
• Obtenir un synonyme
• Rechercher des synonymes
• Remplacer tous les synonymes
• Copier les synonymes
• Exporter les synonymes

Règles de requête

• Enregistrer la règle
• Règles de lot
• Obtenir la règle
• Supprimer la règle
• Des règles claires
• Règles de recherche
• Remplacer toutes les règles
• Copier les règles
• Règles d'exportation

Test A/B

• Ajouter un test A/B
• Obtenez un test A/B
• Répertorier les tests A/B
• Arrêter le test A/B
• Supprimer le test A/B

Connaissances

• ID d'objet cliqué après la recherche
• ID d'objet cliqué
• Filtres cliqués
• ID d'objets convertis après la recherche
• ID d'objet convertis
• Filtres convertis
• ID d'objet consultés
• Filtres consultés

MultiClusters

• Attribuer ou déplacer un ID utilisateur
• Obtenez le meilleur ID utilisateur
• Obtenir l'ID utilisateur
• Répertorier les clusters
• Répertorier les ID utilisateur
• Supprimer l'ID utilisateur
• Rechercher l'ID utilisateur

Avancé

• Obtenir des journaux
• Configuration des délais d'attente
• Définir un en-tête supplémentaire
• Attendre les opérations

Obtenir de l'aide

• Besoin d'aide ? Posez une question à la communauté Algolia ou sur Stack Overflow.
• Vous rencontrez un problème ? Avant de contacter l'assistance, nous vous recommandons de consulter notre FAQ où vous trouverez des réponses aux problèmes et pièges les plus courants avec le client.
• Vous avez trouvé un bug ? Vous pouvez ouvrir un ticket GitHub.