UserData (com.facebook.business.sdk:facebook-java-business-sdk 9.0.0 API)

java.lang.Object
- com.facebook.ads.sdk.serverside.UserData

```
public class UserData
extends Object
```
UserData is a set of identifiers Facebook can use for targeted attribution.

Constructor Summary

Constructors
Constructor and Description
`UserData()` Default Constructor.
`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)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`boolean`	`equals(Object o)`
`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.
`String`	`getCity()` A city in lower-case without spaces or punctuation.
`String`	`getClientIpAddress()` The IP address of the browser corresponding to the event.
`String`	`getClientUserAgent()` The user agent for the browser corresponding to the event.
`String`	`getCountryCode()` A two-letter country code in lowercase.
`String`	`getDateOfBirth()` Return a date of birth given as year, month, and day.
`String`	`getDobd()` The dobd for the event.
`String`	`getDobm()` The dobm for the event.
`String`	`getDoby()` The doby for the event.
`String`	`getEmail()` An email address, in lowercase.
`String`	`getExternalId()` Any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs.
`String`	`getF5first()` The f5first for the event.
`String`	`getF5last()` The f5last for the event.
`String`	`getFbc()` The Facebook click ID value stored in the _fbc browser cookie under your domain.
`String`	`getFbLoginId()` The Facebook Login ID for the user in this event.
`String`	`getFbp()` The Facebook browser ID value stored in the _fbp browser cookie under your domain.
`String`	`getFi()` The fi for the event.
`String`	`getFirstName()` A first name in lowercase.
`GenderEnum`	`getGender()` Gender, Male or Female.
`String`	`getLastName()` A last name in lowercase.
`String`	`getLeadId()` The LeadId for the event.
`String`	`getPhone()` A phone number.
`String`	`getState()` A two-letter state code in lowercase.
`String`	`getSubscriptionId()` The subscription ID for the user in this transaction.
`String`	`getZipcode()` A five-digit zip code.
`int`	`hashCode()`
`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`	`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.
`String`	`toString()`
`UserData`	`zipcode(String zipcode)` Set a five-digit zip code.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UserData
```
public UserData()
```
    Default Constructor.
  - 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)
```
    Parameters:
    
    email - an email address
    
    phone - a phone number
    
    gender - gender
    
    dateOfBirth - date of birth
    
    lastName - last name
    
    firstName - first name
    
    city - city
    
    state - state
    
    zipcode - zip code
    
    countryCode - country code
    
    externalId - any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs.
    
    clientIpAddress - IP address of the browser corresponding to the event
    
    clientUserAgent - user agent for the browser corresponding to the event
    
    fbc - Facebook click ID value stored in the _fbc browser cookie under your domain
    
    fbp - Facebook browser ID value stored in the _fbp browser cookie under your domain
    
    subscriptionId - subscription ID for the user in this transaction
    
    fbLoginId - ID issued when a person first logs into an instance of the app, also known as App-Scoped Id
    
    leadId - ID associated with a lead generated by Facebook's Lead Ads.
    
    f5first - First 5 letters of the first name
    
    f5last - First 5 letters of the last name
    
    fi - First initial
    
    dobd - Date of birth day
    
    dobm - Date of birth month
    
    doby - Date of birth year
- Method Detail
  - email
```
public UserData email(String email)
```
    Set an email address, in lowercase.
    Example: joe@eg.com
    
    Parameters:
    
    email - an email address
    
    Returns:
    
    UserData
  - getEmail
```
public String getEmail()
```
    An email address, in lowercase.
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
    Set an email address, in lowercase.
    Example: joe@eg.com
    
    Parameters:
    
    email - an email address
  - phone
```
public UserData phone(String phone)
```
    Set a phone number. Include only digits with countryCode code, area code, and number.
    Example: 16505551212
    
    Parameters:
    
    phone - a phone number
    
    Returns:
    
    UserData
  - getPhone
```
public String getPhone()
```
    A phone number. Include only digits with countryCode code, area code, and number.
    
    Returns:
    
    phone
  - setPhone
```
public void setPhone(String phone)
```
    Set a phone number. Include only digits with countryCode code, area code, and number.
    Example: 16505551212
    
    Parameters:
    
    phone - a phone number
  - gender
```
public UserData gender(GenderEnum gender)
```
    Gender. Male or Female.
    
    Parameters:
    
    gender - Male or Female.
    
    Returns:
    
    UserData
  - getGender
```
public GenderEnum getGender()
```
    Gender, Male or Female.
    
    Returns:
    
    gender
  - setGender
```
public void setGender(GenderEnum gender)
```
    Gender, Male or Female.
    
    Parameters:
    
    gender - Male or Female.
  - dateOfBirth
```
public UserData dateOfBirth(String dateOfBirth)
```
    Set a date of birth given as year, month, and day.
    Example: 19971226 for December 26, 1997.
    
    Parameters:
    
    dateOfBirth - a date of birth given as year, month, and day.
    
    Returns:
    
    UserData
  - getDateOfBirth
```
public String getDateOfBirth()
```
    Return a date of birth given as year, month, and day.
    
    Returns:
    
    dateOfBirth
  - setDateOfBirth
```
public void setDateOfBirth(String dateOfBirth)
```
    A date of birth given as year, month, and day.
    Example: 19971226 for December 26, 1997.
    
    Parameters:
    
    dateOfBirth - a date of birth given as year, month, and day.
  - lastName
```
public UserData lastName(String lastName)
```
    Set a last name in lowercase.
    Example: smith
    
    Parameters:
    
    lastName - last name
    
    Returns:
    
    UserData
  - getLastName
```
public String getLastName()
```
    A last name in lowercase.
    
    Returns:
    
    lastName
  - setLastName
```
public void setLastName(String lastName)
```
    Set a last name in lowercase.
    Example: smith
    
    Parameters:
    
    lastName - last name
  - firstName
```
public UserData firstName(String firstName)
```
    Set a first name in lowercase.
    Example: joe
    
    Parameters:
    
    firstName - first name
    
    Returns:
    
    firstName
  - getFirstName
```
public String getFirstName()
```
    A first name in lowercase.
    
    Returns:
    
    firstName
  - setFirstName
```
public void setFirstName(String firstName)
```
    Set a first name in lowercase.
    Example: joe
    
    Parameters:
    
    firstName - first name
  - city
```
public UserData city(String city)
```
    Set a city in lower-case without spaces or punctuation.
    Example: menlopark
    
    Parameters:
    
    city - city
    
    Returns:
    
    UserData
  - getCity
```
public String getCity()
```
    A city in lower-case without spaces or punctuation.
    
    Returns:
    
    city
  - setCity
```
public void setCity(String city)
```
    Set a city in lower-case without spaces or punctuation.
    Example: menlopark
    
    Parameters:
    
    city - city
  - state
```
public UserData state(String state)
```
    Set a two-letter state code in lowercase.
    Example: ca
    
    Parameters:
    
    state - two-letter state code
    
    Returns:
    
    UserData
  - getState
```
public String getState()
```
    A two-letter state code in lowercase.
    
    Returns:
    
    state
  - setState
```
public void setState(String state)
```
    Set a two-letter state code in lowercase.
    Example: ca
    
    Parameters:
    
    state - two-letter state code
  - zipcode
```
public UserData zipcode(String zipcode)
```
    Set a five-digit zip code.
    Example: 94035
    
    Parameters:
    
    zipcode - five-digit zip code
    
    Returns:
    
    UserData
  - getZipcode
```
public String getZipcode()
```
    A five-digit zip code.
    
    Returns:
    
    zipcode
  - setZipcode
```
public void setZipcode(String zipcode)
```
    Set a five-digit zip code.
    Example: 94035
    
    Parameters:
    
    zipcode - five-digit zip code
  - countryCode
```
public UserData countryCode(String countryCode)
```
    Set a two-letter country code in lowercase.
    Example: us
    
    Parameters:
    
    countryCode - two-letter country code
    
    Returns:
    
    UserData
  - getCountryCode
```
public String getCountryCode()
```
    A two-letter country code in lowercase.
    Example: us
    
    Returns:
    
    countryCode
  - setCountryCode
```
public void setCountryCode(String countryCode)
```
    Set a two-letter country code in lowercase.
    Example: us
    
    Parameters:
    
    countryCode - two-letter country code
  - externalId
```
public UserData externalId(String externalId)
```
    Set any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. In the Offline Conversions API, this is known as extern_id. For more information, see Offline Conversions, Providing External IDs. If External ID is being sent via other channels, then it should be sent in the same format via the server-side API.
    
    Parameters:
    
    externalId - unique ID from the advertiser
    
    Returns:
    
    UserData
  - getExternalId
```
public String getExternalId()
```
    Any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. In the Offline Conversions API, this is known as extern_id. For more information, see Offline Conversions, Providing External IDs. If External ID is being sent via other channels, then it should be sent in the same format via the server-side API.
    
    Returns:
    
    externalId
  - setExternalId
```
public void setExternalId(String externalId)
```
    Set any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs. In the Offline Conversions API, this is known as extern_id. For more information, see Offline Conversions, Providing External IDs. If External ID is being sent via other channels, then it should be sent in the same format via the server-side API.
    
    Parameters:
    
    externalId - unique ID from the advertiser
  - clientIpAddress
```
public UserData clientIpAddress(String clientIpAddress)
```
    Set IP address of the browser corresponding to the event.
    
    Parameters:
    
    clientIpAddress - IP address of the browser corresponding to the event
    
    Returns:
    
    UserData
  - getClientIpAddress
```
public String getClientIpAddress()
```
    The IP address of the browser corresponding to the event.
    
    Returns:
    
    clientIpAddress
  - setClientIpAddress
```
public void setClientIpAddress(String clientIpAddress)
```
    Set IP address of the browser corresponding to the event.
    
    Parameters:
    
    clientIpAddress - IP address of the browser corresponding to the event
  - clientUserAgent
```
public UserData clientUserAgent(String clientUserAgent)
```
    Set user agent for the browser corresponding to the event.
    
    Parameters:
    
    clientUserAgent - user agent for the browser corresponding to the event
    
    Returns:
    
    UserData
  - getClientUserAgent
```
public String getClientUserAgent()
```
    The user agent for the browser corresponding to the event.
    
    Returns:
    
    clientUserAgent
  - setClientUserAgent
```
public void setClientUserAgent(String clientUserAgent)
```
    Set user agent for the browser corresponding to the event.
    
    Parameters:
    
    clientUserAgent - user agent for the browser corresponding to the event
  - fbc
```
public UserData fbc(String fbc)
```
    Set Facebook click ID value stored in the _fbc browser cookie under your domain. See Managing fbc and fbp Parameters for how to get this value (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc), or generate this value from a fbclid query parameter.
    
    Parameters:
    
    fbc - Facebook click ID
    
    Returns:
    
    UserData
  - getFbc
```
public String getFbc()
```
    The Facebook click ID value stored in the _fbc browser cookie under your domain. See Managing fbc and fbp Parameters for how to get this value (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc), or generate this value from a fbclid query parameter.
    
    Returns:
    
    fbc
  - setFbc
```
public void setFbc(String fbc)
```
    Set Facebook click ID value stored in the _fbc browser cookie under your domain. See Managing fbc and fbp Parameters for how to get this value (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc), or generate this value from a fbclid query parameter.
    
    Parameters:
    
    fbc - Facebook click ID
  - fbp
```
public UserData fbp(String fbp)
```
    Set Facebook browser ID value stored in the _fbp browser cookie under your domain. See Managing fbc and fbp Parameters for how to get this value (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc), or generate this value from a fbclid query parameter.
    
    Parameters:
    
    fbp - Facebook browser ID
    
    Returns:
    
    UserData
  - getFbp
```
public String getFbp()
```
    The Facebook browser ID value stored in the _fbp browser cookie under your domain. See Managing fbc and fbp Parameters for how to get this value (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc), or generate this value from a fbclid query parameter.
    
    Returns:
    
    fbp
  - setFbp
```
public void setFbp(String fbp)
```
    Set Facebook browser ID value stored in the _fbp browser cookie under your domain. See Managing fbc and fbp Parameters for how to get this value (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/parameters#fbc)
    
    Parameters:
    
    fbp - Facebook browser ID
  - subscriptionId
```
public UserData subscriptionId(String subscriptionId)
```
    Set subscription ID for the user in this transaction. This is similar to the order ID for an individual product.
    
    Parameters:
    
    subscriptionId - subscription ID for the user in this transaction
    
    Returns:
    
    UserData
  - getSubscriptionId
```
public String getSubscriptionId()
```
    The subscription ID for the user in this transaction. This is similar to the order ID for an individual product.
    
    Returns:
    
    subscriptionId
  - setSubscriptionId
```
public void setSubscriptionId(String subscriptionId)
```
    Set subscription ID for the user in this transaction. This is similar to the order ID for an individual product.
    
    Parameters:
    
    subscriptionId - subscription ID for the user in this transaction
  - fbLoginId
```
public UserData fbLoginId(String fbLoginId)
```
    Set Facebook Login ID for the user in this event.
    
    Parameters:
    
    fbLoginId - Facebook Login ID for the user in this event
    
    Returns:
    
    UserData
  - getFbLoginId
```
public String getFbLoginId()
```
    The Facebook Login ID for the user in this event.
    
    Returns:
    
    fbLoginId
  - setFbLoginId
```
public void setFbLoginId(String fbLoginId)
```
    Set Facebook Login ID for the user in this event
    
    Parameters:
    
    fbLoginId - Facebook Login ID for the user in this event
  - leadId
```
public UserData leadId(String leadId)
```
    Set LeadId for the event.
    
    Parameters:
    
    leadId - is the ID associated with a lead generated by Facebook's Lead Ads.
    
    Returns:
    
    UserData
  - getLeadId
```
public String getLeadId()
```
    The LeadId for the event.
    
    Returns:
    
    leadId
  - setLeadId
```
public void setLeadId(String leadId)
```
    Set LeadId for the event.
    
    Parameters:
    
    leadId - is the ID associated with a lead generated by Facebook's Lead Ads.
  - f5first
```
public UserData f5first(String f5first)
```
    Set f5first for the event.
    
    Parameters:
    
    f5first - is the first 5 letters of the first name.
    
    Returns:
    
    UserData
  - getF5first
```
public String getF5first()
```
    The f5first for the event.
    
    Returns:
    
    f5first
  - setF5first
```
public void setF5first(String f5first)
```
    Set f5first for the event.
    
    Parameters:
    
    f5first - is the first 5 letters of the first name.
  - f5last
```
public UserData f5last(String f5last)
```
    Set f5last for the event.
    
    Parameters:
    
    f5last - is the first 5 letters of the last name.
    
    Returns:
    
    UserData
  - getF5last
```
public String getF5last()
```
    The f5last for the event.
    
    Returns:
    
    f5last
  - setF5last
```
public void setF5last(String f5last)
```
    Set f5last for the event.
    
    Parameters:
    
    f5last - is the first 5 letters of the last name.
  - fi
```
public UserData fi(String fi)
```
    Set fi for the event.
    
    Parameters:
    
    fi - is the first initial.
    
    Returns:
    
    UserData
  - getFi
```
public String getFi()
```
    The fi for the event.
    
    Returns:
    
    fi
  - setFi
```
public void setFi(String fi)
```
    Set fi for the event.
    
    Parameters:
    
    fi - is the first initial.
  - dobd
```
public UserData dobd(String dobd)
```
    Set dobd for the event.
    
    Parameters:
    
    dobd - is the date of birth day for the event.
    
    Returns:
    
    UserData
  - getDobd
```
public String getDobd()
```
    The dobd for the event.
    
    Returns:
    
    dobd
  - setDobd
```
public void setDobd(String dobd)
```
    Set dobd for the event.
    
    Parameters:
    
    dobd - is the date of birth day for the event.
  - dobm
```
public UserData dobm(String dobm)
```
    Set dobm for the event.
    
    Parameters:
    
    dobm - is the date of birth month for the event.
    
    Returns:
    
    UserData
  - getDobm
```
public String getDobm()
```
    The dobm for the event.
    
    Returns:
    
    dobm
  - setDobm
```
public void setDobm(String dobm)
```
    Set dobm for the event.
    
    Parameters:
    
    dobm - is the date of birth month for the event.
  - doby
```
public UserData doby(String doby)
```
    Set doby for the event.
    
    Parameters:
    
    doby - is the date of birth year for the event.
    
    Returns:
    
    UserData
  - getDoby
```
public String getDoby()
```
    The doby for the event.
    
    Returns:
    
    doby
  - setDoby
```
public void setDoby(String doby)
```
    Set doby for the event.
    
    Parameters:
    
    doby - is the date of birth year for the event.
  - 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

Class UserData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UserData

UserData

Method Detail

email

getEmail

setEmail

phone

getPhone

setPhone

gender

getGender

setGender

dateOfBirth

getDateOfBirth

setDateOfBirth

lastName

getLastName

setLastName

firstName

getFirstName

setFirstName

city

getCity

setCity

state

getState

setState

zipcode

getZipcode

setZipcode

countryCode

getCountryCode

setCountryCode

externalId

getExternalId

setExternalId

clientIpAddress

getClientIpAddress

setClientIpAddress

clientUserAgent

getClientUserAgent

setClientUserAgent

fbc

getFbc

setFbc

fbp

getFbp

setFbp

subscriptionId

getSubscriptionId

setSubscriptionId

fbLoginId

getFbLoginId

setFbLoginId

leadId

getLeadId

setLeadId

f5first

getF5first

setF5first

f5last

getF5last

setF5last

fi

getFi

setFi

dobd

getDobd

setDobd

dobm

getDobm

setDobm

doby

getDoby

setDoby