Constants

The following constants are available globally.

  • Game achievement ID (NSString).

        NSDictionary *params = @{
          kFIRParameterAchievementID : @10_matches_won,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterAchievementID = @"achievement_id"
  • Ad Network Click ID (NSString). Used for network-specific click IDs which vary in format.

        NSDictionary *params = @{
          kFIRParameterAdNetworkClickID : @1234567,
          // ...
        };
    

    Declaration

    Objective-C

    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).

        NSDictionary *params = @{
          kFIRParameterCampaign : @winter_promotion,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterCampaign = @"campaign"
  • Character used in game (NSString).

        NSDictionary *params = @{
          kFIRParameterCharacter : @beat_boss,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterCharacter = @"character"
  • Campaign content (NSString).

    Declaration

    Objective-C

    static NSString *const kFIRParameterContent = @"content"
  • Type of content selected (NSString).

        NSDictionary *params = @{
          kFIRParameterContentType : @news article,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterContentType = @"content_type"
  • Coupon code for a purchasable item (NSString).

        NSDictionary *params = @{
          kFIRParameterCoupon : @zz123,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterCoupon = @"coupon"
  • Campaign custom parameter (NSString). Used as a method of capturing custom data in a campaign. Use varies by network.

        NSDictionary *params = @{
          kFIRParameterCP1 : @custom_data,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterCP1 = @"cp1"
  • Purchase currency in 3-letter ISO_4217 format (NSString).

        NSDictionary *params = @{
          kFIRParameterCurrency : @USD,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterCurrency = @"currency"
  • Flight or Travel destination (NSString).

        NSDictionary *params = @{
          kFIRParameterDestination : @Mountain View, CA,
          // ...
        };
    

    Declaration

    Objective-C

    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).

        NSDictionary *params = @{
          kFIRParameterEndDate : @2015-09-14,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterEndDate = @"end_date"
  • Flight number for travel events (NSString).

        NSDictionary *params = @{
          kFIRParameterFlightNumber : @ZZ800,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterFlightNumber = @"flight_number"
  • Group/clan/guild ID (NSString).

        NSDictionary *params = @{
          kFIRParameterGroupID : @g1,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterGroupID = @"group_id"
  • Item category (NSString).

        NSDictionary *params = @{
          kFIRParameterItemCategory : @t-shirts,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterItemCategory = @"item_category"
  • Item ID (NSString).

        NSDictionary *params = @{
          kFIRParameterItemID : @p7654,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterItemID = @"item_id"
  • The Google Place ID (NSString) that corresponds to the associated item. Alternatively, you can supply your own custom Location ID.

        NSDictionary *params = @{
          kFIRParameterItemLocationID : @ChIJiyj437sx3YAR9kUWC8QkLzQ,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterItemLocationID = @"item_location_id"
  • Item name (NSString).

        NSDictionary *params = @{
          kFIRParameterItemName : @abc,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterItemName = @"item_name"
  • Level in game (signed 64-bit integer as NSNumber).

        NSDictionary *params = @{
          kFIRParameterLevel : @(42),
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterLevel = @"level"
  • Location (NSString). The Google Place ID that corresponds to the associated event. Alternatively, you can supply your own custom Location ID.

        NSDictionary *params = @{
          kFIRParameterLocation : @ChIJiyj437sx3YAR9kUWC8QkLzQ,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterLocation = @"location"
  • The advertising or marketing medium, for example: cpc, banner, email, push. Highly recommended (NSString).

        NSDictionary *params = @{
          kFIRParameterMedium : @email,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterMedium = @"medium"
  • Number of nights staying at hotel (signed 64-bit integer as NSNumber).

        NSDictionary *params = @{
          kFIRParameterNumberOfNights : @(3),
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterNumberOfNights = @"number_of_nights"
  • Number of passengers traveling (signed 64-bit integer as NSNumber).

        NSDictionary *params = @{
          kFIRParameterNumberOfPassengers : @(11),
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterNumberOfPassengers = @"number_of_passengers"
  • Number of rooms for travel events (signed 64-bit integer as NSNumber).

        NSDictionary *params = @{
          kFIRParameterNumberOfRooms : @(2),
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterNumberOfRooms = @"number_of_rooms"
  • Flight or Travel origin (NSString).

        NSDictionary *params = @{
          kFIRParameterOrigin : @Mountain View, CA,
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterOrigin = @"origin"
  • Purchase price (double as NSNumber).

        NSDictionary *params = @{
          kFIRParameterPrice : @(1.0),
          kFIRParameterCurrency : @USD,  // e.g. $1.00 USD
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterPrice = @"price"
  • Purchase quantity (signed 64-bit integer as NSNumber).

        NSDictionary *params = @{
          kFIRParameterQuantity : @(1),
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterQuantity = @"quantity"
  • Score in game (signed 64-bit integer as NSNumber).

        NSDictionary *params = @{
          kFIRParameterScore : @(4200),
          // ...
        };
    

    Declaration

    Objective-C

    static NSString *const kFIRParameterScore = @"