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, Float attributionValue, String attributionSource, String touchpointType, Integer touchpointTs, AttributionMethodEnum attributionMethod, DeclineReasonEnum declineReason, String auditingToken, String linkageKey, AttributionSetting attributionSetting) Constructor

Method Summary

Modifier and Type	Method and Description
AttributionData	adId(String adId) Set adId
AttributionData	adsetId(String adsetId) Set adsetId
AttributionData	attributionMethod(AttributionMethodEnum attributionMethod) Set attributionMethod
AttributionData	attributionModel(AttributionModelEnum attributionModel) Set attributionModel
AttributionData	attributionSetting(AttributionSetting attributionSetting) Set attributionSetting
AttributionData	attributionShare(Float attributionShare) Set attributionShare
AttributionData	attributionSource(String attributionSource) Set attributionSource
AttributionData	attributionValue(Float attributionValue) Set attributionValue
AttributionData	attributionWindow(Integer attributionWindow) Set attributionWindow
AttributionData	auditingToken(String auditingToken) Set auditingToken
AttributionData	campaignId(String campaignId) Set campaignId
AttributionData	declineReason(DeclineReasonEnum declineReason) Set declineReason
boolean	equals(Object o)
String	getAdId() Get adId
String	getAdsetId() Get adsetId
AttributionMethodEnum	getAttributionMethod() Get attributionMethod
AttributionModelEnum	getAttributionModel() Get attributionModel
AttributionSetting	getAttributionSetting() Get attributionSetting
Float	getAttributionShare() Get attributionShare
String	getAttributionSource() Get attributionSource
Float	getAttributionValue() Get attributionValue
Integer	getAttributionWindow() Get attributionWindow
String	getAuditingToken() Get auditingToken
String	getCampaignId() Get campaignId
DeclineReasonEnum	getDeclineReason() Get declineReason
String	getLinkageKey() Get linkageKey
String	getScope() Get scope
Integer	getTouchpointTs() Get touchpointTs
String	getTouchpointType() Get touchpointType
Long	getVisitTime() Get visitTime
int	hashCode()
AttributionData	linkageKey(String linkageKey) Set linkageKey
AttributionData	scope(String scope) Set scope
void	setAdId(String adId) Set adId
void	setAdsetId(String adsetId) Set adsetId
void	setAttributionMethod(AttributionMethodEnum attributionMethod) Set attributionMethod
void	setAttributionModel(AttributionModelEnum attributionModel) Set attributionModel
void	setAttributionSetting(AttributionSetting attributionSetting) Set attributionSetting
void	setAttributionShare(Float attributionShare) Set attributionShare
void	setAttributionSource(String attributionSource) Set attributionSource
void	setAttributionValue(Float attributionValue) Set attributionValue
void	setAttributionWindow(Integer attributionWindow) Set attributionWindow
void	setAuditingToken(String auditingToken) Set auditingToken
void	setCampaignId(String campaignId) Set campaignId
void	setDeclineReason(DeclineReasonEnum declineReason) Set declineReason
void	setLinkageKey(String linkageKey) Set linkageKey
void	setScope(String scope) Set scope
void	setTouchpointTs(Integer touchpointTs) Set touchpointTs
void	setTouchpointType(String touchpointType) Set touchpointType
void	setVisitTime(Long visitTime) Set visitTime
String	toString()
AttributionData	touchpointTs(Integer touchpointTs) Set touchpointTs
AttributionData	touchpointType(String touchpointType) Set touchpointType
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,
                       Float attributionValue,
                       String attributionSource,
                       String touchpointType,
                       Integer touchpointTs,
                       AttributionMethodEnum attributionMethod,
                       DeclineReasonEnum declineReason,
                       String auditingToken,
                       String linkageKey,
                       AttributionSetting attributionSetting)

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

attributionWindow - Attribution window in days

attributionValue - The share of value generated by this click-conversion pair that is attributed to Meta.

attributionSource - The attribution source to differentiate the source of the data, e.g. whether this is from AMM or Custom Attribution or any other sources.

touchpointType - The engagement type that caused the original credited conversion.

touchpointTs - The time when the touchpoint event occurred with the ad that the install was credited to.

attributionMethod - The attribution method used to attribute the event.

declineReason - The decline reason for the attribution.

auditingToken - The auditing token for the attribution.

linkageKey - The linkage key for the attribution.

attributionSetting - The attribution setting with inactivity and reattribution window configuration.

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.

attributionValue

public AttributionData attributionValue(Float attributionValue)

Set attributionValue

Parameters:

attributionValue - The share of value generated by this click-conversion pair that is attributed to Meta.

Returns:

AttributionData

getAttributionValue

public Float getAttributionValue()

Get attributionValue

Returns:

attributionValue

setAttributionValue

public void setAttributionValue(Float attributionValue)

Set attributionValue

Parameters:

attributionValue - The share of value generated by this click-conversion pair that is attributed to Meta.

attributionSource

public AttributionData attributionSource(String attributionSource)

Set attributionSource

Parameters:

attributionSource - The attribution source to differentiate the source of the data, e.g. whether this is from AMM or Custom Attribution or any other sources.

Returns:

AttributionData

getAttributionSource

public String getAttributionSource()

Get attributionSource

Returns:

attributionSource

setAttributionSource

public void setAttributionSource(String attributionSource)

Set attributionSource

Parameters:

attributionSource - The attribution source to differentiate the source of the data, e.g. whether this is from AMM or Custom Attribution or any other sources.

touchpointType

public AttributionData touchpointType(String touchpointType)

Set touchpointType

Parameters:

touchpointType - The engagement type that caused the original credited conversion.

Returns:

AttributionData

getTouchpointType

public String getTouchpointType()

Get touchpointType

Returns:

touchpointType

setTouchpointType

public void setTouchpointType(String touchpointType)

Set touchpointType

Parameters:

touchpointType - The engagement type that caused the original credited conversion.

touchpointTs

public AttributionData touchpointTs(Integer touchpointTs)

Set touchpointTs

Parameters:

touchpointTs - The time when the touchpoint event occurred with the ad that the install was credited to.

Returns:

AttributionData

getTouchpointTs

public Integer getTouchpointTs()

Get touchpointTs

Returns:

touchpointTs

setTouchpointTs

public void setTouchpointTs(Integer touchpointTs)

Set touchpointTs

Parameters:

touchpointTs - The time when the touchpoint event occurred with the ad that the install was credited to.

attributionMethod

public AttributionData attributionMethod(AttributionMethodEnum attributionMethod)

Set attributionMethod

Parameters:

attributionMethod - The attribution method used to attribute the event.

Returns:

AttributionData

getAttributionMethod

public AttributionMethodEnum getAttributionMethod()

Get attributionMethod

Returns:

attributionMethod

setAttributionMethod

public void setAttributionMethod(AttributionMethodEnum attributionMethod)

Set attributionMethod

Parameters:

attributionMethod - The attribution method used to attribute the event.

declineReason

public AttributionData declineReason(DeclineReasonEnum declineReason)

Set declineReason

Parameters:

declineReason - The decline reason for the attribution.

Returns:

AttributionData

getDeclineReason

public DeclineReasonEnum getDeclineReason()

Get declineReason

Returns:

declineReason

setDeclineReason

public void setDeclineReason(DeclineReasonEnum declineReason)

Set declineReason

Parameters:

declineReason - The decline reason for the attribution.

auditingToken

public AttributionData auditingToken(String auditingToken)

Set auditingToken

Parameters:

auditingToken - The auditing token for the attribution.

Returns:

AttributionData

getAuditingToken

public String getAuditingToken()

Get auditingToken

Returns:

auditingToken

setAuditingToken

public void setAuditingToken(String auditingToken)

Set auditingToken

Parameters:

auditingToken - The auditing token for the attribution.

linkageKey

public AttributionData linkageKey(String linkageKey)

Set linkageKey

Parameters:

linkageKey - The linkage key for the attribution.

Returns:

AttributionData

getLinkageKey

public String getLinkageKey()

Get linkageKey

Returns:

linkageKey

setLinkageKey

public void setLinkageKey(String linkageKey)

Set linkageKey

Parameters:

linkageKey - The linkage key for the attribution.

attributionSetting

public AttributionData attributionSetting(AttributionSetting attributionSetting)

Set attributionSetting

Parameters:

attributionSetting - The attribution setting with inactivity and reattribution window configuration.

Returns:

AttributionData

getAttributionSetting

public AttributionSetting getAttributionSetting()

Get attributionSetting

Returns:

attributionSetting

setAttributionSetting

public void setAttributionSetting(AttributionSetting attributionSetting)

Set attributionSetting

Parameters:

attributionSetting - The attribution setting with inactivity and reattribution window configuration.

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