Stay organized with collections Save and categorize content based on your preferences.

AdId

public class AdId
extends Object

java.lang.Object
   ↳ android.adservices.adid.AdId


A unique, user-resettable, device-wide, per-profile ID for advertising.

Ad networks may use AdId to monetize for interest-based advertising (IBA), i.e. targeting and remarketing ads. The user may limit availability of this identifier.

Summary

Constants

String ZERO_OUT

A zeroed-out ad id that is returned when the user has limited ad tracking.

Public constructors

AdId(String adId, boolean limitAdTrackingEnabled)

Creates an instance of AdId

Public methods

boolean equals(Object o)

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

String getAdId()

The advertising ID.

int hashCode()

Returns a hash code value for the object.

boolean isLimitAdTrackingEnabled()

Retrieves the limit ad tracking enabled setting.

Inherited methods

Constants

ZERO_OUT

public static final String ZERO_OUT

A zeroed-out ad id that is returned when the user has limited ad tracking.

Constant Value: "00000000-0000-0000-0000-000000000000"

Public constructors

AdId

public AdId (String adId, 
                boolean limitAdTrackingEnabled)

Creates an instance of AdId

Parameters
adId String: obtained from the provider service. This value cannot be null.

limitAdTrackingEnabled boolean: value from the provider service which determines the value of adId.

Public methods

equals

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.

getAdId

public String getAdId ()

The advertising ID.

The value of advertising Id depends on a combination of isLimitAdTrackingEnabled() and AdServicesPermissions.ACCESS_ADSERVICES_AD_ID.

When the user is limiting ad tracking, the API returns ZERO_OUT. This disallows a caller to track the user for monetization purposes.

Otherwise, a string unique to the device and user is returned, which can be used to track users for advertising.

Returns
String This value cannot be null.

hashCode

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. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

isLimitAdTrackingEnabled

public boolean isLimitAdTrackingEnabled ()

Retrieves the limit ad tracking enabled setting.

This value is true if user has limit ad tracking enabled, false otherwise.

Returns
boolean