algoliasearch client android
3.27.0
Android API クライアントはレガシーであり、メンテナンス モードのみです。 Android 開発に適した Kotlin API クライアントを使用することをお勧めします。
Algolia Search は、最初のキーストロークからリアルタイムの結果を提供できるホスト型検索エンジンです。
Android 用 Algolia Search API クライアントを使用すると、Android コードから Algolia Search REST API を簡単に使用できます。
注: Android クライアントのバージョン 2.x を使用していた場合は、バージョン 3.x への移行ガイドをお読みください。
自動生成されたリファレンス ドキュメントを参照できます。
このプロジェクトは MIT ライセンスの下でオープンソースです。
あなたの貢献は大歓迎です!コーディングスタイルの一貫性を保つために、フォーマット設定を使用してください。
完全なリファレンスは Algolia の Web サイトでご覧いただけます。
貢献する
インストール
クイックスタート
プッシュデータ
設定する
検索
利用可能なメソッドのリスト
助けを求める
利用可能なメソッドのリスト
次の依存関係をGradleビルド ファイルに追加して、Android クライアントをインストールします。
dependencies {
// [...]
implementation ' com.algolia:algoliasearch-android:3.+ '
// This will automatically update to the latest v3 release when you build your project
}このクイック スタート チュートリアルでは、オブジェクトのインデックス作成と検索の方法を 30 秒で説明します。
開始するには、クライアントを初期化する必要があります。これを行うには、アプリケーション IDとAPI キーが必要です。どちらも Algolia アカウントで見つけることができます。
Client client = new Client ( "YourApplicationID" , "YourAPIKey" );
Index index = client . getIndex ( "your_index_name" );警告:モバイル上でネイティブ アプリを構築している場合は、検索 API キーをソース コードに直接含めないように注意してください。代わりに、アプリの起動時にサーバーからキーを取得することを検討する必要があります。
事前の構成を行わなくても、次のコードを使用して連絡先インデックス内のcontacts先のインデックス作成を開始できます。
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 );設定をカスタマイズして検索動作を微調整できます。たとえば、フォロワー数によるカスタム ランキングを追加して、組み込みの関連性をさらに高めることができます。
JSONObject settings = new JSONObject (). append ( "customRanking" , "desc(followers)" );
index . setSettingsAsync ( settings , null );また、インデックスを作成する属性のリストを重要度順に (最も重要なものが最初に) 構成することもできます。
注: Algolia は、入力時に結果を提案するように設計されています。つまり、通常は接頭辞で検索することになります。この場合、どのヒットが最適であるかを決定するには、属性の順序が重要です。
JSONObject settings = new JSONObject ()
. put ( "searchableAttributes" , "lastname" )
. put ( "searchableAttributes" , "firstname" )
. put ( "searchableAttributes" , "company" );
index . setSettingsAsync ( settings , null );firstname 、 lastname 、 companyなどで連絡先を検索できるようになりました (入力ミスも含めて)。
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 );
