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/appsetid/AppSetId#constants) \| [Ctors](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#pubctors) \| [Methods](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#pubmethods) \| [Inherited Methods](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#inhmethods)  

# AppSetId


`
public


class
AppSetId
`


`

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


`

`


`

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

<br />

*** ** * ** ***

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)](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetIdManager#getAppSetId(java.util.concurrent.Executor,%20android.os.OutcomeReceiver<android.adservices.appsetid.AppSetId,java.lang.Exception>)) 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](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#SCOPE_APP) The appSetId is scoped to an app.                                          |
| `int` | [SCOPE_DEVELOPER](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#SCOPE_DEVELOPER) The appSetId is scoped to a developer account on an app store. |

|                                                                                                                                                                                          ### Public constructors                                                                                                                                                                                          ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[AppSetId](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#AppSetId(java.lang.String,%20int))`(`[String](https://developer.android.com/reference/java/lang/String)` appSetId, int appSetIdScope) ` Creates an instance of [AppSetId](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId) |

|                                                                                                                                                                     ### Public methods                                                                                                                                                                     ||
|-----------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` boolean`                                                            | ` `[equals](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#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) | ` `[getId](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#getId())`() ` Retrieves the appSetId.                                                                                                                             |
| ` int`                                                                | ` `[getScope](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#getScope())`() ` Retrieves the scope of the appSetId.                                                                                                          |
| ` int`                                                                | ` `[hashCode](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#hashCode())`() ` Returns a hash code value for 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

### SCOPE_APP

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 int SCOPE_APP
```

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

<br />

Constant Value:

1
(0x00000001)


### SCOPE_DEVELOPER

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

<br />

Constant Value:

2
(0x00000002)


## Public constructors

### AppSetId

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 AppSetId (String appSetId, 
                int appSetIdScope)
```

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

<br />

|                                                                                                                                                                 Parameters                                                                                                                                                                 ||
|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `appSetId`      | `String`: generated by the provider service. This value cannot be `null`. <br />                                                                                                                                                                                                                                          |
| `appSetIdScope` | `int`: scope of the appSetId. Value is [SCOPE_APP](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#SCOPE_APP), or [SCOPE_DEVELOPER](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#SCOPE_DEVELOPER) <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 /> |

### getId

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 getId ()
```

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

<br />

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

### getScope

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 int getScope ()
```

Retrieves the scope of the appSetId.

<br />

|                                                                                                                                              Returns                                                                                                                                               ||
|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | Value is [SCOPE_APP](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#SCOPE_APP), or [SCOPE_DEVELOPER](https://developer.android.com/design-for-safety/privacy-sandbox/reference/adservices/appsetid/AppSetId#SCOPE_DEVELOPER) <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 /> |