AppEventsConstants.cs 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. namespace PottingMobileSDK
  2. {
  3. public class AppEventsConstants
  4. {
  5. // Event names
  6. // General purpose
  7. /** Log this event when an app is being activated. */
  8. public static string EVENT_NAME_ACTIVATED_APP = "fb_mobile_activate_app";
  9. public static string EVENT_NAME_DEACTIVATED_APP = "fb_mobile_deactivate_app";
  10. public static string EVENT_NAME_SESSION_INTERRUPTIONS = "fb_mobile_app_interruptions";
  11. public static string EVENT_NAME_TIME_BETWEEN_SESSIONS = "fb_mobile_time_between_sessions";
  12. /** Log this event when the user has completed registration with the app. */
  13. public static string EVENT_NAME_COMPLETED_REGISTRATION = "fb_mobile_complete_registration";
  14. /** Log this event when the user has viewed a form of content in the app. */
  15. public static string EVENT_NAME_VIEWED_CONTENT = "fb_mobile_content_view";
  16. /** Log this event when the user has performed a search within the app. */
  17. public static string EVENT_NAME_SEARCHED = "fb_mobile_search";
  18. /**
  19. * Log this event when the user has rated an item in the app. The valueToSum passed to logEvent
  20. * should be the numeric rating.
  21. */
  22. public static string EVENT_NAME_RATED = "fb_mobile_rate";
  23. /** Log this event when the user has completed a tutorial in the app. */
  24. public static string EVENT_NAME_COMPLETED_TUTORIAL = "fb_mobile_tutorial_completion";
  25. /** Log this event when the app obtained a push registration token from FCM. */
  26. public static string EVENT_NAME_PUSH_TOKEN_OBTAINED = "fb_mobile_obtain_push_token";
  27. // Ecommerce related
  28. /**
  29. * Log this event when the user has added an item to their cart. The valueToSum passed to logEvent
  30. * should be the item's price.
  31. */
  32. public static string EVENT_NAME_ADDED_TO_CART = "fb_mobile_add_to_cart";
  33. /**
  34. * Log this event when the user has added an item to their wishlist. The valueToSum passed to
  35. * logEvent should be the item's price.
  36. */
  37. public static string EVENT_NAME_ADDED_TO_WISHLIST = "fb_mobile_add_to_wishlist";
  38. /**
  39. * Log this event when the user has entered the checkout process. The valueToSum passed to
  40. * logEvent should be the total price in the cart.
  41. */
  42. public static string EVENT_NAME_INITIATED_CHECKOUT = "fb_mobile_initiated_checkout";
  43. /** Log this event when the user has entered their payment info. */
  44. public static string EVENT_NAME_ADDED_PAYMENT_INFO = "fb_mobile_add_payment_info";
  45. /**
  46. * @deprecated Use {@link AppEventsLogger#logPurchase(java.math.BigDecimal, java.util.Currency)}
  47. * instead. Log this event when the user has completed a purchase. The {@link
  48. * AppEventsLogger#logPurchase(java.math.BigDecimal, java.util.Currency)} method is a shortcut
  49. * for logging this event.
  50. */
  51. public static string EVENT_NAME_PURCHASED = "fb_mobile_purchase";
  52. // Gaming related
  53. /** Log this event when the user has achieved a level in the app. */
  54. public static string EVENT_NAME_ACHIEVED_LEVEL = "fb_mobile_level_achieved";
  55. /** Log this event when the user has unlocked an achievement in the app. */
  56. public static string EVENT_NAME_UNLOCKED_ACHIEVEMENT = "fb_mobile_achievement_unlocked";
  57. /**
  58. * Log this event when the user has spent app credits. The valueToSum passed to logEvent should be
  59. * the number of credits spent.
  60. */
  61. public static string EVENT_NAME_SPENT_CREDITS = "fb_mobile_spent_credits";
  62. /** A telephone/SMS, email, chat or other type of contact between a customer and your business. */
  63. public static string EVENT_NAME_CONTACT = "Contact";
  64. /**
  65. * The customization of products through a configuration tool or other application your business
  66. * owns.
  67. */
  68. public static string EVENT_NAME_CUSTOMIZE_PRODUCT = "CustomizeProduct";
  69. /** The donation of funds to your organization or cause. */
  70. public static string EVENT_NAME_DONATE = "Donate";
  71. /**
  72. * When a person finds one of your locations via web or application, with an intention to visit
  73. * (example: find product at a local store).
  74. */
  75. public static string EVENT_NAME_FIND_LOCATION = "FindLocation";
  76. /** The booking of an appointment to visit one of your locations. */
  77. public static string EVENT_NAME_SCHEDULE = "Schedule";
  78. /** The start of a free trial of a product or service you offer (example: trial subscription). */
  79. public static string EVENT_NAME_START_TRIAL = "StartTrial";
  80. /**
  81. * The submission of an application for a product, service or program you offer (example: credit
  82. * card, educational program or job).
  83. */
  84. public static string EVENT_NAME_SUBMIT_APPLICATION = "SubmitApplication";
  85. /** The start of a paid subscription for a product or service you offer. */
  86. public static string EVENT_NAME_SUBSCRIBE = "Subscribe";
  87. /** Log this event when the user views an ad. */
  88. public static string EVENT_NAME_AD_IMPRESSION = "AdImpression";
  89. /** Log this event when the user clicks an ad. */
  90. public static string EVENT_NAME_AD_CLICK = "AdClick";
  91. /** Log the live streaming events from sdk */
  92. public static string EVENT_NAME_LIVE_STREAMING_START = "fb_sdk_live_streaming_start";
  93. public static string EVENT_NAME_LIVE_STREAMING_STOP = "fb_sdk_live_streaming_stop";
  94. public static string EVENT_NAME_LIVE_STREAMING_PAUSE = "fb_sdk_live_streaming_pause";
  95. public static string EVENT_NAME_LIVE_STREAMING_RESUME = "fb_sdk_live_streaming_resume";
  96. public static string EVENT_NAME_LIVE_STREAMING_ERROR = "fb_sdk_live_streaming_error";
  97. public static string EVENT_NAME_LIVE_STREAMING_UPDATE_STATUS =
  98. "fb_sdk_live_streaming_update_status";
  99. /** Product Catalog related events */
  100. public static string EVENT_NAME_PRODUCT_CATALOG_UPDATE = "fb_mobile_catalog_update";
  101. // Event parameters
  102. /** Paramete keys for live streaming events */
  103. public static string EVENT_PARAM_LIVE_STREAMING_PREV_STATUS = "live_streaming_prev_status";
  104. public static string EVENT_PARAM_LIVE_STREAMING_STATUS = "live_streaming_status";
  105. public static string EVENT_PARAM_LIVE_STREAMING_ERROR = "live_streaming_error";
  106. /**
  107. * Parameter key used to specify currency used with logged event. E.g. "USD", "EUR", "GBP". See <a
  108. * href="http://en.wikipedia.org/wiki/ISO_4217">ISO-4217</a> for specific values.
  109. */
  110. public static string EVENT_PARAM_CURRENCY = "fb_currency";
  111. /**
  112. * Parameter key used to specify the method the user has used to register for the app, e.g.,
  113. * "Facebook", "email", "Twitter", etc.
  114. */
  115. public static string EVENT_PARAM_REGISTRATION_METHOD = "fb_registration_method";
  116. /**
  117. * Parameter key used to specify a generic content type/family for the logged event, e.g. "music",
  118. * "photo", "video". Options to use will vary depending on the nature of the app.
  119. */
  120. public static string EVENT_PARAM_CONTENT_TYPE = "fb_content_type";
  121. /**
  122. * Parameter key used to specify data for the one or more pieces of content being logged about.
  123. * Data should be a JSON encoded string. Example: "[{\"id\": \"1234\", \"quantity\": 2,
  124. * \"item_price\": 5.99}, {\"id\": \"5678\", \"quantity\": 1, \"item_price\": 9.99}]"
  125. */
  126. public static string EVENT_PARAM_CONTENT = "fb_content";
  127. /**
  128. * Parameter key used to specify an ID for the specific piece of content being logged about. This
  129. * could be an EAN, article identifier, etc., depending on the nature of the app.
  130. */
  131. public static string EVENT_PARAM_CONTENT_ID = "fb_content_id";
  132. /** Parameter key used to specify the string provided by the user for a search operation. */
  133. public static string EVENT_PARAM_SEARCH_string = "fb_search_string";
  134. /**
  135. * Parameter key used to specify whether the activity being logged about was successful or not.
  136. * EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good canonical values to use for this
  137. * parameter.
  138. */
  139. public static string EVENT_PARAM_SUCCESS = "fb_success";
  140. /**
  141. * Parameter key used to specify the maximum rating available for the EVENT_NAME_RATE event. E.g.,
  142. * "5" or "10".
  143. */
  144. public static string EVENT_PARAM_MAX_RATING_VALUE = "fb_max_rating_value";
  145. /**
  146. * Parameter key used to specify whether payment info is available for the
  147. * EVENT_NAME_INITIATED_CHECKOUT event. EVENT_PARAM_VALUE_YES and EVENT_PARAM_VALUE_NO are good
  148. * canonical values to use for this parameter.
  149. */
  150. public static string EVENT_PARAM_PAYMENT_INFO_AVAILABLE = "fb_payment_info_available";
  151. /**
  152. * Parameter key used to specify how many items are being processed for an
  153. * EVENT_NAME_INITIATED_CHECKOUT or EVENT_NAME_PURCHASE event.
  154. */
  155. public static string EVENT_PARAM_NUM_ITEMS = "fb_num_items";
  156. /** Parameter key used to specify the level achieved in an EVENT_NAME_LEVEL_ACHIEVED event. */
  157. public static string EVENT_PARAM_LEVEL = "fb_level";
  158. /**
  159. * Parameter key used to specify a description appropriate to the event being logged. E.g., the
  160. * name of the achievement unlocked in the EVENT_NAME_ACHIEVEMENT_UNLOCKED event.
  161. */
  162. public static string EVENT_PARAM_DESCRIPTION = "fb_description";
  163. /** Parameter key used to specify source application package. */
  164. public static string EVENT_PARAM_SOURCE_APPLICATION = "fb_mobile_launch_source";
  165. /** Parameter key used to specify package fingerprint. */
  166. public static string EVENT_PARAM_PACKAGE_FP = "fb_mobile_pckg_fp";
  167. /** Parameter key used to specify hashed cert for signing the apk. */
  168. public static string EVENT_PARAM_APP_CERT_HASH = "fb_mobile_app_cert_hash";
  169. // Parameter values
  170. /** Yes-valued parameter value to be used with parameter keys that need a Yes/No value */
  171. public static string EVENT_PARAM_VALUE_YES = "1";
  172. /** No-valued parameter value to be used with parameter keys that need a Yes/No value */
  173. public static string EVENT_PARAM_VALUE_NO = "0";
  174. /**
  175. * Parameter key used to specify the type of ad in an EVENT_NAME_AD_IMPRESSION or
  176. * EVENT_NAME_AD_CLICK event. E.g. "banner", "interstitial", "rewarded_video", "native"
  177. */
  178. public static string EVENT_PARAM_AD_TYPE = "ad_type";
  179. /**
  180. * Parameter key used to specify the unique ID for all events within a subscription in an
  181. * EVENT_NAME_SUBSCRIBE or EVENT_NAME_START_TRIAL event.
  182. */
  183. public static string EVENT_PARAM_ORDER_ID = "fb_order_id";
  184. public static string EVENT_PARAM_VALUE_TO_SUM = "_valueToSum";
  185. /**
  186. * Parameter keys used to specify additional information about item for
  187. * EVENT_NAME_PRODUCT_CATALOG_UPDATE event.
  188. */
  189. public static string EVENT_PARAM_PRODUCT_CUSTOM_LABEL_0 = "fb_product_custom_label_0";
  190. public static string EVENT_PARAM_PRODUCT_CUSTOM_LABEL_1 = "fb_product_custom_label_1";
  191. public static string EVENT_PARAM_PRODUCT_CUSTOM_LABEL_2 = "fb_product_custom_label_2";
  192. public static string EVENT_PARAM_PRODUCT_CUSTOM_LABEL_3 = "fb_product_custom_label_3";
  193. public static string EVENT_PARAM_PRODUCT_CUSTOM_LABEL_4 = "fb_product_custom_label_4";
  194. // Optional field "google_product_category"
  195. public static string EVENT_PARAM_PRODUCT_CATEGORY = "fb_product_category";
  196. /**
  197. * Parameter keys used to specify the product deep links for EVENT_NAME_PRODUCT_CATALOG_UPDATE
  198. * event.
  199. */
  200. public static string EVENT_PARAM_PRODUCT_APPLINK_IOS_URL = "fb_product_applink_ios_url";
  201. public static string EVENT_PARAM_PRODUCT_APPLINK_IOS_APP_STORE_ID =
  202. "fb_product_applink_ios_app_store_id";
  203. public static string EVENT_PARAM_PRODUCT_APPLINK_IOS_APP_NAME =
  204. "fb_product_applink_ios_app_name";
  205. public static string EVENT_PARAM_PRODUCT_APPLINK_IPHONE_URL =
  206. "fb_product_applink_iphone_url";
  207. public static string EVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_STORE_ID =
  208. "fb_product_applink_iphone_app_store_id";
  209. public static string EVENT_PARAM_PRODUCT_APPLINK_IPHONE_APP_NAME =
  210. "fb_product_applink_iphone_app_name";
  211. public static string EVENT_PARAM_PRODUCT_APPLINK_IPAD_URL = "fb_product_applink_ipad_url";
  212. public static string EVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_STORE_ID =
  213. "fb_product_applink_ipad_app_store_id";
  214. public static string EVENT_PARAM_PRODUCT_APPLINK_IPAD_APP_NAME =
  215. "fb_product_applink_ipad_app_name";
  216. public static string EVENT_PARAM_PRODUCT_APPLINK_ANDROID_URL =
  217. "fb_product_applink_android_url";
  218. public static string EVENT_PARAM_PRODUCT_APPLINK_ANDROID_PACKAGE =
  219. "fb_product_applink_android_package";
  220. public static string EVENT_PARAM_PRODUCT_APPLINK_ANDROID_APP_NAME =
  221. "fb_product_applink_android_app_name";
  222. public static string EVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_URL =
  223. "fb_product_applink_windows_phone_url";
  224. public static string EVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_ID =
  225. "fb_product_applink_windows_phone_app_id";
  226. public static string EVENT_PARAM_PRODUCT_APPLINK_WINDOWS_PHONE_APP_NAME =
  227. "fb_product_applink_windows_phone_app_name";
  228. }
  229. }