Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in[Ad Services Extensions 4](https://developer.android.com/sdkExtensions)  
Summary:[Constants](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#constants)\|[Ctors](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#pubctors)\|[Methods](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#pubmethods)\|[Inherited Methods](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#inhmethods)  

# AdId

`
public


class
AdId
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.adservices.adid.AdId |

<br />

*** ** * ** ***

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.  
**See also:**

- [AdIdManager.getAdId(Executor, OutcomeReceiver)](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdIdManager#getAdId(java.util.concurrent.Executor,%20android.os.OutcomeReceiver<android.adservices.adid.AdId,java.lang.Exception>))

## Summary

|                                                                                                                                                                                                                                              ### Constants                                                                                                                                                                                                                                               ||
|--------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | [ZERO_OUT](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#ZERO_OUT) A zeroed-out[ad id](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#getAdId())that is returned when the user has[limited ad tracking](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#isLimitAdTrackingEnabled()). |

|                                                                                                                                                                                  ### Public constructors                                                                                                                                                                                  ||
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[AdId](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#AdId(java.lang.String,%20boolean))`(`[String](https://developer.android.com/reference/java/lang/String)` adId, boolean limitAdTrackingEnabled) ` Creates an instance of[AdId](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId) |

|                                                                                                                                                                 ### Public methods                                                                                                                                                                 ||
|-----------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` boolean`                                                            | ` `[equals](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` o) ` Indicates whether some other object is "equal to" this one. |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[getAdId](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#getAdId())`() ` The advertising ID.                                                                                                                             |
| ` int`                                                                | ` `[hashCode](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#hashCode())`() ` Returns a hash code value for the object.                                                                                                     |
| ` boolean`                                                            | ` `[isLimitAdTrackingEnabled](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#isLimitAdTrackingEnabled())`() ` Retrieves the limit ad tracking enabled setting.                                                              |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#toString())`() ` Returns a string representation of the object.                                                                                                |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||

## Constants

### ZERO_OUT

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in[Ad Services Extensions 4](https://developer.android.com/sdkExtensions)  

```
public static final String ZERO_OUT
```

A zeroed-out[ad id](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#getAdId())that is returned when the user has[limited ad tracking](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#isLimitAdTrackingEnabled()).

<br />

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

## Public constructors

### AdId

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in[Ad Services Extensions 4](https://developer.android.com/sdkExtensions)  

```
public AdId (String adId, 
                boolean limitAdTrackingEnabled)
```

Creates an instance of[AdId](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId)

<br />

|                                                   Parameters                                                    ||
|--------------------------|---------------------------------------------------------------------------------------|
| `adId`                   | `String`: obtained from the provider service. This value cannot be`null`. <br />      |
| `limitAdTrackingEnabled` | `boolean`: value from the provider service which determines the value of adId. <br /> |

## Public methods

### equals

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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.

<br />

|                            Parameters                             ||
|-----|--------------------------------------------------------------|
| `o` | `Object`: the reference object with which to compare. <br /> |

|                                         Returns                                          ||
|-----------|-------------------------------------------------------------------------------|
| `boolean` | `true`if this object is the same as the obj argument;`false`otherwise. <br /> |

### getAdId

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in[Ad Services Extensions 4](https://developer.android.com/sdkExtensions)  

```
public String getAdId ()
```

The advertising ID.

The value of advertising Id depends on a combination of[isLimitAdTrackingEnabled()](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#isLimitAdTrackingEnabled())and[AdServicesPermissions.ACCESS_ADSERVICES_AD_ID](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/common/AdServicesPermissions#ACCESS_ADSERVICES_AD_ID).

When the user is[limiting ad tracking](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#isLimitAdTrackingEnabled()), the API returns[ZERO_OUT](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/adid/AdId#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.

<br />

|                                                Returns                                                 ||
|--------------------------------------------------------------------|------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | This value cannot be`null`. <br /> |

### hashCode

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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](https://developer.android.com/reference/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`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)](https://developer.android.com/reference/java/lang/Object#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.)

<br />

|                     Returns                      ||
|-------|-------------------------------------------|
| `int` | a hash code value for this object. <br /> |

### isLimitAdTrackingEnabled

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in[Ad Services Extensions 4](https://developer.android.com/sdkExtensions)  

```
public boolean isLimitAdTrackingEnabled ()
```

Retrieves the limit ad tracking enabled setting.

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

<br />

|      Returns      ||
|-----------|--------|
| `boolean` | <br /> |

### toString

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String toString ()
```

Returns a string representation of the object. In general, the`toString`method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The`toString`method for class`Object`returns a string consisting of the name of the class of which the object is an instance, the at-sign character \``@`', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
>
> ```
>  getClass().getName() + '@' + Integer.toHexString(hashCode())
>  
> ```

<br />

<br />

|                                                      Returns                                                      ||
|--------------------------------------------------------------------|-----------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object. <br /> |