AppSetId

public class AppSetId
extends Object

java.lang.Object
   ↳ 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 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

int SCOPE_APP

The appSetId is scoped to an app.

int SCOPE_DEVELOPER

The appSetId is scoped to a developer account on an app store.

Public constructors

AppSetId(String appSetId, int appSetIdScope)

Creates an instance of AppSetId

Public methods

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

String getId()

Retrieves the appSetId.

int getScope()

Retrieves the scope of the appSetId.

int hashCode()

Returns a hash code value for the object.

Inherited methods

Constants

SCOPE_APP

public static final int SCOPE_APP

The appSetId is scoped to an app. All apps on a device will have a different appSetId.

Constant Value: 1 (0x00000001)

SCOPE_DEVELOPER

public static final int SCOPE_DEVELOPER

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.

Constant Value: 2 (0x00000002)

Public constructors

AppSetId

public AppSetId (String appSetId, 
                int appSetIdScope)

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 SCOPE_APP, or SCOPE_DEVELOPER

Public methods

equals

Added in API level 34
public boolean equals (Object o)

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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getId

public String getId ()

Retrieves the appSetId. The api always returns a non-empty appSetId.

Returns
String This value cannot be null.

getScope

public int getScope ()

Retrieves the scope of the appSetId.

Returns
int Value is SCOPE_APP, or SCOPE_DEVELOPER

hashCode

Added in API level 34
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals(Object) method, then calling the hashCode method 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 equals(java.lang.Object) method, then calling the hashCode method 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)

Returns
int a hash code value for this object.