Uses of Class
com.facebook.ads.sdk.serverside.UserData

Packages that use UserData

Package	Description
com.facebook.ads.sdk.serverside
com.facebook.ads.sdk.signal

Uses of UserData in com.facebook.ads.sdk.serverside

Methods in com.facebook.ads.sdk.serverside that return UserData

Modifier and Type	Method and Description
UserData	UserData.anonId(String anonId) Set the ID of a person who has installed the app anonymously
UserData	UserData.cities(List<String> cities) Set cities in lower-case without spaces or punctuation.
UserData	UserData.city(String city) Set a city in lower-case without spaces or punctuation.
UserData	UserData.clientIpAddress(String clientIpAddress) Set IP address of the browser corresponding to the event.
UserData	UserData.clientUserAgent(String clientUserAgent) Set user agent for the browser corresponding to the event.
UserData	UserData.countryCode(String countryCode) Set a two-letter country code in lowercase.
UserData	UserData.countryCodes(List<String> countryCodes) Set two-letter country codes in lowercase.
UserData	UserData.ctwaClid(String ctwaClid) Get the ctwaClid of the conversation that was started on WhatsApp
UserData	UserData.dateOfBirth(String dateOfBirth) Set a date of birth given as year, month, and day.
UserData	UserData.datesOfBirth(List<String> datesOfBirth) Set dates of birth given as year, month, and day.
UserData	UserData.dobd(String dobd) Set dobd for the event.
UserData	UserData.dobm(String dobm) Set dobm for the event.
UserData	UserData.doby(String doby) Set doby for the event.
UserData	UserData.email(String email) Set an email address, in lowercase.
UserData	UserData.emails(List<String> emails) Set multiple email addresses, in lowercase.
UserData	UserData.externalId(String externalId) Set any unique ID from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs.
UserData	UserData.externalIds(List<String> externalIds) Set any unique IDs from the advertiser, such as loyalty membership IDs, user IDs, and external cookie IDs.
UserData	UserData.f5first(String f5first) Set f5first for the event.
UserData	UserData.f5last(String f5last) Set f5last for the event.
UserData	UserData.fbc(String fbc) Set Facebook click ID value stored in the _fbc browser cookie under your domain.
UserData	UserData.fbLoginId(String fbLoginId) Set Facebook Login ID for the user in this event.
UserData	UserData.fbp(String fbp) Set Facebook browser ID value stored in the _fbp browser cookie under your domain.
UserData	UserData.fi(String fi) Set fi for the event.
UserData	UserData.firstName(String firstName) Set a first name in lowercase.
UserData	UserData.firstNames(List<String> firstNames) Set first names in lowercase.
UserData	UserData.gender(GenderEnum gender) Gender.
UserData	UserData.genders(List<GenderEnum> genders) Gender.
UserData	Event.getUserData() Get UserData object that contains user data
UserData	UserData.lastName(String lastName) Set a last name in lowercase.
UserData	UserData.lastNames(List<String> lastNames) Set last names in lowercase.
UserData	UserData.leadId(String leadId) Set LeadId for the event.
UserData	UserData.madid(String madid) Set the mobile advertiser id which is either Apple's Advertising Identifier (IDFA) or Google Android's advertising ID
UserData	UserData.pageId(String pageId) Get the ID of the page that the ad is associated with
UserData	UserData.phone(String phone) Set a phone number.
UserData	UserData.phones(List<String> phones) Set a phone number.
UserData	UserData.state(String state) Set a two-letter state code in lowercase.
UserData	UserData.states(List<String> states) Set two-letter state codes in lowercase.
UserData	UserData.subscriptionId(String subscriptionId) Set subscription ID for the user in this transaction.
UserData	UserData.zipcode(String zipcode) Set a five-digit zip code.
UserData	UserData.zipcodes(List<String> zipcodes) Set five-digit zip codes.

Methods in com.facebook.ads.sdk.serverside with parameters of type UserData

Modifier and Type	Method and Description
void	Event.setUserData(UserData userData) Set UserData object that contains user data
Event	Event.userData(UserData userData) Set UserData object that contains user data

Constructors in com.facebook.ads.sdk.serverside with parameters of type UserData

Constructor and Description

Event(String eventName, Long eventTime, String eventSourceUrl, Boolean optOut, String eventId, UserData userData, CustomData customData, String[] dataProcessingOptions, Integer dataProcessingOptionsCountry, Integer dataProcessingOptionsState, ActionSource actionSource, AppData appData, String advancedMeasurementTable, MessagingChannel messagingChannel, OriginalEventData originalEventData, AttributionData attributionData) Constructor.

Uses of UserData in com.facebook.ads.sdk.signal

Methods in com.facebook.ads.sdk.signal that return UserData

Modifier and Type	Method and Description
UserData	UserData.getServerSideUserData() Gets user data for conversion api

Methods in com.facebook.ads.sdk.signal that return types with arguments of type UserData

Modifier and Type	Method and Description
SignalResponse<UserData,UserData>	CustomData.getBillingContact() Gets the billingcontact for Purchase/Update Order event.
SignalResponse<UserData,UserData>	CustomData.getShippingContact() Gets the shippingcontact for Purchase/Update Order event.
SignalResponse<UserData,UserData>	Event.getUserData() Gets the user data objects for Business Data API and Conversion API.