Action events
In the graphic below you can see the part that is covered in this chapter:
A purple application technically consists of a native part and an experience part that runs within a web view.
The action events in this documentation are listed under the Native app or Experience subchapters based on the origin they occur.
The event name app_background is a reserved event on Firebase Analytics. You need to use a different event name if you use a custom tracking config.
Android / iOS: When the app is left via home button or home indicator.
Android / iOS: Bookmark was added via native action bar toggle or action URL.
Android / iOS: Bookmark was removed via native action bar toggle.
Android / iOS: When the user successfully performed the content share via * action bar button or one of the following action URLs * purple://app/share_app_or_issue * purple://app/share_app_or_issue_or_page when an issue is opened.
Android / iOS: When the app comes back to the foreground after being in the background, not during the initial app start.
Android / iOS: When the user performed the app share.
Android / iOS: When the app starts, not when it is brought back from the background.
Android / iOS: When the app stops (e.g. terminated by the system or user). Not when leaving the app using the home button/home gesture.
Android / iOS: Triggered content could not be opened, e.g. * for content.open failures or one of the following action URLs: * open issue by ID * open issue by alias * open issue by external ID
Triggered when an issue is opened inside the pager.
Triggered when a page of an issue is opened inside the pager.
Triggered when a preview of an issue is opened inside the pager.
Android: When the entitlement login failed via action URL: purple://kiosk/entitlement/login/perform iOS:
When the entitlement login failed (via any method).
Android: When the entitlement login succeded via action URL: purple://kiosk/entitlement/login/perform iOS: When the entitlement login was successful (via any method).
Android: This event does not exist. iOS: When restore purchases failed via: * action URL * JS API
Android: This event does not exist. iOS: When restore purchases succeeded via * action URL * JS API
Available for PDF issues only and needs content specific configuration.
Android: Every time a page becomes visible. iOS: Every time a page is shown (e.g. open, swipe between pages).
Android / iOS: When the table of contents popup is opened for a preview issue.
Android / iOS: When the table of contents popup is opened for an issue.
Android: When an URL or action URL is opened via storytelling open action. iOS: When an URL or action URL is opened via storytelling action (not limited to open) or action URL via webview navigation.
When content_type was deleted
- by user interaction or
- in case of content_type "issue" the native app mechanism "Automatic deletion of issues"
When a download of content_type was cancelled.
When a download of content_type failed.
When a download of content_type started.
When a download of content_type was successful.
When the bookmark button of a content_type is clicked. This event is only triggered if no bookmark exists for this content_type.
When adding a bookmark for a content_type failed.
When a bookmark was added successfully for a content_type.
When the bookmark delete button of a content_type is clicked.
When deleting a bookmark for a content_type failed.
When a bookmark of content_type was successfully deleted.
When the bookmark open button of a content_type is clicked.
When the coupon button of a content_type is clicked.
When the cover (the image) of a content_type is clicked.
When the login button of a content_type is clicked.
When the preview button of a content_type is clicked.
When the read button of a content_type is clicked.
When the search result cover (the image) of a content_type is clicked.
When the search result page hit of a content_type is clicked. Every page in search result contains the search term.
When the share button of a content_type is clicked.
When content_type sharing failed.
When a content_type was shared.
When the subscribe button of a content_type is clicked.
When an ad is clicked.
When a sticky ad is clicked.
When the back button in the app bar is clicked.
When the logo in the app bar is clicked.
When the menu button in the app bar is clicked.
When a delete all bookmarks button action is triggered.
When a delete all bookmarks action is finished.
When a delete all bookmarks action failed.
When a delete all bookmarks action is triggered for a specific issue.
When a delete all bookmarks action is finished for a specific issue.
When a delete all bookmark action failed for a specific issue.
When an external login process failed.
When an external login process is started.
When an external login process finished successfully.
When a HTML component is tapped for which a tap action is configured.
When an anchor/link is tapped which occurs in the content of an HTML component. Only tracked if the link target is opened in the in-app browser.
When an anchor/link is tapped which occurs in the content of an HTML component. Only tracked if the link target is opened in the external system browser.
When an anchor/link is tapped which occurs in the content of an HTML component. Only tracked if the link target is opened inline.
When the cancel (e.g. download) button of an issue is clicked.
When the delete button of an issue is clicked.
When the download button of an issue is clicked.
When the purchase of an issue was cancelled by the user.
When the purchase button of an issue is tapped.
When the purchase of an issue failed.
When an issue is purchased.
When the user tapped the login button.
When the login process failed (for example because of a wrong password).
When the user tapped on any link inside the login component.
When the user was logged in successfully.
When user tapped the logout button on the login component.
When the logout process failed.
When the user was logged out successfully.
When the popup is closed either through clicking the "x" button or through tapping the background.
When either getProducts or getPrices for the specified product id failed (This does include the case when the store products are not configured).
When a displayed content_type inside a publication is clicked.
When the user cancelled the publication-completion product purchase flow.
When an user taps on the purchase button to buy a publication-completion product.
When the started publication-completion product purchase flow failed because of an error.
When the publication-completion product was successfully purchased.
When the user tapped the register button.
When the restore purchases action was started (and, if confirm was set, the user confirmed the process).
When a search is performed.
When the user started the flow to subscribe (usually through tapping on a button).
When the user activated a subscription code.
When user tried to activate subscription code, but the code was already activated somewhere else.
When user tried to activate a subscription code but the code was invalid.
When user tried to activate a subscription code but was offline.
When the user deactivated a subscription code.
When the user tried to deactivate a subscription code but the operation failed due to given error.
When the user tried to deactivate a subscription code but was offline.
When the user tried to deactivate a subscription code but the operation failed with unknown error.
When a purchase failed and the ERROR_CODE is "CANCELLED".
When a purchase failed and the ERROR_CODE is not "CANCELLED".
When a subscription was successfully purchased.
When a subscription was successfully purchased and product is for a trial period.
When a content_type inside a swiper is clicked and the swiper config has "tapEntry" configured.
When an ad inside a swiper is clicked.
When a category inside a swiper is clicked.
When a publication inside a swiper is clicked.
When user clicked on an entry at the navigation bar.
The action event name is composed as follows: STOREFRONT_VIEW_${transformed_name_of_view} The full action event name is composed at runtime and the value of "name_of_view" is based on the view name field for the corresponding view in the views.json.
The value of name_of_view * will UPPERCASED and * hyphens are replaced with underscores.
Only the standard views are documented in this chapter. The event names can differ based on the configuration ("views.json") of the specific project.
The bookmark view is opened.
The feed view is opened.
The home view is opened.
The issue details view is opened.
The login view is opened.
The newsstand view is opened.
The search view is opened.
The subscriptions view is opened.