com.facebook.ads.sdk.serverside

Class AttributionData

java.lang.Object

com.facebook.ads.sdk.serverside.AttributionData

public class AttributionData
extends Object

Constructor Summary

Constructors

Constructor and Description
AttributionData() Default constructor
AttributionData(String scope, Long visitTime, String adId, String adsetId, String campaignId, Float attributionShare, AttributionModelEnum attributionModel, Integer attributionWindow) Constructor

Method Summary

Modifier and Type	Method and Description
AttributionData	adId(String adId) Set adId
AttributionData	adsetId(String adsetId) Set adsetId
AttributionData	attributionModel(AttributionModelEnum attributionModel) Set attributionModel
AttributionData	attributionShare(Float attributionShare) Set attributionShare
AttributionData	attributionWindow(Integer attributionWindow) Set attributionWindow
AttributionData	campaignId(String campaignId) Set campaignId
boolean	equals(Object o)
String	getAdId() Get adId
String	getAdsetId() Get adsetId
AttributionModelEnum	getAttributionModel() Get attributionModel
Float	getAttributionShare() Get attributionShare
Integer	getAttributionWindow() Get attributionWindow
String	getCampaignId() Get campaignId
String	getScope() Get scope
Long	getVisitTime() Get visitTime
int	hashCode()
AttributionData	scope(String scope) Set scope
void	setAdId(String adId) Set adId
void	setAdsetId(String adsetId) Set adsetId
void	setAttributionModel(AttributionModelEnum attributionModel) Set attributionModel
void	setAttributionShare(Float attributionShare) Set attributionShare
void	setAttributionWindow(Integer attributionWindow) Set attributionWindow
void	setCampaignId(String campaignId) Set campaignId
void	setScope(String scope) Set scope
void	setVisitTime(Long visitTime) Set visitTime
String	toString()
AttributionData	visitTime(Long visitTime) Set visitTime

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AttributionData

public AttributionData()

Default constructor

AttributionData

public AttributionData(String scope,
                       Long visitTime,
                       String adId,
                       String adsetId,
                       String campaignId,
                       Float attributionShare,
                       AttributionModelEnum attributionModel,
                       Integer attributionWindow)

Constructor

Parameters:

scope - Touchpoint type

visitTime - Time that the campaign_id or fbc was first received

adId - Meta-provided ad id from URL/deeplink

adsetId - Meta-provided adset id from URL/deeplink

campaignId - Meta-provided campaign id from URL/deeplink

attributionShare - [0-1] weight of credit assigned to the visit

attributionModel - Attribution model used to attribute the event

Method Detail

scope

public AttributionData scope(String scope)

Set scope

Parameters:

scope - Touchpoint type

Returns:

AttributionData

getScope

public String getScope()

Get scope

Returns:

scope

setScope

public void setScope(String scope)

Set scope

Parameters:

scope - Touchpoint type

visitTime

public AttributionData visitTime(Long visitTime)

Set visitTime

Parameters:

visitTime - Time that the campaign_id or fbc was first received

Returns:

AttributionData

getVisitTime

public Long getVisitTime()

Get visitTime

Returns:

visitTime

setVisitTime

public void setVisitTime(Long visitTime)

Set visitTime

Parameters:

visitTime - Time that the campaign_id or fbc was first received

adId

public AttributionData adId(String adId)

Set adId

Parameters:

adId - Meta-provided ad id from URL/deeplink

Returns:

AttributionData

getAdId

public String getAdId()

Get adId

Returns:

adId

setAdId

public void setAdId(String adId)

Set adId

Parameters:

adId - Meta-provided ad id from URL/deeplink

adsetId

public AttributionData adsetId(String adsetId)

Set adsetId

Parameters:

adsetId - Meta-provided adset id from URL/deeplink

Returns:

AttributionData

getAdsetId

public String getAdsetId()

Get adsetId

Returns:

adsetId

setAdsetId

public void setAdsetId(String adsetId)

Set adsetId

Parameters:

adsetId - Meta-provided adset id from URL/deeplink

campaignId

public AttributionData campaignId(String campaignId)

Set campaignId

Parameters:

campaignId - Meta-provided campaign id from URL/deeplink

Returns:

AttributionData

getCampaignId

public String getCampaignId()

Get campaignId

Returns:

campaignId

setCampaignId

public void setCampaignId(String campaignId)

Set campaignId

Parameters:

campaignId - Meta-provided campaign id from URL/deeplink

attributionShare

public AttributionData attributionShare(Float attributionShare)

Set attributionShare

Parameters:

attributionShare - [0-1] weight of credit assigned to the visit

Returns:

AttributionData

getAttributionShare

public Float getAttributionShare()

Get attributionShare

Returns:

attributionShare

setAttributionShare

public void setAttributionShare(Float attributionShare)

Set attributionShare

Parameters:

attributionShare - [0-1] weight of credit assigned to the visit

attributionModel

public AttributionData attributionModel(AttributionModelEnum attributionModel)

Set attributionModel

Parameters:

attributionModel - Attribution model used to attribute the event.

Returns:

AttributionData

getAttributionModel

public AttributionModelEnum getAttributionModel()

Get attributionModel

Returns:

attributionModel

setAttributionModel

public void setAttributionModel(AttributionModelEnum attributionModel)

Set attributionModel

Parameters:

attributionModel - Attribution model used to attribute the event.

attributionWindow

public AttributionData attributionWindow(Integer attributionWindow)

Set attributionWindow

Parameters:

attributionWindow - Attribution window in days.

Returns:

AttributionData

getAttributionWindow

public Integer getAttributionWindow()

Get attributionWindow

Returns:

attributionWindow

setAttributionWindow

public void setAttributionWindow(Integer attributionWindow)

Set attributionWindow

Parameters:

attributionWindow - Attribution window in days.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object