AppSearch

ユーザーガイドコードサンプル

API リファレンス
androidx.appsearch.annotation
androidx.appsearch.app
androidx.appsearch.exceptions
androidx.appsearch.localstorage
androidx.appsearch.platformstorage

AppSearch は、全文検索を使用してデータをインデックスに登録する API とデータを取得する API を備え、ローカルに保存されている構造化データを管理するためのデバイス上の検索ライブラリです。ユーザー向けにカスタムのアプリ内検索機能を構築するのに使用します。

最新の更新	安定版リリース	リリース候補版	ベータ版リリース	アルファ版リリース
2022 年 8 月 24 日	-	-	-	1.1.0-alpha02

依存関係の宣言

AppSearch への依存関係を追加するには、Google の Maven リポジトリをプロジェクトに追加する必要があります。詳しくは、Google の Maven リポジトリをご覧ください。

アプリまたはモジュールの build.gradle ファイルに、必要なアーティファクトの依存関係を追加します。

Groovy

dependencies {
    def appsearch_version = "1.1.0-alpha02"

    implementation "androidx.appsearch:appsearch:$appsearch_version"
    // Use kapt instead of annotationProcessor if writing Kotlin classes
    annotationProcessor "androidx.appsearch:appsearch-compiler:$appsearch_version"

    implementation "androidx.appsearch:appsearch-local-storage:$appsearch_version"
    // PlatformStorage is compatible with Android 12+ devices, and offers additional features
    // to LocalStorage.
    implementation "androidx.appsearch:appsearch-platform-storage:$appsearch_version"
}

Kotlin

dependencies {
    val appsearch_version = "1.1.0-alpha02"

    implementation("androidx.appsearch:appsearch:$appsearch_version")
    // Use annotationProcessor instead of kapt if writing Java classes
    kapt("androidx.appsearch:appsearch-compiler:$appsearch_version")

    implementation("androidx.appsearch:appsearch-local-storage:$appsearch_version")
    // PlatformStorage is compatible with Android 12+ devices, and offers additional features
    // to LocalStorage.
    implementation("androidx.appsearch:appsearch-platform-storage:$appsearch_version")
}

依存関係について詳しくは、ビルド依存関係の追加をご覧ください。

フィードバック

お寄せいただいたフィードバックは Jetpack 改善の参考にさせていただきます。新しい問題が見つかった場合や、このライブラリを改善するアイデアをお持ちの場合は、お知らせください。新しい問題を報告していただく前に、このライブラリの既存の問題をご確認ください。スターボタンをクリックすると、既存の問題に投票できます。

新しい問題を報告する

詳細については、Issue Tracker のドキュメントをご覧ください。

バージョン 1.1

バージョン 1.1.0-alpha02

2022 年 8 月 24 日

androidx.appsearch:appsearch-*:1.1.0-alpha02 がリリースされました。バージョン 1.1.0-alpha02 に含まれる commit については、こちらをご覧ください。

新機能

インデックスを最初から作り直すのではなく、インデックスの圧縮を使用して最適化プロセスを高速化しました
ネイティブロギングタグを「icing」から「AppSearchIcing」に変更し、INFO メッセージをデフォルトで記録するようになりました

API の変更

パスを操作するための新しい PropertyPath オブジェクトと、PropertyPath を受け入れるための新しい addProjection メソッドを追加しました。（I45588）
AppSearch 組み込みタイプに builtin:Thing を追加しました（I55427）
GenericDocument 内の空のプロパティ名の阻止を早めました。以前はインデックス登録時に阻止していましたが、GenericDocument.Builder.build() 時に防止するようになりました（I9e780）

バグの修正

不要な文字列形式を削除して、関連性スコアのパフォーマンスを改善しました
読み取れないドキュメントや削除されたドキュメントに対処する際のページ分けの効率を改善しました
放棄されたクエリに対するガベージコレクションを実装しました
ドキュメントのインデックス登録のネストに関するサポートを修正しました。以前は indexNestedProperties が無視されていました。（Iae9a6）

外部からの協力

Shea Smith: ドキュメントのインデックス登録のネストに関するサポートを修正しました。（Iae9a6）

バージョン 1.1.0-alpha01

2022 年 6 月 15 日

androidx.appsearch:appsearch-*:1.1.0-alpha01 がリリースされました。バージョン 1.1.0-alpha01 は非公開のプレリリースブランチで開発されており、公開版の commit はありません。

API の変更

ListenableFuture を返すすべてのメソッドの名前が変更され、Async という接尾辞が付くようになりました。たとえば、getSchema は getSchemaAsync に変更されました。以前のバージョンのサポートは終了しました。今後のリリースで削除される予定です。

新機能

appsearch-builtin-type の最初のリリースです。このプロジェクトには schema.org をベースとする組み込みのタイプがいくつか含まれます。クライアントにとって、一般的なオブジェクトに対して独自のタイプを定義するよりも使いやすい可能性があります。今後のリリースで、さらにタイプが追加される予定です。
ShortcutAdapter を使用して AppSearch ドキュメントを ShortcutInfoCompat に変換できるようになりました。これにより、クライアントは core-google-shortcuts ライブラリを使用して AppSearch ドキュメントを Google と共有できます。
@Document クラスで継承を使用できるようになりました。フィールドの置換や変更は行えませんが、新しいフィールドは、@Document のアノテーションを付けてクラスを拡張することで追加できます。
新しい Observer API を使用して、クライアントは、アクセス権のあるタイプが変更されたとき、またはそれらのタイプのドキュメントが追加、変更、削除されたときの通知を登録できるようになりました。重要: 現在の実装では、通知はアプリの実行時のみ配信されます。現時点では、アプリの停止中に発生した変更を確認する方法はありません。そのため、完全性を求めてこの API を利用しないでください。
Property Parser API を使用して、MatchInfo#getPropertyPath から返されるプロパティパスを完全に処理、検査できるようになりました。
グローバル getById とグローバル getSchema の API を使用して、公開設定が許可されている他のアプリからドキュメントとスキーマを取得できるようになりました。
アクセス権のあるデータの公開設定情報を getSchema で取得できるようになりました。
特定の Android 権限（許可リストに登録された一部の権限のみ）を保持しているアプリの公開設定を許可できるようになりました。
以前のサポートされているスタイル hasFoo() に加えて、アノテーションプロセッサでブール値フィールドに対し isFoo() スタイルのゲッターをサポートするようになりました。
@RequiresFeature で保護されている新しい機能をサポートするようになりました。AppSearchSession#getFeatures を使用して、現在のバックエンドのサポート対象を確認します。
ドキュメントごとの 13,000 件のトークン上限を廃止しました。
絵文字など、ASCII 以外 + 英数字以外での一致を許可しました。

バグの修正

ネストされた互換性のないタイプをオーバーライドすると SetSchema が失敗するバグを修正しました。
AppSearch の @Document クラスとして使用される @AutoValue アノテーション付きクラスを完全にサポートするよう修正しました。
ドキュメントクラスの繰り返しリストに関連するクラッシュやその他の問題を修正しました。
特定の状況で接頭辞の検索がクラッシュするバグを修正しました。
IO 障害が発生した場合に間違った値を返す GetStorageInfo の軽微なバグを修正しました。
ドキュメントを読み取る際の BUSADDERR に関する問題を修正しました。
フォーマットされていないフィンガープリントの印刷が原因で Logcat が壊れる問題を修正しました。
IO 障害が原因の NPE を修正しました。
GetSchemaType、Get、Delete、DeleteByNamespace、DeleteBySchemaType でのメモリリークを修正しました。

バージョン 1.0.0

バージョン 1.0.0-alpha04

2021 年 11 月 3 日

androidx.appsearch:appsearch-*:1.0.0-alpha04 がリリースされました。バージョン 1.0.0-alpha04 に含まれる commit については、こちらをご覧ください。

新機能

Guava ListenableFuture 依存関係が API 依存関係として自動的に導入されました

API の変更

各一致に関する詳細情報を提供するため、SearchResult#getSubmatchRange() と SearchResult#getSubmatch() を追加しました。（I2fef6）
パッケージ名と証明書でデータを共有するために PackageIdentifier のフィンガープリントを生成する方法について、ドキュメントを明確化しました

バグの修正

結果セットの終了後にユーザーが結果ページを取得しようとした場合にクラッシュする問題を修正しました
無効な名前空間のみがクエリフィルタとして提供された場合に、すべての名前空間に対してクエリが実行される問題を修正しました
無効な名前空間のみが削除のクエリフィルタとして提供された場合に、すべての名前空間が削除される問題を修正しました
非常に大きなドキュメントで、特定の時点以降、ドキュメントデータのインデックス登録が停止する問題を修正しました
トークン化により ASCII 以外の数字を含むセグメントがドロップされる問題を修正しました
初期化が連続して失敗する場合の確認を追加し、初期化を妨げる不適切な状態から抜け出せるようにしました

バージョン 1.0.0-alpha03

2021 年 7 月 21 日

androidx.appsearch:appsearch-*:1.0.0-alpha03 がリリースされました。バージョン 1.0.0-alpha03 に含まれる commit については、こちらをご覧ください。

新機能

プラットフォームストレージバックエンドがリリースされ、Android S でリリースされる新しい android.app.appsearch.AppSearchManager サービスで AppSearch API を使用できるようになりました。詳しくは、AppSearch デベロッパーガイドをご覧ください。
AutoValue に対するアノテーションプロセッサのサポート
1 つの文字列プロパティのサイズの上限の削除
初期化レイテンシを短縮するための新しいストレージ形式の追加
古いストレージ形式から新しいストレージ形式への 1 回限りの内部データ移行

バグの修正

新しいドキュメントを挿入するときに、ドキュメント数の上限を正しく適用するようになりました
AppSearchSession の作成中にクラッシュする問題を修正しました
一部の下位非互換性とインデックスの非互換性が検出されない SetSchema のバグを修正しました

バージョン 1.0.0-alpha02

2021 年 6 月 30 日

androidx.appsearch:appsearch:1.0.0-alpha02、androidx.appsearch:appsearch-compiler:1.0.0-alpha02、androidx.appsearch:appsearch-local-storage:1.0.0-alpha02 がリリースされました。バージョン 1.0.0-alpha02 に含まれる commit については、こちらをご覧ください。

新機能

中国語、日本語、韓国語、タイ語の完全サポート
androidx.appsearch:appsearch-local-storage のサイズの縮小
繰り返しプロパティのサイズの上限の削除
ビルダークラスの再利用が可能
デバッグしやすくするための、特定のオブジェクトの toString() の改善
Javadoc ドキュメントの改善

API の変更

SearchResult#getMatches の名前を SearchResult#getMatchInfos に変更しました
@Document.Int64Property の名前を @Document.LongProperty に変更しました

バグの修正

結果スニペットの計算の改善と修正
AppSearchSession の初期化のバグの修正

バージョン 1.0.0-alpha01

2021 年 5 月 5 日

androidx.appsearch:appsearch:1.0.0-alpha01、androidx.appsearch:appsearch-compiler:1.0.0-alpha01、androidx.appsearch:appsearch-local-storage:1.0.0-alpha01 がリリースされました。バージョン 1.0.0-alpha01 に含まれる commit については、こちらをご覧ください。

新機能

AppSearch は、全文検索を介してデータをインデックスに登録する API とデータを取得する API を備えた、ローカルに保存されている構造化データを管理するための検索ライブラリです。ユーザー向けにカスタムのアプリ内検索機能を構築するのに使用します。この初回リリースは 1.0.0-alpha01 です。