React-native-fbsdk: Add missing events constants

[macnibblet]

Expose built-in events like the java facebook SDK has.
https://github.com/facebook/facebook-android-sdk/blob/master/facebook-core/src/main/java/com/facebook/appevents/AppEventsConstants.java

Right now I need to check that java file each time I want to map "standard events to facebook because the react-native-fbsdk does not seem to export it in a developer friendly way.

[1pocketaces1]

I am trying to use the standard event ViewContent but seem to be unable using the react-native-fbsdk, is this related and have you found a way to register these standard events in js?

[DanGDroid]

here is the same event names constants for ios FBSDKAppEvents
will be good to add to package

[AndrewMorsillo]

I copied them out of the java source and used a regex to reformat them into typescript... Why is this not part of the SDK? It's definitely confusing because the docs reference constants that don't exist in the code.

export const FBAppEventsConstants = {
    // Event names

    // General purpose

    /** Log this event when an app is being activated. */
    EVENT_NAME_ACTIVATED_APP: "fb_mobile_activate_app",

    EVENT_NAME_DEACTIVATED_APP: "fb_mobile_deactivate_app",

    EVENT_NAME_SESSION_INTERRUPTIONS: "fb_mobile_app_interruptions",

    EVENT_NAME_TIME_BETWEEN_SESSIONS: "fb_mobile_time_between_sessions",

    /** Log this event when the user has completed registration with the app. */
    EVENT_NAME_COMPLETED_REGISTRATION: "fb_mobile_complete_registration",

    /** Log this event when the user has viewed a form of content in the app. */
    EVENT_NAME_VIEWED_CONTENT: "fb_mobile_content_view",

    /** Log this event when the user has performed a search within the app. */
    EVENT_NAME_SEARCHED: "fb_mobile_search",

    /**
     * Log this event when the user has rated an item in the app. The valueToSum passed to logEvent
     * should be the numeric rating.
     */
    EVENT_NAME_RATED: "fb_mobile_rate",

    /** Log this event when the user has completed a tutorial in the app. */
    EVENT_NAME_COMPLETED_TUTORIAL: "fb_mobile_tutorial_completion",

    /** Log this event when the app obtained a push registration token from FCM. */
    EVENT_NAME_PUSH_TOKEN_OBTAINED: "fb_mobile_obtain_push_token",

    // Ecommerce related

    /**
     * Log this event when the user has added an item to their cart. The valueToSum passed to logEvent
     * should be the item's price.
     */
    EVENT_NAME_ADDED_TO_CART: "fb_mobile_add_to_cart",

    /**
     * Log this event when the user has added an item to their wishlist. The valueToSum passed to
     * logEvent should be the item's price.
     */
    EVENT_NAME_ADDED_TO_WISHLIST: "fb_mobile_add_to_wishlist",

    /**
     * Log this event when the user has entered the checkout process. The valueToSum passed to
     * logEvent should be the total price in the cart.
     */
    EVENT_NAME_INITIATED_CHECKOUT: "fb_mobile_initiated_checkout",

    /** Log this event when the user has entered their payment info. */
    EVENT_NAME_ADDED_PAYMENT_INFO: "fb_mobile_add_payment_info",

    /**
     * @deprecated Use {@link AppEventsLogger#logPurchase(java.math.BigDecimal, java.util.Currency)}
     *     instead. Log this event when the user has completed a purchase. The {@link
     *     AppEventsLogger#logPurchase(java.math.BigDecimal, java.util.Currency)} method is a shortcut
     *     for logging this event.
     */
    EVENT_NAME_PURCHASED: "fb_mobile_purchase",

    // Gaming related

    /** Log this event when the user has achieved a level in the app. */
    EVENT_NAME_ACHIEVED_LEVEL: "fb_mobile_level_achieved",

    /** Log this event when the user has unlocked an achievement in the app. */
    EVENT_NAME_UNLOCKED_ACHIEVEMENT: "fb_mobile_achievement_unlocked",

    /**
     * Log this event when the user has spent app credits. The valueToSum passed to logEvent should be
     * the number of credits spent.
     */
    EVENT_NAME_SPENT_CREDITS: "fb_mobile_spent_credits",

    /** A telephone/SMS, email, chat or other type of contact between a customer and your business. */
    EVENT_NAME_CONTACT: "Contact",

    /**
     * The customization of products through a configuration tool or other application your business
     * owns.
     */
    EVENT_NAME_CUSTOMIZE_PRODUCT: "CustomizeProduct",

    /** The donation of funds to your organization or cause. */
    EVENT_NAME_DONATE: "Donate",

    /**
     * When a person finds one of your locations via web or application, with an intention to visit
     * (example: find product at a local store).
     */
    EVENT_NAME_FIND_LOCATION: "FindLocation",

    /** The booking of an appointment to visit one of your locations. */
    EVENT_NAME_SCHEDULE: "Schedule",

    /** The start of a free trial of a product or service you offer (example: trial subscription). */
    EVENT_NAME_START_TRIAL: "StartTrial",

    /**
     * The submission of an application for a product, service or program you offer (example: credit
     * card, educational program or job).
     */
    EVENT_NAME_SUBMIT_APPLICATION: "SubmitApplication",

    /** The start of a paid subscription for a product or service you offer. */
    EVENT_NAME_SUBSCRIBE: "Subscribe",

    /** Log this event when the user views an ad. */
    EVENT_NAME_AD_IMPRESSION: "AdImpression",

    /** Log this event when the user clicks an ad. */
    EVENT_NAME_AD_CLICK: "AdClick",

    /** Log the live streaming events from sdk */
    EVENT_NAME_LIVE_STREAMING_START: "fb_sdk_live_streaming_start",

    EVENT_NAME_LIVE_STREAMING_STOP: "fb_sdk_live_streaming_stop",
    EVENT_NAME_LIVE_STREAMING_PAUSE: "fb_sdk_live_streaming_pause",
    EVENT_NAME_LIVE_STREAMING_RESUME: "fb_sdk_live_streaming_resume",
    EVENT_NAME_LIVE_STREAMING_ERROR: "fb_sdk_live_streaming_error",
    EVENT_NAME_LIVE_STREAMING_UPDATE_STATUS: "fb_sdk_live_streaming_update_status",

    /** Product Catalog related events */
    EVENT_NAME_PRODUCT_CATALOG_UPDATE: "fb_mobile_catalog_update",

    // Event parameters

    /** Paramete keys for live streaming events */
    EVENT_PARAM_LIVE_STREAMING_PREV_STATUS: "live_streaming_prev_status",

    EVENT_PARAM_LIVE_STREAMING_STATUS: "live_streaming_status",
    EVENT_PARAM_LIVE_STREAMING_ERROR: "live_streaming_error",

    /**
     * Parameter key used to specify currency used with logged event. E.g. "USD", "EUR", "GBP". See <a
     * href="http://en.wikipedia.org/wiki/ISO_4217">ISO-4217</a> for specific values.
     */
    EVENT_PARAM_CURRENCY: "fb_currency",

    /**
     * Parameter key used to specify the method the user has used to register for the app, e.g.,
     * "Facebook", "email", "Twitter", etc.
     */
    EVENT_PARAM_REGISTRATION_METHOD: "fb_registration_method",

    /**
     * Parameter key used to specify a generic content type/family for the logged event, e.g. "music",
     * "photo", "video". Options to use will vary depending on the nature of the app.
     */
    EVENT_PARAM_CONTENT_TYPE: "fb_content_type",

    /**
     * Parameter key used to specify data for the one or more pieces of content being logged about.
     * Data should be a JSON encoded string. Example: "[{\"id\": \"1234\", \"quantity\": 2,
     * \"item_price\": 5.99}, {\"id\": \"5678\", \"quantity\": 1, \"item_price\": 9.99}]"
     */
    EVENT_PARAM_CONTENT: "fb_content",

    /**
     * Parameter key used to specify an ID for the specific piece of content being logged about. This
     * could be an EAN, article identifier, etc., depending on the nature of the app.
     */
    EVENT_PARAM_CONTENT_ID: "fb_content_id",

    /** Parameter key used to specify the string provided by the user for a search operation. */
    EVENT_PARAM_SEARCH_STRING: "fb_search_string",

    /**
     * Parameter key used to specify whether the activity being logged about was successful or not.
     * EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good canonical values to use for this
     * parameter.
     */
    EVENT_PARAM_SUCCESS: "fb_success",

    /**
     * Parameter key used to specify the maximum rating available for the EVENT_NAME_RATE event. E.g.,
     * "5" or "10".
     */
    EVENT_PARAM_MAX_RATING_VALUE: "fb_max_rating_value",

    /**
     * Parameter key used to specify whether payment info is available for the
     * EVENT_NAME_INITIATED_CHECKOUT event. EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good
     * canonical values to use for this parameter.
     */
    EVENT_PARAM_PAYMENT_INFO_AVAILABLE: "fb_payment_info_available",

    /**
     * Parameter key used to specify how many items are being processed for an
     * EVENT_NAME_INITIATED_CHECKOUT or EVENT_NAME_PURCHASE event.
     */
    EVENT_PARAM_NUM_ITEMS: "fb_num_items",

    /** Parameter key used to specify the level achieved in an EVENT_NAME_LEVEL_ACHIEVED event. */
    EVENT_PARAM_LEVEL: "fb_level",

    /**
     * Parameter key used to specify a description appropriate to the event being logged. E.g., the
     * name of the achievement unlocked in the EVENT_NAME_ACHIEVEMENT_UNLOCKED event.
     */
    EVENT_PARAM_DESCRIPTION: "fb_description",

    /** Parameter key used to specify source application package. */
    EVENT_PARAM_SOURCE_APPLICATION: "fb_mobile_launch_source",

    /** Parameter key used to specify package fingerprint. */
    EVENT_PARAM_PACKAGE_FP: "fb_mobile_pckg_fp",

    /** Parameter key used to specify hashed cert for signing the apk. */
    EVENT_PARAM_APP_CERT_HASH: "fb_mobile_app_cert_hash",

    // Parameter values

    /** Yes-valued parameter value to be used with parameter keys that need a Yes/No value */
    EVENT_PARAM_VALUE_YES: "1",

    /** No-valued parameter value to be used with parameter keys that need a Yes/No value */
    EVENT_PARAM_VALUE_NO: "0",

    /**
     * Parameter key used to specify the type of ad in an EVENT_NAME_AD_IMPRESSION or
     * EVENT_NAME_AD_CLICK event. E.g. "banner", "interstitial", "rewarded_video", "native"
     */
    EVENT_PARAM_AD_TYPE: "ad_type",

    /**
     * Parameter key used to specify the unique ID for all events within a subscription in an
     * EVENT_NAME_SUBSCRIBE or EVENT_NAME_START_TRIAL event.
     */
    EVENT_PARAM_ORDER_ID: "fb_order_id",

    EVENT_PARAM_VALUE_TO_SUM: "_valueToSum",

    /**
     * Parameter keys used to specify additional information about item for
     * EVENT_NAME_PRODUCT_CATALOG_UPDATE event.
     */
    EVENT_PARAM_PRODUCT_CUSTOM_LABEL_0: "fb_product_custom_label_0",

    EVENT_PARAM_PRODUCT_CUSTOM_LABEL_1: "fb_product_custom_label_1",
    EVENT_PARAM_PRODUCT_CUSTOM_LABEL_2: "fb_product_custom_label_2",
    EVENT_PARAM_PRODUCT_CUSTOM_LABEL_3: "fb_product_custom_label_3",
    EVENT_PARAM_PRODUCT_CUSTOM_LABEL_4: "fb_product_custom_label_4",
    // Optional field "google_product_category"
    EVENT_PARAM_PRODUCT_CATEGORY: "fb_product_category",

    /**
     * Parameter keys used to specify the product deep links for EVENT_NAME_PRODUCT_CATALOG_UPDATE
     * event.
     */
    EVENT_PARAM_PRODUCT_APPLINK_IOS_URL: "fb_product_applink_ios_url",

    EVENT_PARAM_PRODUCT_APPLINK_IOS_APP_STORE_ID: "fb_product_applink_ios_app_store_id",
    EVENT_PARAM_PRODUCT_APPLINK_IOS_APP_NAME: "fb_product_applink_ios_app_name",
    EVENT_PARAM_PRODUCT_APPLINK_IPHONE_URL: "fb_product_applink_iphone_url",
    EVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_STORE_ID: "fb_product_applink_iphone_app_store_id",
    EVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_NAME: "fb_product_applink_iphone_app_name",
    EVENT_PARAM_PRODUCT_APPLINK_IPAD_URL: "fb_product_applink_ipad_url",
    EVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_STORE_ID: "fb_product_applink_ipad_app_store_id",
    EVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_NAME: "fb_product_applink_ipad_app_name",
    EVENT_PARAM_PRODUCT_APPLINK_ANDROID_URL: "fb_product_applink_android_url",
    EVENT_PARAM_PRODUCT_APPLINK_ANDROID_PACKAGE: "fb_product_applink_android_package",
    EVENT_PARAM_PRODUCT_APPLINK_ANDROID_APP_NAME: "fb_product_applink_android_app_name",
    EVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_URL: "fb_product_applink_windows_phone_url",
    EVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_ID: "fb_product_applink_windows_phone_app_id",
    EVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_NAME: "fb_product_applink_windows_phone_app_name",
} as const

export type FBAppEventsConstantType = typeof FBAppEventsConstants[keyof typeof FBAppEventsConstants]

[AndrewMorsillo]

And here's a correct type for AppEventsLogger.logEvent

export type FBAppEventParamsType = { [key: string]: string | number }

function logFbEvent(event: FBAppEventsConstantType): void
function logFbEvent(event: FBAppEventsConstantType, valueToSum: number): void
function logFbEvent(event: FBAppEventsConstantType, data: FBAppEventParamsType): void
function logFbEvent(event: FBAppEventsConstantType, valueToSum: number, data: FBAppEventParamsType): void
function logFbEvent(
    event: FBAppEventsConstantType,
    valueToSum?: number | FBAppEventParamsType,
    data?: FBAppEventParamsType
): void {
    try {
        if (typeof valueToSum == "number") {
            if (!!data) {
                AppEventsLogger.logEvent(event, valueToSum, data)
            } else {
                AppEventsLogger.logEvent(event, valueToSum)
            }
        } else if (!!data) {
            AppEventsLogger.logEvent(event, data)
        } else {
            AppEventsLogger.logEvent(event)
        }
    } catch (error) {
        log.error("Error logging fb app event", { error })
    }
}

[ndiyansah]

u can read this docs for implement https://github.com/facebook/react-native-fbsdk/blob/17af77b48ad6ea62fa3c0f552cd8f6a699ef6a64/src/FBAppEventsLogger.js#L92

and u can find constant from here : https://github.com/facebook/facebook-android-sdk/blob/master/facebook-core/src/main/java/com/facebook/appevents/AppEventsConstants.java#L33-L312

[ndiyansah]

@AndrewMorsillo
i trying like this

// helpers

import { AppEventsLogger } from 'react-native-fbsdk'

export const FB_ADDED_TO_CART = 'fb_mobile_add_to_cart'
export async function logAdsEvent(eventName, ...args) {
  let valueToSum = 0
  if (typeof args[0] === 'number') {
    valueToSum = args.shift()
  }
  let parameters = null
  if (typeof args[0] === 'object') {
    parameters = toSnakeCase(args[0])
  }

  AppEventsLogger.logEvent(eventName, valueToSum, parameters)

}

implementation

import helpers

 logAdsEvent(FB_ADDED_TO_CART, result.stores[0].subTotal || 0, {
          fbContent: JSON.stringify(result.stores[0]),
          fbCurrency: 'IDR'
        })

[dooleyb1]

@AndrewMorsillo
i trying like this

// helpers

import { AppEventsLogger } from 'react-native-fbsdk'

export const FB_ADDED_TO_CART = 'fb_mobile_add_to_cart'
export async function logAdsEvent(eventName, ...args) {
  let valueToSum = 0
  if (typeof args[0] === 'number') {
    valueToSum = args.shift()
  }
  let parameters = null
  if (typeof args[0] === 'object') {
    parameters = toSnakeCase(args[0])
  }

  AppEventsLogger.logEvent(eventName, valueToSum, parameters)

}

implementation

import helpers

 logAdsEvent(FB_ADDED_TO_CART, result.stores[0].subTotal || 0, {
          fbContent: JSON.stringify(result.stores[0]),
          fbCurrency: 'IDR'
        })

@ndiyansah were you able to get standard events being logged using this library to appear in the Facebook Events Manager console?