WebSourceRegistrationRequest.Builder

Artifact: androidx.privacysandbox.ads:ads-adservices

View Source

Added in 1.0.0

---

Kotlin |Java

class WebSourceRegistrationRequest.Builder

---

Builder for WebSourceRegistrationRequest.

Summary

Public constructors
Builder(webSourceParams: List<WebSourceParams>, topOriginUri: Uri)

Public functions
WebSourceRegistrationRequest	build() Pre-validates parameters and builds WebSourceRegistrationRequest.
WebSourceRegistrationRequest.Builder	setAppDestination(appDestination: Uri?) Setter for app destination.
WebSourceRegistrationRequest.Builder	setInputEvent(inputEvent: InputEvent) Setter for input event.
WebSourceRegistrationRequest.Builder	setVerifiedDestination(verifiedDestination: Uri?) Setter for verified destination.
WebSourceRegistrationRequest.Builder	setWebDestination(webDestination: Uri?) Setter for web destination.

Public constructors

Builder

Added in 1.0.0

Builder(webSourceParams: List<WebSourceParams>, topOriginUri: Uri)

Parameters
webSourceParams: List<WebSourceParams>	source parameters containing source registration parameters, the list should not be empty
topOriginUri: Uri	source publisher Uri

Public functions

build

Added in 1.0.0

fun build(): WebSourceRegistrationRequest

Pre-validates parameters and builds WebSourceRegistrationRequest.

setAppDestination

Added in 1.0.0

fun setAppDestination(appDestination: Uri?): WebSourceRegistrationRequest.Builder

Setter for app destination. It is the android app {@link Uri} where corresponding conversion is expected. At least one of app destination or web destination is required.

Parameters
appDestination: Uri?	app destination Uri

Returns
WebSourceRegistrationRequest.Builder	builder

setInputEvent

Added in 1.0.0

fun setInputEvent(inputEvent: InputEvent): WebSourceRegistrationRequest.Builder

Setter for input event.

Parameters
inputEvent: InputEvent	User Interaction InputEvent used by the AttributionReporting API to distinguish clicks from views.

Returns
WebSourceRegistrationRequest.Builder	builder

setVerifiedDestination

Added in 1.0.0

fun setVerifiedDestination(verifiedDestination: Uri?): WebSourceRegistrationRequest.Builder

Setter for verified destination.

Parameters
verifiedDestination: Uri?	verified destination

Returns
WebSourceRegistrationRequest.Builder	builder

setWebDestination

Added in 1.0.0

fun setWebDestination(webDestination: Uri?): WebSourceRegistrationRequest.Builder

Setter for web destination. It is the website {@link Uri} where corresponding conversion is expected. At least one of app destination or web destination is required.

Parameters
webDestination: Uri?	web destination Uri

Returns
WebSourceRegistrationRequest.Builder	builder