EventUrlProvider

Kotlin |Java

public class EventUrlProvider
extends Object

java.lang.Object
↳	android.adservices.ondevicepersonalization.EventUrlProvider

This class is deprecated.
The ODP APIs are deprecated and will not be supported in future Android releases. There is no direct replacement API available. Developers currently integrated with these APIs must cease further integration efforts. For comprehensive details regarding this deprecation and the future roadmap of Privacy Sandbox on Android, please consult the official Privacy Sandbox developer documentation and announcements: https://privacysandbox.google.com

Generates event tracking URLs for a request. The service can embed these URLs within the HTML output as needed. When the HTML is rendered within an ODP WebView, ODP will intercept requests to these URLs, call IsolatedWorker#onEvent(EventInput, android.os.OutcomeReceiver), and log the returned output in the EVENTS table.

Summary

Public methods
`Uri`	`createEventTrackingUrlWithRedirect(PersistableBundle eventParams, Uri destinationUrl)` Creates an event tracking URL that redirects to the provided destination URL when it is clicked in an ODP webview.
`Uri`	`createEventTrackingUrlWithResponse(PersistableBundle eventParams, byte[] responseData, String mimeType)` Creates an event tracking URL that returns the provided response.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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(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()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

createEventTrackingUrlWithRedirect

Added in API level 35

public Uri createEventTrackingUrlWithRedirect (PersistableBundle eventParams, 
                Uri destinationUrl)

Creates an event tracking URL that redirects to the provided destination URL when it is clicked in an ODP webview.
This method may take several seconds to complete, so it should only be called from a worker thread.

Parameters
`eventParams`	`PersistableBundle`: The data to be passed to `IsolatedWorker#onEvent(EventInput, android.os.OutcomeReceiver)` when the event occurs. This value cannot be `null`.
`destinationUrl`	`Uri`: The URL to redirect to. This value may be `null`.

Returns
`Uri`	An ODP event URL that can be inserted into a WebView. This value cannot be `null`.

createEventTrackingUrlWithResponse

Added in API level 35

public Uri createEventTrackingUrlWithResponse (PersistableBundle eventParams, 
                byte[] responseData, 
                String mimeType)

Creates an event tracking URL that returns the provided response. Returns HTTP Status 200 (OK) if the response data is not empty. Returns HTTP Status 204 (No Content) if the response data is empty.
This method may take several seconds to complete, so it should only be called from a worker thread.

Parameters
`eventParams`	`PersistableBundle`: The data to be passed to `IsolatedWorker#onEvent(EventInput, android.os.OutcomeReceiver)` when the event occurs. This value cannot be `null`.
`responseData`	`byte`: The content to be returned to the WebView when the URL is fetched. This value may be `null`.
`mimeType`	`String`: The Mime Type of the URL response. This value may be `null`.

Returns
`Uri`	An ODP event URL that can be inserted into a WebView. This value cannot be `null`.