Package com.my.tracker.ads

Class AdEventBuilder

java.lang.Object

com.my.tracker.ads.AdEventBuilder

public final class AdEventBuilder
extends java.lang.Object

Builder-class for AdEvent

Method Summary

Modifier and Type	Method	Description
AdEvent	build()	Create new advertising event instance with previously specified values.
static AdEventBuilder	newClickBuilder(int network)	Create new ad click event builder
static AdEventBuilder	newImpressionBuilder(int network)	Create new ad impression event builder
static AdEventBuilder	newRevenueBuilder(int network, double revenue, java.lang.String currency)	Create new revenue event builder
AdEventBuilder	withAdFormat(java.lang.String adFormat)	Set advertising format
AdEventBuilder	withAdId(java.lang.String adId)	Set advertising identifier
AdEventBuilder	withPlacementId(java.lang.String placementId)	Set placement identifier
AdEventBuilder	withSource(java.lang.String source)	Set initial source

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newClickBuilder

@AnyThread
@NonNull
public static AdEventBuilder newClickBuilder(int network)

Create new ad click event builder

Parameters:

network - Advertising network AdNetwork

Returns:

Builder object for creating ad click event

newImpressionBuilder

@AnyThread
@NonNull
public static AdEventBuilder newImpressionBuilder(int network)

Create new ad impression event builder

Parameters:

network - Advertising network AdNetwork

Returns:

Builder object for creating ad impression event

newRevenueBuilder

@AnyThread
@NonNull
public static AdEventBuilder newRevenueBuilder(int network,
                                               double revenue,
                                               @NonNull
                                               java.lang.String currency)

Create new revenue event builder

Parameters:

network - Advertising network AdNetwork

revenue - Revenue value

currency - Currency code in ISO 4217 format

Returns:

Builder object for creating revenue event

withSource

@AnyThread
@NonNull
public AdEventBuilder withSource(@Nullable
                                 java.lang.String source)

Set initial source

Parameters:

source - Source value

Returns:

Current AdEventBuilder

withPlacementId

@AnyThread
@NonNull
public AdEventBuilder withPlacementId(@Nullable
                                      java.lang.String placementId)

Set placement identifier

Parameters:

placementId - Placement identifier value

Returns:

Current AdEventBuilder

withAdId

@AnyThread
@NonNull
public AdEventBuilder withAdId(@Nullable
                               java.lang.String adId)

Set advertising identifier

Parameters:

adId - Advertising identifier value

Returns:

Current AdEventBuilder

withAdFormat

@AnyThread
@NonNull
public AdEventBuilder withAdFormat(@Nullable
                                   java.lang.String adFormat)

Set advertising format

Parameters:

adFormat - Advertising format. The value could be defined customly or chosen from AdFormat.

Returns:

Current AdEventBuilder

build

@AnyThread
@NonNull
public AdEvent build()

Create new advertising event instance with previously specified values.

Returns:

New instance of AdEvent