public class UserData extends Object
Constructor and Description |
---|
UserData() |
UserData(String email,
String phone,
GenderEnum gender,
String dateOfBirth,
String lastName,
String firstName,
String city,
String state,
String zipcode,
String countryCode,
String externalId,
String clientIpAddress,
String clientUserAgent,
String fbc,
String fbp,
String subscriptionId,
String fbLoginId,
String leadId,
String f5first,
String f5last,
String fi,
String dobd,
String dobm,
String doby,
String address) |
Modifier and Type | Method and Description |
---|---|
UserData |
address(String address)
Set physical address for the event.
|
UserData |
city(String city)
Set a city in lower-case without spaces or punctuation.
|
UserData |
clientIpAddress(String clientIpAddress)
Set IP address of the browser corresponding to the event.
|
UserData |
clientUserAgent(String clientUserAgent)
Set user agent for the browser corresponding to the event.
|
UserData |
countryCode(String countryCode)
Set a two-letter country code in lowercase.
|
UserData |
dateOfBirth(String dateOfBirth)
Set a date of birth given as year, month, and day.
|
UserData |
dobd(String dobd)
Set dobd for the event.
|
UserData |
dobm(String dobm)
Set dobm for the event.
|
UserData |
doby(String doby)
Set doby for the event.
|
UserData |
email(String email)
Set an email address, in lowercase.
|
UserData |
externalId(String externalId)
Set any unique ID from the advertiser, such as loyalty membership IDs, user
IDs, and external cookie IDs.
|
UserData |
f5first(String f5first)
Set f5first for the event.
|
UserData |
f5last(String f5last)
Set f5last for the event.
|
UserData |
fbc(String fbc)
Set Facebook click ID value stored in the _fbc browser cookie under your
domain.
|
UserData |
fbLoginId(String fbLoginId)
Set Facebook Login ID for the user in this event.
|
UserData |
fbp(String fbp)
Set Facebook browser ID value stored in the _fbp browser cookie under your
domain.
|
UserData |
fi(String fi)
Set fi for the event.
|
UserData |
firstName(String firstName)
Set a first name in lowercase.
|
UserData |
gender(GenderEnum gender)
Gender.
|
SignalResponse<String,String> |
getAddress()
The physical address for the event.
|
UserData |
getBusinessDataUserData()
Gets user data for business data api
|
SignalResponse<String,String> |
getCity()
A city in lower-case without spaces or punctuation.
|
SignalResponse<String,String> |
getClientIpAddress()
The IP address of the browser corresponding to the event.
|
SignalResponse<String,String> |
getClientUserAgent()
The user agent for the browser corresponding to the event.
|
SignalResponse<String,String> |
getCountryCode()
A two-letter country code in lowercase.
|
SignalResponse<String,String> |
getDateOfBirth()
Return a date of birth given as year, month, and day.
|
SignalResponse<String,String> |
getDobd()
The dobd for the event.
|
SignalResponse<String,String> |
getDobm()
The dobm for the event.
|
SignalResponse<String,String> |
getDoby()
The doby for the event.
|
SignalResponse<String,String> |
getEmail()
An email address, in lowercase.
|
SignalResponse<String,String> |
getExternalId()
Any unique ID from the advertiser, such as loyalty membership IDs, user IDs,
and external cookie IDs.
|
SignalResponse<String,String> |
getF5first()
The f5first for the event.
|
SignalResponse<String,String> |
getF5last()
The f5last for the event.
|
SignalResponse<String,String> |
getFbc()
The Facebook click ID value stored in the _fbc browser cookie under your
domain.
|
SignalResponse<String,String> |
getFbLoginId()
The Facebook Login ID for the user in this event.
|
SignalResponse<String,String> |
getFbp()
The Facebook browser ID value stored in the _fbp browser cookie under your
domain.
|
SignalResponse<String,String> |
getFi()
The fi for the event.
|
SignalResponse<String,String> |
getFirstName()
A first name in lowercase.
|
SignalResponse<GenderEnum,GenderEnum> |
getGender()
Gender, Male or Female.
|
SignalResponse<String,String> |
getLastName()
A last name in lowercase.
|
SignalResponse<String,String> |
getLeadId()
The LeadId for the event.
|
SignalResponse<String,String> |
getPhone()
A phone number.
|
UserData |
getServerSideUserData()
Gets user data for conversion api
|
SignalResponse<String,String> |
getState()
A two-letter state code in lowercase.
|
SignalResponse<String,String> |
getSubscriptionId()
The subscription ID for the user in this transaction.
|
SignalResponse<String,String> |
getZipcode()
A five-digit zip code.
|
UserData |
lastName(String lastName)
Set a last name in lowercase.
|
UserData |
leadId(String leadId)
Set LeadId for the event.
|
UserData |
phone(String phone)
Set a phone number.
|
void |
setAddress(String address)
* The physical address for the event.
|
void |
setCity(String city)
Set a city in lower-case without spaces or punctuation.
|
void |
setClientIpAddress(String clientIpAddress)
Set IP address of the browser corresponding to the event.
|
void |
setClientUserAgent(String clientUserAgent)
Set user agent for the browser corresponding to the event.
|
void |
setCountryCode(String countryCode)
Set a two-letter country code in lowercase.
|
void |
setDateOfBirth(String dateOfBirth)
A date of birth given as year, month, and day.
|
void |
setDobd(String dobd)
Set dobd for the event.
|
void |
setDobm(String dobm)
Set dobm for the event.
|
void |
setDoby(String doby)
Set doby for the event.
|
void |
setEmail(String email)
Set an email address, in lowercase.
|
void |
setExternalId(String externalId)
Set any unique ID from the advertiser, such as loyalty membership IDs, user
IDs, and external cookie IDs.
|
void |
setF5first(String f5first)
Set f5first for the event.
|
void |
setF5last(String f5last)
Set f5last for the event.
|
void |
setFbc(String fbc)
Set Facebook click ID value stored in the _fbc browser cookie under your
domain.
|
void |
setFbLoginId(String fbLoginId)
Set Facebook Login ID for the user in this event
|
void |
setFbp(String fbp)
Set Facebook browser ID value stored in the _fbp browser cookie under your
domain.
|
void |
setFi(String fi)
Set fi for the event.
|
void |
setFirstName(String firstName)
Set a first name in lowercase.
|
void |
setGender(GenderEnum gender)
Gender, Male or Female.
|
void |
setLastName(String lastName)
Set a last name in lowercase.
|
void |
setLeadId(String leadId)
Set LeadId for the event.
|
void |
setPhone(String phone)
Set a phone number.
|
void |
setState(String state)
Set a two-letter state code in lowercase.
|
void |
setSubscriptionId(String subscriptionId)
Set subscription ID for the user in this transaction.
|
void |
setZipcode(String zipcode)
Set a five-digit zip code.
|
UserData |
state(String state)
Set a two-letter state code in lowercase.
|
UserData |
subscriptionId(String subscriptionId)
Set subscription ID for the user in this transaction.
|
UserData |
zipcode(String zipcode)
Set a five-digit zip code.
|
public UserData()
public UserData(String email, String phone, GenderEnum gender, String dateOfBirth, String lastName, String firstName, String city, String state, String zipcode, String countryCode, String externalId, String clientIpAddress, String clientUserAgent, String fbc, String fbp, String subscriptionId, String fbLoginId, String leadId, String f5first, String f5last, String fi, String dobd, String dobm, String doby, String address)
email
- An email address, in lowercase.phone
- A phone number. Include only digits with country code,
area code, and number.firstName
- A first name in lowercase.lastName
- A last name in lowercase.dateOfBirth
- A date of birth given as year, month, and day in
YYYYMMDD format.city
- A city in lower-case without spaces or punctuation.state
- A two-letter state code in lowercase.countryCode
- A two-letter country code in lowercase.zipcode
- Postal code of the city in your country standardexternalId
- Any unique ID from the advertiser,gender
- Gender, in lowercase. Either f or m.clientIpAddress
- The IP address of the browser corresponding to the
event.clientUserAgent
- The user agent for the browser corresponding to the
event.fbp
- The Facebook click ID value stored in the _fbc browser
cookie under your domain.fbc
- The Facebook browser ID value stored in the _fbp
browser cookie under your domain.subscriptionId
- The subscription ID for the user in this transaction.fbLoginId
- The FB login ID for the user.leadId
- The Id associated with a lead generated by Facebook's
Lead Ads.dobd
- The date of birth day in DD format.dobm
- The date of birth month in MM format.doby
- The date of birth year in YYYY format.f5first
- The first 5 characters of the first name.f5last
- The first 5 characters of the last name.fi
- The first Name Initialaddress
- An physical address.public UserData email(String email)
email
- an email addresspublic SignalResponse<String,String> getEmail()
public void setEmail(String email)
Example: [email protected]
email
- an email addresspublic UserData phone(String phone)
Example: 16505551212
phone
- a phone numberpublic SignalResponse<String,String> getPhone()
public void setPhone(String phone)
Example: 16505551212
phone
- a phone numberpublic UserData gender(GenderEnum gender)
gender
- Male or Female.public SignalResponse<GenderEnum,GenderEnum> getGender()
public void setGender(GenderEnum gender)
gender
- Male or Female.public UserData dateOfBirth(String dateOfBirth)
Example: 19971226 for December 26, 1997.
dateOfBirth
- a date of birth given as year, month, and day.public SignalResponse<String,String> getDateOfBirth()
public void setDateOfBirth(String dateOfBirth)
Example: 19971226 for December 26, 1997.
dateOfBirth
- a date of birth given as year, month, and day.public UserData lastName(String lastName)
Example: smith
lastName
- last namepublic SignalResponse<String,String> getLastName()
public void setLastName(String lastName)
Example: smith
lastName
- last namepublic UserData firstName(String firstName)
Example: joe
firstName
- first namepublic SignalResponse<String,String> getFirstName()
public void setFirstName(String firstName)
firstName
- first namepublic UserData city(String city)
city
- citypublic SignalResponse<String,String> getCity()
public void setCity(String city)
Example: menlopark
city
- citypublic UserData state(String state)
Example: ca
state
- two-letter state codepublic SignalResponse<String,String> getState()
public void setState(String state)
Example: ca
state
- two-letter state codepublic UserData zipcode(String zipcode)
Example: 94035
zipcode
- five-digit zip codepublic SignalResponse<String,String> getZipcode()
public void setZipcode(String zipcode)
Example: 94035
zipcode
- five-digit zip codepublic UserData countryCode(String countryCode)
Example: us
countryCode
- two-letter country codepublic SignalResponse<String,String> getCountryCode()
Example: us
public void setCountryCode(String countryCode)
Example: us
countryCode
- two-letter country codepublic UserData externalId(String externalId)
externalId
- unique ID from the advertiserpublic SignalResponse<String,String> getExternalId()
public void setExternalId(String externalId)
externalId
- unique ID from the advertiserpublic UserData clientIpAddress(String clientIpAddress)
clientIpAddress
- IP address of the browser corresponding to the eventpublic SignalResponse<String,String> getClientIpAddress()
public void setClientIpAddress(String clientIpAddress)
clientIpAddress
- IP address of the browser corresponding to the eventpublic UserData clientUserAgent(String clientUserAgent)
clientUserAgent
- user agent for the browser corresponding to the eventpublic SignalResponse<String,String> getClientUserAgent()
public void setClientUserAgent(String clientUserAgent)
clientUserAgent
- user agent for the browser corresponding to the eventpublic UserData fbc(String fbc)
fbc
- Facebook click IDpublic SignalResponse<String,String> getFbc()
public void setFbc(String fbc)
fbc
- Facebook click IDpublic UserData fbp(String fbp)
fbp
- Facebook browser IDpublic SignalResponse<String,String> getFbp()
public void setFbp(String fbp)
fbp
- Facebook browser IDpublic UserData subscriptionId(String subscriptionId)
subscriptionId
- subscription ID for the user in this transactionpublic SignalResponse<String,String> getSubscriptionId()
public void setSubscriptionId(String subscriptionId)
subscriptionId
- subscription ID for the user in this transactionpublic UserData fbLoginId(String fbLoginId)
fbLoginId
- Facebook Login ID for the user in this eventpublic SignalResponse<String,String> getFbLoginId()
public void setFbLoginId(String fbLoginId)
fbLoginId
- Facebook Login ID for the user in this eventpublic UserData leadId(String leadId)
leadId
- is the ID associated with a lead generated by Facebook's Lead
Ads.public SignalResponse<String,String> getLeadId()
public void setLeadId(String leadId)
leadId
- is the ID associated with a lead generated by Facebook's Lead
Ads.public UserData f5first(String f5first)
f5first
- is the first 5 letters of the first name.public SignalResponse<String,String> getF5first()
public void setF5first(String f5first)
f5first
- is the first 5 letters of the first name.public UserData f5last(String f5last)
f5last
- is the first 5 letters of the last name.public SignalResponse<String,String> getF5last()
public void setF5last(String f5last)
f5last
- is the first 5 letters of the last name.public UserData fi(String fi)
fi
- is the first initial.public SignalResponse<String,String> getFi()
public void setFi(String fi)
fi
- is the first initial.public UserData dobd(String dobd)
dobd
- is the date of birth day for the event.public SignalResponse<String,String> getDobd()
public void setDobd(String dobd)
dobd
- is the date of birth day for the event.public UserData dobm(String dobm)
dobm
- is the date of birth month for the event.public SignalResponse<String,String> getDobm()
public void setDobm(String dobm)
dobm
- is the date of birth month for the event.public UserData doby(String doby)
doby
- is the date of birth year for the event.public SignalResponse<String,String> getDoby()
public void setDoby(String doby)
doby
- is the date of birth year for the event.public UserData address(String address)
address
- is the physical address for the eventpublic SignalResponse<String,String> getAddress()
public void setAddress(String address)
address
- is the physical address for the eventpublic UserData getBusinessDataUserData()
public UserData getServerSideUserData()
Copyright © 2023. All rights reserved.