WebSourceRegistrationRequest.Builder


public static final class WebSourceRegistrationRequest.Builder
extends Object

java.lang.Object
   ↳ android.adservices.measurement.WebSourceRegistrationRequest.Builder


Builder for WebSourceRegistrationRequest.

Summary

Public constructors

Builder(List<WebSourceParams> webSourceParams, Uri topOriginUri)

Builder constructor for WebSourceRegistrationRequest.

Public methods

WebSourceRegistrationRequest build()

Pre-validates parameters and builds WebSourceRegistrationRequest.

WebSourceRegistrationRequest.Builder setAppDestination(Uri appDestination)

Setter for app destination.

WebSourceRegistrationRequest.Builder setInputEvent(InputEvent inputEvent)

Setter for input event.

WebSourceRegistrationRequest.Builder setVerifiedDestination(Uri verifiedDestination)

Setter for verified destination.

WebSourceRegistrationRequest.Builder setWebDestination(Uri webDestination)

Setter for web destination.

Inherited methods

Public constructors

Builder

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

Builder constructor for WebSourceRegistrationRequest.

Parameters
webSourceParams List: source parameters containing source registration parameters, the list should not be empty This value cannot be null.

topOriginUri Uri: source publisher Uri This value cannot be null.

Public methods

build

public WebSourceRegistrationRequest build ()

Pre-validates parameters and builds WebSourceRegistrationRequest.

Returns
WebSourceRegistrationRequest This value cannot be null.

setAppDestination

public WebSourceRegistrationRequest.Builder setAppDestination (Uri appDestination)

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

Parameters
appDestination Uri: app destination Uri This value may be null.

Returns
WebSourceRegistrationRequest.Builder builder This value cannot be null.

setInputEvent

public WebSourceRegistrationRequest.Builder setInputEvent (InputEvent inputEvent)

Setter for input event.

Parameters
inputEvent InputEvent: User Interaction InputEvent used by the AttributionReporting API to distinguish clicks from views. This value may be null.

Returns
WebSourceRegistrationRequest.Builder builder This value cannot be null.

setVerifiedDestination

public WebSourceRegistrationRequest.Builder setVerifiedDestination (Uri verifiedDestination)

Setter for verified destination.

Parameters
verifiedDestination Uri: verified destination This value may be null.

Returns
WebSourceRegistrationRequest.Builder builder This value cannot be null.

setWebDestination

public WebSourceRegistrationRequest.Builder setWebDestination (Uri webDestination)

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

Parameters
webDestination Uri: web destination Uri This value may be null.

Returns
WebSourceRegistrationRequest.Builder builder This value cannot be null.