AppSetId
open class AppSetId
| kotlin.Any | |
| ↳ | android.adservices.appsetid.AppSetId |
A unique, per-device, per developer-account user-resettable ID for non-monetizing advertising usecases.
Represents the appSetID and scope of this appSetId from the android.adservices.appsetid.AppSetIdManager#getAppSetId(Executor,OutcomeReceiver) API. The scope of the ID can be per app or per developer account associated with the user. AppSetId is used for analytics, spam detection, frequency capping and fraud prevention use cases, on a given device, that one may need to correlate usage or actions across a set of apps owned by an organization.
Summary
| Constants | |
|---|---|
| static Int |
The appSetId is scoped to an app. |
| static Int |
The appSetId is scoped to a developer account on an app store. |
| Public constructors | |
|---|---|
|
Creates an instance of |
|
| Public methods | |
|---|---|
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open String |
getId()Retrieves the appSetId. |
| open Int |
getScope()Retrieves the scope of the appSetId. |
| open Int |
hashCode()Returns a hash code value for the object. |
Constants
SCOPE_APP
static val SCOPE_APP: Int
The appSetId is scoped to an app. All apps on a device will have a different appSetId.
Value: 1SCOPE_DEVELOPER
static val SCOPE_DEVELOPER: Int
The appSetId is scoped to a developer account on an app store. All apps from the same developer on a device will have the same developer scoped appSetId.
Value: 2Public constructors
AppSetId
AppSetId(
appSetId: String,
appSetIdScope: Int)
Creates an instance of AppSetId
| Parameters | |
|---|---|
appSetId |
String: generated by the provider service. This value cannot be null. |
appSetIdScope |
Int: scope of the appSetId. Value is one of the following: |
Public methods
equals
open fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getId
open fun getId(): String
Retrieves the appSetId. The api always returns a non-empty appSetId.
| Return | |
|---|---|
String |
This value cannot be null. |
getScope
open fun getScope(): Int
Retrieves the scope of the appSetId.
| Return | |
|---|---|
Int |
Value is one of the following: |
hashCode
open fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |