| Package | Description |
|---|---|
| com.facebook.ads.sdk.signal |
| Modifier and Type | Method and Description |
|---|---|
SignalResponse<EventResponse,EventResponse> |
EventRequest.execute()
Synchronously send Event to Facebook GraphAPI.
|
SignalResponse<String,String> |
UserData.getAddress()
The physical address for the event.
|
SignalResponse<UserData,UserData> |
CustomData.getBillingContact()
Gets the billingcontact for Purchase/Update Order event.
|
SignalResponse<String,String> |
Content.getbrand()
Gets the Brand of the listed Item.
|
SignalResponse<String,String> |
Content.getCategory()
Gets the Category of the listed Item.
|
SignalResponse<String,String> |
UserData.getCity()
A city in lower-case without spaces or punctuation.
|
SignalResponse<String,String> |
UserData.getClientIpAddress()
The IP address of the browser corresponding to the event.
|
SignalResponse<String,String> |
UserData.getClientUserAgent()
The user agent for the browser corresponding to the event.
|
SignalResponse<String,String> |
CustomData.getContentCategory()
Gets the content category for the custom data.
|
SignalResponse<List<String>,List<String>> |
CustomData.getContentIds()
Gets the contentids for the custom data.
|
SignalResponse<String,String> |
CustomData.getContentName()
Gets the content name for the custom data.
|
SignalResponse<List<Content>,List<Content>> |
CustomData.getContents()
Gets the contents for the custom data.
|
SignalResponse<String,String> |
CustomData.getContentType()
Gets the content type for the custom data.
|
SignalResponse<String,String> |
UserData.getCountryCode()
A two-letter country code in lowercase.
|
SignalResponse<String,String> |
CustomData.getCurrency()
Gets the currency for the custom data.
|
SignalResponse<CustomData,CustomData> |
Event.getCustomData()
Gets the custom data objects for Business Data API and Conversion API.
|
SignalResponse<HashMap<String,String>,HashMap<String,String>> |
CustomData.getCustomProperties()
Gets the custom properties to be included in the Custom Data.
|
SignalResponse<List<Event>,List<Event>> |
EventRequest.getData()
A list of Event objects
|
SignalResponse<String[],String[]> |
Event.getDataProcessingOptions()
Gets the dataProcessingOptions for the current event.
|
SignalResponse<Integer,Integer> |
Event.getDataProcessingOptionsCountry()
Gets the dataProcessingOptionsCountry for the current event.
|
SignalResponse<Integer,Integer> |
Event.getDataProcessingOptionsState()
Gets the dataProcessingOptionsState for the current event.
|
SignalResponse<String,String> |
UserData.getDateOfBirth()
Return a date of birth given as year, month, and day.
|
SignalResponse<DeliveryCategory,DeliveryCategory> |
CustomData.getDeliveryCategory()
Gets the delivery category.
|
SignalResponse<DeliveryCategory,DeliveryCategory> |
Content.getDeliveryCategory()
Gets the delivery category.
|
SignalResponse<String,String> |
Content.getDescription()
Gets the Description of the listed Item.
|
SignalResponse<String,String> |
UserData.getDobd()
The dobd for the event.
|
SignalResponse<String,String> |
UserData.getDobm()
The dobm for the event.
|
SignalResponse<String,String> |
UserData.getDoby()
The doby for the event.
|
SignalResponse<String,String> |
UserData.getEmail()
An email address, in lowercase.
|
SignalResponse<String,String> |
Event.getEventId()
Gets the eventId for the current Event.
|
SignalResponse<String,String> |
Event.getEventName()
Gets the Event Name for the current Event.
|
SignalResponse<String,String> |
Event.getEventSourceUrl()
Gets the browser url source for the current event.
|
SignalResponse<Long,Long> |
Event.getEventTime()
Gets the Event Time when the current Event happened.
|
SignalResponse<String,String> |
Content.getExternalContentId()
Gets the external id for this order item The external id for the products
that are being involved in the customer interaction.
|
SignalResponse<String,String> |
UserData.getExternalId()
Any unique ID from the advertiser, such as loyalty membership IDs, user IDs,
and external cookie IDs.
|
SignalResponse<String,String> |
CustomData.getExternalOrderId()
Gets the unique id of the order.
|
SignalResponse<String,String> |
UserData.getF5first()
The f5first for the event.
|
SignalResponse<String,String> |
UserData.getF5last()
The f5last for the event.
|
SignalResponse<String,String> |
UserData.getFbc()
The Facebook click ID value stored in the _fbc browser cookie under your
domain.
|
SignalResponse<String,String> |
UserData.getFbLoginId()
The Facebook Login ID for the user in this event.
|
SignalResponse<String,String> |
UserData.getFbp()
The Facebook browser ID value stored in the _fbp browser cookie under your
domain.
|
SignalResponse<String,String> |
UserData.getFi()
The fi for the event.
|
SignalResponse<String,String> |
UserData.getFirstName()
A first name in lowercase.
|
SignalResponse<GenderEnum,GenderEnum> |
UserData.getGender()
Gender, Male or Female.
|
SignalResponse<HttpServiceInterface,HttpServiceInterface> |
EventRequest.getHttpServiceClient()
Get the httpServiceClient.
|
SignalResponse<String,String> |
Content.getId()
Gets the Product Id of the Item.
|
SignalResponse<String,String> |
CustomData.getItemNumber()
Gets the item number.
|
SignalResponse<Float,Float> |
Content.getItemPrice()
Gets the item price for the Product.
|
SignalResponse<String,String> |
UserData.getLastName()
A last name in lowercase.
|
SignalResponse<String,String> |
UserData.getLeadId()
The LeadId for the event.
|
SignalResponse<String,String> |
CustomData.getMessage()
Gets the unique id of the original order.
|
SignalResponse<String,String> |
EventRequest.getNamespaceId()
The namespace id is a scope used to resolve extern_id or Third-party ID.
|
SignalResponse<String,String> |
CustomData.getNumItems()
Gets the number of items for the custom data.
|
SignalResponse<Boolean,Boolean> |
Event.getOptOut()
Gets the optOut feature for the current event.optOut is a boolean flag that
indicates we should not use this event for ads delivery optimization.
|
SignalResponse<String,String> |
CustomData.getOrderId()
Gets the order id for the custom data.
|
SignalResponse<String,String> |
CustomData.getOriginalOrderId()
Gets the unique id of the original order.
|
SignalResponse<String,String> |
EventRequest.getPartnerAgent()
A value that represents the platform that is sending the event.
|
SignalResponse<String,String> |
UserData.getPhone()
A phone number.
|
SignalResponse<Float,Float> |
CustomData.getPredictedLtv()
Gets the predicted LifeTimeValue for the (user) in custom data.
|
SignalResponse<Float,Float> |
Content.getPrice()
Gets the total price of the Item.
|
SignalResponse<Long,Long> |
Content.getQuantity()
Gets the quantity of the Item.
|
SignalResponse<String,String> |
CustomData.getSearchString()
Gets the search string for the custom data.
|
SignalResponse<UserData,UserData> |
CustomData.getShippingContact()
Gets the shippingcontact for Purchase/Update Order event.
|
SignalResponse<String,String> |
UserData.getState()
A two-letter state code in lowercase.
|
SignalResponse<String,String> |
CustomData.getStatus()
Status of the registration in Registration event or Status of the order in
Purchase/UpdateOrder event.
|
SignalResponse<String,String> |
UserData.getSubscriptionId()
The subscription ID for the user in this transaction.
|
SignalResponse<Float,Float> |
Content.getTax()
Gets the total tax of the Item.
|
SignalResponse<String,String> |
EventRequest.getTestEventCode()
Code used to verify that your server events are received correctly by
Facebook.
|
SignalResponse<String,String> |
Content.getTitle()
Gets the Title of the listed Item.
|
SignalResponse<String,String> |
EventRequest.getUploadId()
The upload id is a unique id used to denote the current set being uploaded.
|
SignalResponse<String,String> |
EventRequest.getUploadSource()
The upload source is the origin/source of data for the dataset to be
uploaded.
|
SignalResponse<String,String> |
EventRequest.getUploadTag()
The upload tag is a tag string added to track your Offline event uploads.
|
SignalResponse<UserData,UserData> |
Event.getUserData()
Gets the user data objects for Business Data API and Conversion API.
|
SignalResponse<Float,Float> |
CustomData.getValue()
Gets the value of the custom data.
|
SignalResponse<String,String> |
UserData.getZipcode()
A five-digit zip code.
|
Copyright © 2024. All rights reserved.