Go to console

Modify behavior of Firebase In-App Messaging messages

With little to no coding effort, Firebase In-App Messaging allows you to create, configure and target rich user interactions, leveraging the capabilities of Google Analytics for Firebase and Predictions out of the box to tie messaging events to actual and predicted user activities and choices. With some additional Firebase In-App Messaging SDK integration, you can tailor the behavior of in-app messages even further, responding when users interact with messages, triggering message events outside the Analytics and Predictions frameworks, and allowing users to control sharing of their personal data related to messaging interactions.

Respond when users interact with in-app messages

With actions you can use your in-app messages to direct users to a website or a specific screen in your app.

Your code can respond to basic interactions (clicks and dismissals), to impressions (verified views of your messages), and to display errors logged and confirmed by the SDK. For example, when your message is composed as a Card modal, you might want to track and follow-up on which of two URLs the user clicked on the Card.

Implement a DisplayDelegate to handle Card interactions

You can register an in-app messaging display delegate that will be called whenever there is any interaction with an in-app message. To do this, implement a class per the InAppMessagingDisplayDelegate protocol and set it as the delegate property on the InAppMessaging instance.

Assuming again that you want to track which link a user clicked on a Card-style message, define a class that implements the messageClicked method per the DisplayDelegate protocol, thereby providing you access to the link clicked by the user.

Objective-C

Refer to the Objective-C display delegate reference for the set of callback methods that can be implemented and their parameters, including FIRInAppMessagingDisplayMessage.


// In CardActionFiamDelegate.h
@interface CardActionFiamDelegate : NSObject <FIRInAppMessagingDisplayDelegate>
@end

// In CardActionFiamDelegate.m
@implementation CardActionFiamDelegate

- (void)displayErrorForMessage:(nonnull FIRInAppMessagingDisplayMessage *)inAppMessage
                         error:(nonnull NSError *)error {
    // ...
}

- (void)impressionDetectedForMessage:(nonnull FIRInAppMessagingDisplayMessage *)inAppMessage {
    // ...
}

- (void)messageClicked:(nonnull FIRInAppMessagingDisplayMessage *)inAppMessage {
    // ...
}

- (void)messageDismissed:(nonnull FIRInAppMessagingDisplayMessage *)inAppMessage
             dismissType:(FIRInAppMessagingDismissType)dismissType {
    // ...
}

@end

// In AppDelegate.m
CardActionFiamDelegate *myFiamDelegate = [CardActionFiamDelegate new];
[FIRInAppMessaging inAppMessaging].delegate = myFiamDelegate;

Swift

Refer to the Swift display delegate reference for the set of callback methods that can be implemented and their parameters, including InAppMessagingAction.


// In CardActionFiamDelegate.swift
class CardActionFiamDelegate : NSObject, InAppMessagingDisplayDelegate {

    func messageClicked(_ inAppMessage: InAppMessagingDisplayMessage) {
        // ...
    }

    func messageDismissed(_ inAppMessage: InAppMessagingDisplayMessage,
                          dismissType: FIRInAppMessagingDismissType) {
        // ...
    }

    func impressionDetected(for inAppMessage: InAppMessagingDisplayMessage) {
        // ...
    }

    func displayError(for inAppMessage: InAppMessagingDisplayMessage, error: Error) {
        // ...
    }

}

// In AppDelegate.swift
// Register the delegate with the InAppMessaging instance
let myFiamDelegate = CardActionFiamDelegate()
InAppMessaging.inAppMessaging().delegate = myFiamDelegate;

Trigger in-app messages programmatically

Firebase In-App Messaging by default allows you to trigger in-app messages with Google Analytics for Firebase events, with no additional integration. You can also manually trigger events programmatically with the Firebase In-App Messaging SDK’s programmatic triggers.

In the In-App Messaging campaign composer, create a new campaign or select an existing campaign, and in the Scheduling step of the composer workflow, note the event ID of a newly-created or existing messaging event. Once noted, instrument your app to trigger the event by its ID.

Objective-C

…
// somewhere in the app's code
[[FIRInAppMessaging inAppMessaging] triggerEvent:@"exampleTrigger"];

Swift

…
// somewhere in the app's code
InAppMessaging.inAppMessaging().triggerEvent("exampleTrigger");

Temporarily disable in-app messages

By default, Firebase In-App Messaging renders messages whenever a triggering condition is satisfied, regardless of an app's current state. If you'd like to suppress message displays for any reason, for example to avoid interrupting a sequence of payment processing screens, use the SDK's messageDisplaySuppressed property as illustrated here in Objective-C:

  [FIRInAppMessaging inAppMessaging].messageDisplaySuppressed = YES;

Setting the property to YES prevents Firebase In-App Messaging from displaying messages, while NO reenables message display. The SDK resets the property to NO on app restart. Suppressed messages are ignored by the SDK. Their trigger conditions must be met again while suppression is off, before Firebase In-App Messaging can display them.

Enable opt-out message delivery

By default, Firebase In-App Messaging automatically delivers messages to all app users you target in messaging campaigns. To deliver those messages, the Firebase In-App Messaging SDK uses Firebase Instance IDs to identify each user's app. This means that In-App Messaging has to send client data, linked to the Instance ID, to Firebase servers. If you'd like to give users more control over the data they send, disable automatic data collection and give them a chance to approve data sharing.

To do that, you have to disable automatic initialization for Firebase In-App Messaging, and initialize the service manually for opt-in users:

  1. Turn off automatic initialization with a new key in your Info.plist file:

    • Key: FirebaseInAppMessagingAutomaticDataCollectionEnabled
    • Value: NO
  2. Initialize Firebase In-App Messaging for selected users manually:

    // Only needed if FirebaseInAppMessagingAutomaticDataCollectionEnabled is set to NO
    // in Info.plist
    [FIRInAppMessaging inAppMessaging].automaticDataCollectionEnabled = YES;
    
    

    Once you set automaticDataCollectionEnabled to YES, the value persists through app restarts, overriding the value in your Info.plist. If you'd like to disable initialization again, for example if a user opts out of collection later, set the property to NO.