| commit | author | age | ||
| 2e29a3 | 1 | /* |
| L | 2 | * Copyright (c) Meta Platforms, Inc. and affiliates. |
| 3 | * All rights reserved. | |
| 4 | * | |
| 5 | * This source code is licensed under the license found in the | |
| 6 | * LICENSE file in the root directory of this source tree. | |
| 7 | */ | |
| 8 | ||
| 9 | #import <Foundation/Foundation.h> | |
| 10 | ||
| 11 | /** | |
| 12 | @methodgroup Predefined event name parameters for common additional information to accompany events logged through the `logEvent` family | |
| 13 | of methods on `FBSDKAppEvents`. Common event names are provided in the `FBAppEventName*` constants. | |
| 14 | */ | |
| 15 | ||
| 16 | /// typedef for FBSDKAppEventParameterName | |
| 17 | typedef NSString *FBSDKAppEventParameterName NS_TYPED_EXTENSIBLE_ENUM NS_SWIFT_NAME(AppEvents.ParameterName); | |
| 18 | ||
| 19 | /** | |
| 20 | * Parameter key used to specify data for the one or more pieces of content being logged about. | |
| 21 | * Data should be a JSON encoded string. | |
| 22 | * Example: | |
| 23 | * "[{\"id\": \"1234\", \"quantity\": 2, \"item_price\": 5.99}, {\"id\": \"5678\", \"quantity\": 1, \"item_price\": 9.99}]" | |
| 24 | */ | |
| 25 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameContent; | |
| 26 | ||
| e0ec42 | 27 | /// Parameter key used to specify an ID for the specific piece of content being logged about. Could be an EAN, article identifier, etc., depending on the nature of the app. |
| 2e29a3 | 28 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameContentID; |
| L | 29 | |
| e0ec42 | 30 | /// Parameter key used to specify a generic content type/family for the logged event, e.g. "music", "photo", "video". Options to use will vary based upon what the app is all about. |
| 2e29a3 | 31 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameContentType; |
| L | 32 | |
| e0ec42 | 33 | /// Parameter key used to specify currency used with logged event. E.g. "USD", "EUR", "GBP". See ISO-4217 for specific values. One reference for these is <http://en.wikipedia.org/wiki/ISO_4217>. |
| 2e29a3 | 34 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameCurrency; |
| L | 35 | |
| e0ec42 | 36 | /// Parameter key used to specify a description appropriate to the event being logged. E.g., the name of the achievement unlocked in the `FBAppEventNameAchievementUnlocked` event. |
| 2e29a3 | 37 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameDescription; |
| L | 38 | |
| e0ec42 | 39 | /// Parameter key used to specify the level achieved in a `FBAppEventNameAchieved` event. |
| 2e29a3 | 40 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameLevel; |
| L | 41 | |
| e0ec42 | 42 | /// Parameter key used to specify the maximum rating available for the `FBAppEventNameRate` event. E.g., "5" or "10". |
| 2e29a3 | 43 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameMaxRatingValue; |
| L | 44 | |
| e0ec42 | 45 | /// Parameter key used to specify how many items are being processed for an `FBAppEventNameInitiatedCheckout` or `FBAppEventNamePurchased` event. |
| 2e29a3 | 46 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameNumItems; |
| L | 47 | |
| e0ec42 | 48 | /// Parameter key used to specify whether payment info is available for the `FBAppEventNameInitiatedCheckout` event. `FBSDKAppEventParameterValueYes` and `FBSDKAppEventParameterValueNo` are good canonical values to use for this parameter. |
| 2e29a3 | 49 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNamePaymentInfoAvailable; |
| L | 50 | |
| e0ec42 | 51 | /// Parameter key used to specify method user has used to register for the app, e.g., "Facebook", "email", "Twitter", etc |
| 2e29a3 | 52 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameRegistrationMethod; |
| L | 53 | |
| e0ec42 | 54 | /// Parameter key used to specify the string provided by the user for a search operation. |
| 2e29a3 | 55 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameSearchString; |
| L | 56 | |
| e0ec42 | 57 | /// Parameter key used to specify whether the activity being logged about was successful or not. `FBSDKAppEventParameterValueYes` and `FBSDKAppEventParameterValueNo` are good canonical values to use for this parameter. |
| 2e29a3 | 58 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameSuccess; |
| L | 59 | |
| 60 | /** Parameter key used to specify the type of ad in an FBSDKAppEventNameAdImpression | |
| 61 | * or FBSDKAppEventNameAdClick event. | |
| 62 | * E.g. "banner", "interstitial", "rewarded_video", "native" */ | |
| 63 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameAdType; | |
| 64 | ||
| 65 | /** Parameter key used to specify the unique ID for all events within a subscription | |
| 66 | * in an FBSDKAppEventNameSubscribe or FBSDKAppEventNameStartTrial event. */ | |
| 67 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameOrderID; | |
| 68 | ||
| e0ec42 | 69 | /// Parameter key used to specify event name. |
| 2e29a3 | 70 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameEventName; |
| L | 71 | |
| e0ec42 | 72 | /// Parameter key used to specify event log time. |
| 2e29a3 | 73 | FOUNDATION_EXPORT FBSDKAppEventParameterName const FBSDKAppEventParameterNameLogTime; |
