GetTopicsRequest

Artifact: androidx.privacysandbox.ads:ads-adservices

View Source

Added in 1.0.0

---

Kotlin |Java

public final class GetTopicsRequest

---

Represents the request for the getTopics API (which takes a GetTopicsRequest and returns a GetTopicsResponse.

Summary

Nested types
public final class GetTopicsRequest.Builder Builder for GetTopicsRequest.

Public constructors
GetTopicsRequest(     @NonNull String adsSdkName,     boolean shouldRecordObservation )

Public methods
boolean	equals(Object other)
final @NonNull String	getAdsSdkName() The Ads SDK name.
int	hashCode()
final boolean	shouldRecordObservation() whether to record that the caller has observed the topics of the host app or not.
@NonNull String	toString()

Public constructors

GetTopicsRequest

Added in 1.0.0

public GetTopicsRequest(
    @NonNull String adsSdkName,
    boolean shouldRecordObservation
)

Parameters
@NonNull String adsSdkName	The Ads SDK name. This must be called by SDKs running outside of the Sandbox. Other clients must not call it.
boolean shouldRecordObservation	whether to record that the caller has observed the topics of the host app or not. This will be used to determine if the caller can receive the topic in the next epoch.

Public methods

equals

public boolean equals(Object other)

getAdsSdkName

Added in 1.0.0

public final @NonNull String getAdsSdkName()

The Ads SDK name. This must be called by SDKs running outside of the Sandbox. Other clients must not call it.

hashCode

public int hashCode()

shouldRecordObservation

Added in 1.1.0-beta11

public final boolean shouldRecordObservation()

whether to record that the caller has observed the topics of the host app or not. This will be used to determine if the caller can receive the topic in the next epoch.

toString

public @NonNull String toString()