ClickAction
@RequiresFeature(enforcement = "androidx.appsearch.app.Features#isFeatureSupported", name = Features.JOIN_SPEC_AND_QUALIFIED_ID)
@Document(name = "builtin:ClickAction")
class ClickAction : TakenAction
| kotlin.Any | ||
| ↳ | androidx.appsearch.usagereporting.TakenAction | |
| ↳ | androidx.appsearch.usagereporting.ClickAction | |
ClickAction is a built-in AppSearch document type that contains different metrics. Clients can report the user's click actions on a androidx.appsearch.app.SearchResult document.
In order to use this document type, the client must explicitly set this schema type via addDocumentClasses.
Click actions can be used as signals to boost ranking via androidx.appsearch.app.JoinSpec API in future search requests.
Since ClickAction is an AppSearch document, the client can handle deletion via removeAsync or document time-to-live (TTL). The default TTL is 60 days.
Summary
Nested types |
|---|
|
Builder for |
Public functions |
|
|---|---|
String? |
getQuery()Returns the user-entered search input (without any operators or rewriting) that yielded the |
String? |
Returns the qualified id of the |
Int |
Returns the global rank of the |
Int |
Returns the rank of the |
Long |
Returns the time in milliseconds that user stays on the |
Inherited functions |
||||||||
|---|---|---|---|---|---|---|---|---|
|
Public functions
getQuery
fun getQuery(): String?
Returns the user-entered search input (without any operators or rewriting) that yielded the androidx.appsearch.app.SearchResult on which the user clicked.
getReferencedQualifiedId
fun getReferencedQualifiedId(): String?
Returns the qualified id of the androidx.appsearch.app.SearchResult document that the user clicked on.
A qualified id is a string generated by package, database, namespace, and document id. See createQualifiedId for more details.
getResultRankGlobal
fun getResultRankGlobal(): Int
Returns the global rank of the androidx.appsearch.app.SearchResult document.
Global rank reflects the order of androidx.appsearch.app.SearchResult documents returned by AppSearch.
For example, AppSearch returns 2 pages with 10 androidx.appsearch.app.SearchResult documents for each page. Then the global ranks of them will be 1 to 10 for the first page, and 11 to 20 for the second page.
If unset, then the global rank of the androidx.appsearch.app.SearchResult document will be set to -1 to mark invalid.
getResultRankInBlock
fun getResultRankInBlock(): Int
Returns the rank of the androidx.appsearch.app.SearchResult document among the user-defined block.
The client can define its own custom definition for block, e.g. corpus name, group, etc.
For example, a client defines the block as corpus, and AppSearch returns 5 documents with corpus = ["corpus1", "corpus1", "corpus2", "corpus3", "corpus2"]. Then the block ranks of them = [1, 2, 1, 1, 2].
If the client is not presenting the results in multiple blocks, they should set this value to match getResultRankGlobal.
If unset, then the block rank of the androidx.appsearch.app.SearchResult document will be set to -1 to mark invalid.
getTimeStayOnResultMillis
fun getTimeStayOnResultMillis(): Long
Returns the time in milliseconds that user stays on the androidx.appsearch.app.SearchResult document after clicking it.