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

# AppSetId

*** ** * ** ***

Kotlin \|[Java](https://developer.android.com/reference/android/adservices/appsetid/AppSetId "View this page in Java")

```
open class AppSetId
```

|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||
| ↳ | [android.adservices.appsetid.AppSetId](https://developer.android.com/reference/kotlin/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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#SCOPE_APP:kotlin.Int` The appSetId is scoped to an app. |
| static [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#SCOPE_DEVELOPER:kotlin.Int` The appSetId is scoped to a developer account on an app store. |

| Public constructors ||
|---|---|
| `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#AppSetId(kotlin.String,%20kotlin.Int)(appSetId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, appSetIdScope: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)` Creates an instance of `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#` |

| Public methods ||
|---|---|
| open [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#equals(kotlin.Any)(other: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?)` Indicates whether some other object is "equal to" this one. |
| open [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#getId()()` Retrieves the appSetId. |
| open [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#getScope()()` Retrieves the scope of the appSetId. |
| open [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#hashCode()()` Returns a hash code value for the object. |

## Constants

### SCOPE_APP

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

```
static val SCOPE_APP: Int
```

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

    Value: 1

### SCOPE_DEVELOPER

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

```
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: 2

## Public constructors

### AppSetId

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

```
AppSetId(
    appSetId: String, 
    appSetIdScope: Int)
```

Creates an instance of `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#`

| Parameters ||
|---|---|
| `appSetId` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html): generated by the provider service. This value cannot be `null`. |
| `appSetIdScope` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html): scope of the appSetId. Value is one of the following: - `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#SCOPE_APP:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#SCOPE_DEVELOPER:kotlin.Int` |

## Public methods

### equals

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

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

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 ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `true` if this object is the same as the obj argument; `false` otherwise. |

### getId

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

```
open fun getId(): String
```

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

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | This value cannot be `null`. |

### getScope

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

```
open fun getScope(): Int
```

Retrieves the scope of the appSetId.

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | Value is one of the following: - `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#SCOPE_APP:kotlin.Int` - `https://developer.android.com/reference/kotlin/android/adservices/appsetid/AppSetId#SCOPE_DEVELOPER:kotlin.Int` |

### hashCode

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

```
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 `https://developer.android.com/reference/kotlin/java/util/HashMap.html#`.

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

| Return ||
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | a hash code value for this object. |