You've already forked Task-Master-2.0
mirror of
https://github.com/MrLyallCSIT/Task-Master-2.0.git
synced 2026-01-17 22:59:37 +00:00
370 lines
11 KiB
C
Executable File
370 lines
11 KiB
C
Executable File
/// @file FIRParameterNames.h
|
|
///
|
|
/// Predefined event parameter names.
|
|
///
|
|
/// Params supply information that contextualize Events. You can associate up to 25 unique Params
|
|
/// with each Event type. Some Params are suggested below for certain common Events, but you are
|
|
/// not limited to these. You may supply extra Params for suggested Events or custom Params for
|
|
/// Custom events. Param names can be up to 40 characters long, may only contain alphanumeric
|
|
/// characters and underscores ("_"), and must start with an alphabetic character. Param values can
|
|
/// be up to 100 characters long. The "firebase_" prefix is reserved and should not be used.
|
|
|
|
/// Game achievement ID (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterAchievementID : @"10_matches_won",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterAchievementID = @"achievement_id";
|
|
|
|
/// Ad Network Click ID (NSString). Used for network-specific click IDs which vary in format.
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterAdNetworkClickID : @"1234567",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterAdNetworkClickID = @"aclid";
|
|
|
|
/// The individual campaign name, slogan, promo code, etc. Some networks have pre-defined macro to
|
|
/// capture campaign information, otherwise can be populated by developer. Highly Recommended
|
|
/// (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterCampaign : @"winter_promotion",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterCampaign = @"campaign";
|
|
|
|
/// Character used in game (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterCharacter : @"beat_boss",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterCharacter = @"character";
|
|
|
|
/// Campaign content (NSString).
|
|
static NSString *const kFIRParameterContent = @"content";
|
|
|
|
/// Type of content selected (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterContentType : @"news article",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterContentType = @"content_type";
|
|
|
|
/// Coupon code for a purchasable item (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterCoupon : @"zz123",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterCoupon = @"coupon";
|
|
|
|
/// Campaign custom parameter (NSString). Used as a method of capturing custom data in a campaign.
|
|
/// Use varies by network.
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterCP1 : @"custom_data",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterCP1 = @"cp1";
|
|
|
|
/// Purchase currency in 3-letter <a href="http://en.wikipedia.org/wiki/ISO_4217#Active_codes">
|
|
/// ISO_4217</a> format (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterCurrency : @"USD",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterCurrency = @"currency";
|
|
|
|
/// Flight or Travel destination (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterDestination : @"Mountain View, CA",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterDestination = @"destination";
|
|
|
|
/// The arrival date, check-out date or rental end date for the item. This should be in
|
|
/// YYYY-MM-DD format (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterEndDate : @"2015-09-14",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterEndDate = @"end_date";
|
|
|
|
/// Flight number for travel events (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterFlightNumber : @"ZZ800",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterFlightNumber = @"flight_number";
|
|
|
|
/// Group/clan/guild ID (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterGroupID : @"g1",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterGroupID = @"group_id";
|
|
|
|
/// Item category (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterItemCategory : @"t-shirts",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterItemCategory = @"item_category";
|
|
|
|
/// Item ID (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterItemID : @"p7654",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterItemID = @"item_id";
|
|
|
|
/// The Google <a href="https://developers.google.com/places/place-id">Place ID</a> (NSString) that
|
|
/// corresponds to the associated item. Alternatively, you can supply your own custom Location ID.
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterItemLocationID : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterItemLocationID = @"item_location_id";
|
|
|
|
/// Item name (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterItemName : @"abc",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterItemName = @"item_name";
|
|
|
|
/// Level in game (signed 64-bit integer as NSNumber).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterLevel : @(42),
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterLevel = @"level";
|
|
|
|
/// Location (NSString). The Google <a href="https://developers.google.com/places/place-id">Place ID
|
|
/// </a> that corresponds to the associated event. Alternatively, you can supply your own custom
|
|
/// Location ID.
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterLocation : @"ChIJiyj437sx3YAR9kUWC8QkLzQ",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterLocation = @"location";
|
|
|
|
/// The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended
|
|
/// (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterMedium : @"email",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterMedium = @"medium";
|
|
|
|
/// Number of nights staying at hotel (signed 64-bit integer as NSNumber).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterNumberOfNights : @(3),
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterNumberOfNights = @"number_of_nights";
|
|
|
|
/// Number of passengers traveling (signed 64-bit integer as NSNumber).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterNumberOfPassengers : @(11),
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterNumberOfPassengers = @"number_of_passengers";
|
|
|
|
/// Number of rooms for travel events (signed 64-bit integer as NSNumber).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterNumberOfRooms : @(2),
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterNumberOfRooms = @"number_of_rooms";
|
|
|
|
/// Flight or Travel origin (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterOrigin : @"Mountain View, CA",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterOrigin = @"origin";
|
|
|
|
/// Purchase price (double as NSNumber).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterPrice : @(1.0),
|
|
/// kFIRParameterCurrency : @"USD", // e.g. $1.00 USD
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterPrice = @"price";
|
|
|
|
/// Purchase quantity (signed 64-bit integer as NSNumber).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterQuantity : @(1),
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterQuantity = @"quantity";
|
|
|
|
/// Score in game (signed 64-bit integer as NSNumber).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterScore : @(4200),
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterScore = @"score";
|
|
|
|
/// The search string/keywords used (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterSearchTerm : @"periodic table",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterSearchTerm = @"search_term";
|
|
|
|
/// Shipping cost (double as NSNumber).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterShipping : @(9.50),
|
|
/// kFIRParameterCurrency : @"USD", // e.g. $9.50 USD
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterShipping = @"shipping";
|
|
|
|
/// Sign up method (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterSignUpMethod : @"google",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterSignUpMethod = @"sign_up_method";
|
|
|
|
/// The origin of your traffic, such as an Ad network (for example, google) or partner (urban
|
|
/// airship). Identify the advertiser, site, publication, etc. that is sending traffic to your
|
|
/// property. Highly recommended (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterSource : @"InMobi",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterSource = @"source";
|
|
|
|
/// The departure date, check-in date or rental start date for the item. This should be in
|
|
/// YYYY-MM-DD format (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterStartDate : @"2015-09-14",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterStartDate = @"start_date";
|
|
|
|
/// Tax amount (double as NSNumber).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterTax : @(1.0),
|
|
/// kFIRParameterCurrency : @"USD", // e.g. $1.00 USD
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterTax = @"tax";
|
|
|
|
/// If you're manually tagging keyword campaigns, you should use utm_term to specify the keyword
|
|
/// (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterTerm : @"game",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterTerm = @"term";
|
|
|
|
/// A single ID for a ecommerce group transaction (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterTransactionID : @"ab7236dd9823",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterTransactionID = @"transaction_id";
|
|
|
|
/// Travel class (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterTravelClass : @"business",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterTravelClass = @"travel_class";
|
|
|
|
/// A context-specific numeric value which is accumulated automatically for each event type. This is
|
|
/// a general purpose parameter that is useful for accumulating a key metric that pertains to an
|
|
/// event. Examples include revenue, distance, time and points. Value should be specified as signed
|
|
/// 64-bit integer or double as NSNumber. Notes: Values for pre-defined currency-related events
|
|
/// (such as @c kFIREventAddToCart) should be supplied using double as NSNumber and must be
|
|
/// accompanied by a @c kFIRParameterCurrency parameter. The valid range of accumulated values is
|
|
/// [-9,223,372,036,854.77, 9,223,372,036,854.77].
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterValue : @(3.99),
|
|
/// kFIRParameterCurrency : @"USD", // e.g. $3.99 USD
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterValue = @"value";
|
|
|
|
/// Name of virtual currency type (NSString).
|
|
/// <pre>
|
|
/// NSDictionary *params = @{
|
|
/// kFIRParameterVirtualCurrencyName : @"virtual_currency_name",
|
|
/// // ...
|
|
/// };
|
|
/// </pre>
|
|
static NSString *const kFIRParameterVirtualCurrencyName = @"virtual_currency_name";
|