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.
No placeholders available.
"APP_BACKGROUND": {
"templates": {
"action": "app_background"
}
}
Android / iOS:
Bookmark was added via native action bar toggle or action URL.
"APP_BOOKMARK_ADDED": {
"templates": {
"action": "app_bookmark_added"
},
"parameters": {
"content_id": "{{CONTENT_ID}}",
"content_name": "{{CONTENT_ID}}",
"bookmark_section": "{{BOOKMARK_SECTION}}",
"bookmark_title": "{{BOOKMARK_TITLE}}"
}
}
Android / iOS:
Bookmark was removed via native action bar toggle.
"APP_BOOKMARK_DELETED": {
"templates": {
"action": "app_bookmark_deleted"
},
"parameters": {
"content_id": "{{CONTENT_ID}}",
"content_name": "{{CONTENT_ID}}",
"bookmark_section": "{{BOOKMARK_SECTION}}",
"bookmark_title": "{{BOOKMARK_TITLE}}"
}
}
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.
"APP_CONTENT_SHARED": {
"templates": {
"action": "app_content_shared"
},
"parameters": {
"content_id": "{{CONTENT_ID}}",
"content_name": "{{CONTENT_NAME}}"
}
}
Android / iOS:
When the app comes back to the foreground after being in the background, not during the initial app start.
No placeholders available.
"APP_FOREGROUND": {
"templates": {
"action": "app_foreground"
}
}
Android / iOS:
When the user performed the app share.
No placeholders available.
"APP_SHARED": {
"templates": {
"action": "app_shared"
}
}
Android / iOS:
When the app starts, not when it is brought back from the background.
No placeholders available.
"APP_START": {
"templates": {
"action": "app_start"
}
}
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.
No placeholders available.
"APP_STOP": {
"templates": {
"action": "app_stop"
}
}
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
"CONTENT_OPEN_FAILED": {
"templates": {
"action": "content_open_failed"
},
"parameters": {
"issue_id": "{{ISSUE}}"
}
}
Triggered when an issue is opened inside the pager.
"ISSUE_OPENED": {
"templates": {
"action": "issue_opened"
},
"parameters": {
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
Triggered when a page of an issue is opened inside the pager.
"ISSUE_PAGE_OPENED": {
"templates": {
"action": "issue_page_opened"
},
"parameters": {
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}",
"page_id": "{{PAGE_ID}}",
"page_index": "{{PAGE_INDEX}}",
"page_alias": "{{PAGE_ALIAS}}",
"page_label": "{{PAGE_LABEL}}",
"page_number": "{{PAGE_NUMBER}}",
"page_title": "{{PAGE_TITLE}}",
"page_section": "{{PAGE_SECTION}}"
}
}
Triggered when a preview of an issue is opened inside the pager.
"ISSUE_PREVIEW_OPENED": {
"templates": {
"action": "issue_preview_opened"
},
"parameters": {
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
KIOSK_PURCHASE_RESTORATION_FAILED
Android:
This event does not exist.
iOS:
When restore purchases failed via:
* action URL
* JS API
No placeholders available.
"KIOSK_PURCHASE_RESTORATION_FAILED": {
"templates": {
"action": "kiosk_purchase_restoration_failed"
}
}
Android:
This event does not exist.
iOS:
When restore purchases succeeded via
* action URL
* JS API
No placeholders available.
"KIOSK_PURCHASES_RESTORED": {
"templates": {
"action": "kiosk_purchases_restored"
}
}
PRESENTER_ARTICLE_VISIBILITY
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).
"PRESENTER_ARTICLE_VISIBILITY": {
"templates": {
"action": "article_in_view"
},
"parameters": {
"ARTICLE_ID": "{{ARTICLE_ID}}",
"PERCENTAGE_IN_VIEW": "{{PERCENTAGE_IN_VIEW}}"
}
}
PRESENTER_CONTENT_PREVIEW_TOC_OPENED
Android / iOS:
When the table of contents popup is opened for a preview issue.
"PRESENTER_CONTENT_PREVIEW_TOC_OPENED": {
"templates": {
"action": "presenter_content_preview_toc_opened"
},
"parameters": {
"content_id": "{{CONTENT_ID}}",
"content_name": "{{CONTENT_NAME}}"
}
}
PRESENTER_CONTENT_TOC_OPENED
Android / iOS:
When the table of contents popup is opened for an issue.
"PRESENTER_CONTENT_TOC_OPENED": {
"templates": {
"action": "presenter_content_toc_opened"
},
"parameters": {
"content_id": "{{CONTENT_ID}}",
"content_name": "{{CONTENT_NAME}}"
}
}
PRESENTER_CONTENT_URL_OPENED
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.
"PRESENTER_CONTENT_URL_OPENED": {
"templates": {
"action": "presenter_content_url_opened"
},
"parameters": {
"url": "{{URL}}"
}
}
When content_type was deleted
- in case of content_type "issue" the native app mechanism "Automatic deletion of issues"
"ISSUE_DELETED": {
"templates": {
"action": "issue_deleted"
},
"parameters": {
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
When a download of content_type was cancelled.
"ISSUE_DOWNLOAD_CANCELLED": {
"templates": {
"action": "issue_download_cancelled"
},
"parameters": {
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
When a download of content_type failed.
"ISSUE_DOWNLOAD_FAILED": {
"templates": {
"action": "issue_download_failed"
},
"parameters": {
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
When a download of content_type started.
"ISSUE_DOWNLOAD_STARTED": {
"templates": {
"action": "issue_download_started"
},
"parameters": {
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
When a download of content_type was successful.
"ISSUE_DOWNLOADED": {
"templates": {
"action": "issue_downloaded"
},
"parameters": {
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_BOOKMARK_ADD_CLICKED
When the bookmark button of a content_type is clicked. This event is only triggered if no bookmark exists for this content_type.
"STOREFRONT_ISSUE_BOOKMARK_ADD_CLICKED": {
"templates": {
"action": "issue_bookmark_add_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_BOOKMARK_ADD_FAILED
When adding a bookmark for a content_type failed.
"STOREFRONT_ISSUE_BOOKMARK_ADD_FAILED": {
"templates": {
"action": "issue_bookmark_add_failed"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_BOOKMARK_ADDED
When a bookmark was added successfully for a content_type.
"STOREFRONT_ISSUE_BOOKMARK_ADDED": {
"templates": {
"action": "issue_bookmark_added"
},
"parameters": {
"view": "{{VIEW}}",
"bookmark_title": "{{BOOKMARK_TITLE}}",
"bookmark_description": "{{BOOKMARK_DESCRIPTION}}",
"bookmark_page_label": "{{BOOKMARK_PAGE_LABEL}}",
"bookmark_creation_date": "{{BOOKMARK_CREATION_DATE}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_BOOKMARK_DELETE_CLICKED
When the bookmark delete button of a content_type is clicked.
"STOREFRONT_ISSUE_BOOKMARK_DELETE_CLICKED": {
"templates": {
"action": "issue_bookmark_delete_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"bookmark_title": "{{BOOKMARK_TITLE}}",
"bookmark_description": "{{BOOKMARK_DESCRIPTION}}",
"bookmark_page_label": "{{BOOKMARK_PAGE_LABEL}}",
"bookmark_creation_date": "{{BOOKMARK_CREATION_DATE}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_BOOKMARK_DELETE_FAILED
When deleting a bookmark for a content_type failed.
"STOREFRONT_ISSUE_BOOKMARK_DELETE_FAILED": {
"templates": {
"action": "issue_bookmark_delete_failed"
},
"parameters": {
"view": "{{VIEW}}",
"bookmark_title": "{{BOOKMARK_TITLE}}",
"bookmark_description": "{{BOOKMARK_DESCRIPTION}}",
"bookmark_page_label": "{{BOOKMARK_PAGE_LABEL}}",
"bookmark_creation_date": "{{BOOKMARK_CREATION_DATE}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_BOOKMARK_DELETED
When a bookmark of content_type was successfully deleted.
"STOREFRONT_ISSUE_BOOKMARK_DELETED": {
"templates": {
"action": "issue_bookmark_deleted"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_BOOKMARK_OPEN_CLICKED
When the bookmark open button of a content_type is clicked.
"STOREFRONT_ISSUE_BOOKMARK_OPEN_CLICKED": {
"templates": {
"action": "issue_bookmark_open_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"bookmark_title": "{{BOOKMARK_TITLE}}",
"bookmark_description": "{{BOOKMARK_DESCRIPTION}}",
"bookmark_page_label": "{{BOOKMARK_PAGE_LABEL}}",
"bookmark_creation_date": "{{BOOKMARK_CREATION_DATE}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_COUPON_CLICKED
When the coupon button of a content_type is clicked.
"STOREFRONT_ISSUE_COUPON_CLICKED": {
"templates": {
"action": "issue_coupon_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_COVER_CLICKED
When the cover (the image) of a content_type is clicked.
"STOREFRONT_ISSUE_COVER_CLICKED": {
"templates": {
"action": "issue_cover_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_LOGIN_CLICKED
When the login button of a content_type is clicked.
"STOREFRONT_ISSUE_LOGIN_CLICKED": {
"templates": {
"action": "issue_login_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_PREVIEW_CLICKED
When the preview button of a content_type is clicked.
"STOREFRONT_ISSUE_PREVIEW_CLICKED": {
"templates": {
"action": "issue_preview_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_READ_CLICKED
When the read button of a content_type is clicked.
"STOREFRONT_ISSUE_READ_CLICKED": {
"templates": {
"action": "issue_read_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_SEARCH_RESULT_COVER_CLICKED
When the search result cover (the image) of a content_type is clicked.
"STOREFRONT_ISSUE_SEARCH_RESULT_COVER_CLICKED": {
"templates": {
"action": "issue_search_result_cover_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_SEARCH_RESULT_PAGE_HIT_CLICKED
When the search result page hit of a content_type is clicked. Every page in search result contains the search term.
"STOREFRONT_ISSUE_SEARCH_RESULT_PAGE_HIT_CLICKED": {
"templates": {
"action": "issue_search_result_page_hit_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}",
"page_index": "{{PAGE_INDEX}}"
}
}
STOREFRONT_<content_type>_SHARE_CLICKED
When the share button of a content_type is clicked.
"STOREFRONT_ISSUE_SHARE_CLICKED": {
"templates": {
"action": "issue_share_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_SHARE_FAILED
When content_type sharing failed.
"STOREFRONT_ISSUE_SHARE_FAILED": {
"templates": {
"action": "issue_share_failed"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_SHARED
When a content_type was shared.
"STOREFRONT_ISSUE_SHARED": {
"templates": {
"action": "issue_shared"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_<content_type>_SUBSCRIBE_CLICKED
When the subscribe button of a content_type is clicked.
"STOREFRONT_ISSUE_SUBSCRIBE_CLICKED": {
"templates": {
"action": "issue_subscribe_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
"STOREFRONT_AD_CLICKED": {
"templates": {
"action": "ad_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"ad_id": "{{AD_ID}}"
}
}
STOREFRONT_AD_STICKY_CLICKED
When a sticky ad is clicked.
"STOREFRONT_AD_STICKY_CLICKED": {
"templates": {
"action": "ad_sticky_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"ad_id": "{{AD_ID}}"
}
}
STOREFRONT_APP_BAR_BACK_CLICKED
When the back button in the app bar or the toolbar action back is clicked.
"STOREFRONT_APP_BAR_BACK_CLICKED": {
"templates": {
"action": "app_bar_back_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_APP_BAR_BOOKMARK_ADD_CLICKED
When the toolbar action bookmark is clicked and no bookmark exists for the current content yet.
"STOREFRONT_APP_BAR_BOOKMARK_ADD_CLICKED": {
"templates": {
"action": "app_bar_bookmark_add_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_APP_BAR_BOOKMARK_ADD_FAILED
When adding a bookmark via the toolbar action bookmark failed.
"STOREFRONT_APP_BAR_BOOKMARK_ADD_FAILED": {
"templates": {
"action": "app_bar_bookmark_add_failed"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_APP_BAR_BOOKMARK_ADDED
When a bookmark was added successfully via the toolbar action bookmark.
"STOREFRONT_APP_BAR_BOOKMARK_ADDED": {
"templates": {
"action": "app_bar_bookmark_added"
},
"parameters": {
"view": "{{VIEW}}",
"bookmark_title": "{{BOOKMARK_TITLE}}",
"bookmark_description": "{{BOOKMARK_DESCRIPTION}}",
"bookmark_page_label": "{{BOOKMARK_PAGE_LABEL}}",
"bookmark_creation_date": "{{BOOKMARK_CREATION_DATE}}"
}
}
STOREFRONT_APP_BAR_BOOKMARK_DELETE_CLICKED
When the toolbar action bookmark is clicked and a bookmark exists for the current content. With bookmark.deleteConfirm, the event is sent once the dialog is confirmed; canceling sends nothing.
"STOREFRONT_APP_BAR_BOOKMARK_DELETE_CLICKED": {
"templates": {
"action": "app_bar_bookmark_delete_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"bookmark_title": "{{BOOKMARK_TITLE}}",
"bookmark_description": "{{BOOKMARK_DESCRIPTION}}",
"bookmark_page_label": "{{BOOKMARK_PAGE_LABEL}}",
"bookmark_creation_date": "{{BOOKMARK_CREATION_DATE}}"
}
}
STOREFRONT_APP_BAR_BOOKMARK_DELETE_FAILED
When deleting a bookmark via the toolbar action bookmark failed.
"STOREFRONT_APP_BAR_BOOKMARK_DELETE_FAILED": {
"templates": {
"action": "app_bar_bookmark_delete_failed"
},
"parameters": {
"view": "{{VIEW}}",
"bookmark_title": "{{BOOKMARK_TITLE}}",
"bookmark_description": "{{BOOKMARK_DESCRIPTION}}",
"bookmark_page_label": "{{BOOKMARK_PAGE_LABEL}}",
"bookmark_creation_date": "{{BOOKMARK_CREATION_DATE}}"
}
}
STOREFRONT_APP_BAR_BOOKMARK_DELETED
When a bookmark was deleted successfully via the toolbar action bookmark. Carries the deleted bookmark.
"STOREFRONT_APP_BAR_BOOKMARK_DELETED": {
"templates": {
"action": "app_bar_bookmark_deleted"
},
"parameters": {
"view": "{{VIEW}}",
"bookmark_title": "{{BOOKMARK_TITLE}}",
"bookmark_description": "{{BOOKMARK_DESCRIPTION}}",
"bookmark_page_label": "{{BOOKMARK_PAGE_LABEL}}",
"bookmark_creation_date": "{{BOOKMARK_CREATION_DATE}}"
}
}
STOREFRONT_APP_BAR_CLOSE_CLICKED
When the toolbar action close is clicked.
"STOREFRONT_APP_BAR_CLOSE_CLICKED": {
"templates": {
"action": "app_bar_close_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_APP_BAR_LOGO_CLICKED
When the logo in the app bar is clicked.
"STOREFRONT_APP_BAR_LOGO_CLICKED": {
"templates": {
"action": "app_bar_logo_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
When the menu button in the app bar or the toolbar action menu is clicked.
"STOREFRONT_APP_BAR_MENU_CLICKED": {
"templates": {
"action": "app_bar_menu_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_APP_BAR_PDF_DOWNLOAD_CLICKED
When the complete PDF of the presenter's issue is requested: a click on the toolbar action pdf, or on "Download full PDF" of the toolbar action pdf_dropdown. The browser handles the download itself, so the event means the user asked for the file, not that it arrived. A PDF download click does not send APP_STOP.
"STOREFRONT_APP_BAR_PDF_DOWNLOAD_CLICKED": {
"templates": {
"action": "app_bar_pdf_download_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}",
"download_type": "{{DOWNLOAD_TYPE}}",
"source": "{{SOURCE}}"
}
}
STOREFRONT_APP_BAR_PDF_PAGE_DOWNLOAD_CLICKED
When a single page of the presenter's issue is requested via a page entry of the toolbar action pdf_dropdown. A PDF download click does not send APP_STOP.
"STOREFRONT_APP_BAR_PDF_PAGE_DOWNLOAD_CLICKED": {
"templates": {
"action": "app_bar_pdf_page_download_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}",
"download_type": "{{DOWNLOAD_TYPE}}",
"source": "{{SOURCE}}",
"page_number": "{{PAGE_NUMBER}}",
"page_position": "{{PAGE_POSITION}}"
}
}
STOREFRONT_APP_BAR_TOC_CLICKED
When the toolbar action toc is clicked (opening and closing the table of contents).
"STOREFRONT_APP_BAR_TOC_CLICKED": {
"templates": {
"action": "app_bar_toc_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_APP_BAR_TTS_CLICKED
When the toolbar action tts is clicked (opening and closing the text-to-speech player).
"STOREFRONT_APP_BAR_TTS_CLICKED": {
"templates": {
"action": "app_bar_tts_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_BOOKMARK_DELETE_ALL_CLICKED
When a delete all bookmarks button action is triggered.
"STOREFRONT_BOOKMARK_DELETE_ALL_CLICKED": {
"templates": {
"action": "bookmark_delete_all_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_BOOKMARK_DELETED_ALL
When a delete all bookmarks action is finished.
"STOREFRONT_BOOKMARK_DELETED_ALL": {
"templates": {
"action": "bookmark_deleted_all"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_BOOKMARK_DELETE_ALL_FAILED
When a delete all bookmarks action failed.
"STOREFRONT_BOOKMARK_DELETE_ALL_FAILED": {
"templates": {
"action": "bookmark_delete_all_failed"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_BOOKMARK_DELETE_ALL_OF_ISSUE_CLICKED
When a delete all bookmarks action is triggered for a specific issue.
"STOREFRONT_BOOKMARK_DELETE_ALL_OF_ISSUE_CLICKED": {
"templates": {
"action": "bookmark_delete_all_of_issue_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_type": "{{ISSUE_TYPE}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}"
}
}
STOREFRONT_BOOKMARK_DELETED_ALL_OF_ISSUE
When a delete all bookmarks action is finished for a specific issue.
"STOREFRONT_BOOKMARK_DELETED_ALL_OF_ISSUE": {
"templates": {
"action": "bookmark_deleted_all_of_issue"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_type": "{{ISSUE_TYPE}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}"
}
}
STOREFRONT_BOOKMARK_DELETE_ALL_OF_ISSUE_FAILED
When a delete all bookmark action failed for a specific issue.
"STOREFRONT_BOOKMARK_DELETE_ALL_OF_ISSUE_FAILED": {
"templates": {
"action": "bookmark_delete_all_of_issue_failed"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_type": "{{ISSUE_TYPE}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}"
}
}
STOREFRONT_EXTERNAL_LOGIN_CANCELLED
When an external login process failed.
"STOREFRONT_EXTERNAL_LOGIN_CANCELLED": {
"templates": {
"action": "external_login_cancelled"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_EXTERNAL_LOGIN_CLICKED
When an external login process is started.
"STOREFRONT_EXTERNAL_LOGIN_CLICKED": {
"templates": {
"action": "external_login_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_EXTERNAL_LOGIN_SUCCEEDED
When an external login process finished successfully.
"STOREFRONT_EXTERNAL_LOGIN_SUCCEEDED": {
"templates": {
"action": "external_login_succeeded"
},
"parameters": {
"view": "{{VIEW}}"
}
}
When a HTML component is tapped for which a tap action is configured.
"STOREFRONT_HTML_CLICKED": {
"templates": {
"action": "html_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_HTML_LINK_OPEN_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 in-app browser.
"STOREFRONT_HTML_LINK_OPEN_APP_BROWSER": {
"templates": {
"action": "html_link_open_app_browser"
},
"parameters": {
"link_text": "{{LINK_TEXT}}",
"target_url": "{{TARGET_URL}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_HTML_LINK_OPEN_EXTERNAL
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.
"STOREFRONT_HTML_LINK_OPEN_APP_BROWSER": {
"templates": {
"action": "html_link_open_app_browser"
},
"parameters": {
"link_text": "{{LINK_TEXT}}",
"target_url": "{{TARGET_URL}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_HTML_LINK_OPEN_INLINE
When an anchor/link is tapped which occurs in the content of an HTML component. Only tracked if the link target is opened inline.
"STOREFRONT_HTML_LINK_OPEN_INLINE": {
"templates": {
"action": "html_link_open_inline"
},
"parameters": {
"link_text": "{{LINK_TEXT}}",
"target_url": "{{TARGET_URL}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_ISSUE_CANCEL_CLICKED
When the cancel (e.g. download) button of an issue is clicked.
"STOREFRONT_ISSUE_CANCEL_CLICKED": {
"templates": {
"action": "issue_cancel_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_ISSUE_DELETE_CLICKED
When the delete button of an issue is clicked.
"STOREFRONT_ISSUE_DELETE_CLICKED": {
"templates": {
"action": "issue_delete_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_ISSUE_DOWNLOAD_CLICKED
When the download button of an issue is clicked.
"STOREFRONT_ISSUE_DOWNLOAD_CLICKED": {
"templates": {
"action": "issue_download_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_ISSUE_PURCHASE_CANCELLED
When the purchase of an issue was cancelled by the user.
"STOREFRONT_ISSUE_PURCHASE_CANCELLED": {
"templates": {
"action": "issue_purchase_cancelled"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_type": "{{ISSUE_TYPE}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"issue_price": "{{ISSUE_PRICE_VALUE}}",
"issue_price_currency": "{{ISSUE_PRICE_CURRENCY}}",
"issue_price_formatted": "{{ISSUE_PRICE}}",
"issue_latest": "{{ISSUE_LATEST}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}",
"publication_type": "{{PUBLICATION_TYPE}}"
}
}
STOREFRONT_ISSUE_PURCHASE_CLICKED
When the purchase button of an issue is tapped.
"STOREFRONT_ISSUE_PURCHASE_CLICKED": {
"templates": {
"action": "issue_purchase_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_type": "{{ISSUE_TYPE}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"issue_price": "{{ISSUE_PRICE_VALUE}}",
"issue_price_currency": "{{ISSUE_PRICE_CURRENCY}}",
"issue_price_formatted": "{{ISSUE_PRICE}}",
"issue_latest": "{{ISSUE_LATEST}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}",
"publication_type": "{{PUBLICATION_TYPE}}"
}
}
STOREFRONT_ISSUE_PURCHASE_FAILED
When the purchase of an issue failed.
"STOREFRONT_ISSUE_PURCHASE_FAILED": {
"templates": {
"action": "issue_purchase_failed"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_type": "{{ISSUE_TYPE}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"issue_price": "{{ISSUE_PRICE_VALUE}}",
"issue_price_currency": "{{ISSUE_PRICE_CURRENCY}}",
"issue_price_formatted": "{{ISSUE_PRICE}}",
"issue_latest": "{{ISSUE_LATEST}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}",
"publication_type": "{{PUBLICATION_TYPE}}"
}
}
STOREFRONT_ISSUE_PURCHASED
When an issue is purchased.
"STOREFRONT_ISSUE_PURCHASED": {
"templates": {
"action": "issue_purchased"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_type": "{{ISSUE_TYPE}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"issue_price": "{{ISSUE_PRICE_VALUE}}",
"issue_price_currency": "{{ISSUE_PRICE_CURRENCY}}",
"issue_price_formatted": "{{ISSUE_PRICE}}",
"issue_latest": "{{ISSUE_LATEST}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}",
"publication_type": "{{PUBLICATION_TYPE}}"
}
}
When the user tapped a list
"STOREFRONT_LIST_CLICKED": {
"templates": {
"action": "list_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
When the user tapped the login button.
"STOREFRONT_LOGIN_CLICKED": {
"templates": {
"action": "login_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
When the login process failed (for example because of a wrong password).
"STOREFRONT_LOGIN_FAILED": {
"templates": {
"action": "login_failed"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_LOGIN_LINK_CLICKED
When the user tapped on any link inside the login component.
"STOREFRONT_LOGIN_LINK_CLICKED": {
"templates": {
"action": "login_link_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"target_url": "{{TARGET_URL}}"
}
}
STOREFRONT_LOGIN_SUCCEEDED
When the user was logged in successfully.
"STOREFRONT_LOGIN_SUCCEEDED": {
"templates": {
"action": "login_succeeded"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_LOGOUT_CLICKED
When user tapped the logout button on the login component.
"STOREFRONT_LOGOUT_CLICKED": {
"templates": {
"action": "logout_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
When the logout process failed.
"STOREFRONT_LOGOUT_FAILED": {
"templates": {
"action": "logout_failed"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_LOGOUT_SUCCEEDED
When the user was logged out successfully.
"STOREFRONT_LOGOUT_SUCCEEDED": {
"templates": {
"action": "logout_succeeded"
},
"parameters": {
"view": "{{VIEW}}"
}
}
When the popup is closed either through clicking the "x" button or through tapping the background.
"STOREFRONT_POPUP_CLOSE_CLICKED": {
"templates": {
"action": "popup_close_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"popup": "{{POPUP}}"
}
}
STOREFRONT_PRODUCT_LOAD_FAILED
When either getProducts or getPrices for the specified product id failed (This does include the case when the store products are not configured).
"STOREFRONT_PRODUCT_LOAD_FAILED": {
"templates": {
"action": "product_load_failed"
},
"parameters": {
"view": "{{VIEW}}"
"error": "{{error}}"
"productId": "{{productId}}"
}
}
STOREFRONT_PUBLICATION_<content_type>_CLICKED
When a displayed content_type inside a publication is clicked.
"STOREFRONT_PUBLICATION_ISSUE_CLICKED": {
"templates": {
"action": "publication_issue_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_PUBLICATION_COMPLETION_PURCHASE_CANCELLED
When the user cancelled the publication-completion product purchase flow.
"STOREFRONT_PUBLICATION_COMPLETION_PURCHASE_CANCELLED": {
"templates": {
"action": "pub_completion_purchase_cancelled"
},
"parameters": {
"view": "{{VIEW}}",
"product_id": "{{PRODUCT_ID}}",
"product_name": "{{PRODUCT_NAME}}",
"product_type": "{{PRODUCT_TYPE}}",
"product_description": "{{PRODUCT_DESCRIPTION}}",
"product_hidden": "{{PRODUCT_HIDDEN}}",
"product_price": "{{PRODUCT_PRICE_VALUE}}",
"product_price_currency": "{{PRODUCT_PRICE_CURRENCY}}",
"product_price_formatted": "{{PRODUCT_PRICE}}",
"product_purchased": "{{PRODUCT_PURCHASED}}"
}
}
STOREFRONT_PUBLICATION_COMPLETION_PURCHASE_CLICKED
When an user taps on the purchase button to buy a publication-completion product.
"STOREFRONT_PUBLICATION_COMPLETION_PURCHASE_CLICKED": {
"templates": {
"action": "publication_completion_purchase_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"product_id": "{{PRODUCT_ID}}",
"product_name": "{{PRODUCT_NAME}}",
"product_type": "{{PRODUCT_TYPE}}",
"product_description": "{{PRODUCT_DESCRIPTION}}",
"product_hidden": "{{PRODUCT_HIDDEN}}",
"product_price": "{{PRODUCT_PRICE_VALUE}}",
"product_price_currency": "{{PRODUCT_PRICE_CURRENCY}}",
"product_price_formatted": "{{PRODUCT_PRICE}}",
"product_purchased": "{{PRODUCT_PURCHASED}}"
}
}
STOREFRONT_PUBLICATION_COMPLETION_PURCHASE_FAILED
When the started publication-completion product purchase flow failed because of an error.
"STOREFRONT_PUBLICATION_COMPLETION_PURCHASE_FAILED": {
"templates": {
"action": "publication_completion_purchase_failed"
},
"parameters": {
"view": "{{VIEW}}",
"product_id": "{{PRODUCT_ID}}",
"product_name": "{{PRODUCT_NAME}}",
"product_type": "{{PRODUCT_TYPE}}",
"product_description": "{{PRODUCT_DESCRIPTION}}",
"product_hidden": "{{PRODUCT_HIDDEN}}",
"product_price": "{{PRODUCT_PRICE_VALUE}}",
"product_price_currency": "{{PRODUCT_PRICE_CURRENCY}}",
"product_price_formatted": "{{PRODUCT_PRICE}}",
"product_purchased": "{{PRODUCT_PURCHASED}}"
}
}
STOREFRONT_PUBLICATION_COMPLETION_PURCHASED
When the publication-completion product was successfully purchased.
"STOREFRONT_PUBLICATION_COMPLETION_PURCHASED": {
"templates": {
"action": "publication_completion_purchased"
},
"parameters": {
"view": "{{VIEW}}",
"product_id": "{{PRODUCT_ID}}",
"product_name": "{{PRODUCT_NAME}}",
"product_type": "{{PRODUCT_TYPE}}",
"product_description": "{{PRODUCT_DESCRIPTION}}",
"product_hidden": "{{PRODUCT_HIDDEN}}",
"product_price": "{{PRODUCT_PRICE_VALUE}}",
"product_price_currency": "{{PRODUCT_PRICE_CURRENCY}}",
"product_price_formatted": "{{PRODUCT_PRICE}}",
"product_purchased": "{{PRODUCT_PURCHASED}}"
}
}
STOREFRONT_REGISTER_CLICKED
When the user tapped the register button.
"STOREFRONT_REGISTER_CLICKED": {
"templates": {
"action": "register_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_RESTORE_PURCHASES_CLICKED
When the restore purchases action was started (and, if confirm was set, the user confirmed the process).
"STOREFRONT_RESTORE_PURCHASES_CLICKED": {
"templates": {
"action": "restore_purchases_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
When a search is performed.
"STOREFRONT_SEARCH_PERFORMED": {
"templates": {
"action": "search_performed"
},
"parameters": {
"view": "{{VIEW}}",
"phrase": "{{PHRASE}}"
}
}
STOREFRONT_SECTION_CLICKED
When the user tapped a section
"STOREFRONT_SECTION_CLICKED": {
"templates": {
"action": "list_clicked"
},
"parameters": {
"view": "{{VIEW}}"
}
}
STOREFRONT_SUBSCRIPTION_CLICKED
When the user started the flow to subscribe (usually through tapping on a button).
"STOREFRONT_SUBSCRIPTION_CLICKED": {
"templates": {
"action": "subscription_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"subscription_id": "{{SUBSCRIPTION_ID}}",
"subscription_name": "{{SUBSCRIPTION_NAME}}",
"subscription_type": "{{SUBSCRIPTION_TYPE}}",
"subscription_duration": "{{SUBSCRIPTION_DURATION}}",
"subscription_product_id": "{{SUBSCRIPTION_PRODUCT_ID}}",
"subscription_price": "{{SUBSCRIPTION_PRICE_VALUE}}",
"subscription_price_currency": "{{SUBSCRIPTION_PRICE_CURRENCY}}",
"subscription_price_formatted": "{{SUBSCRIPTION_PRICE}}",
"subscription_purchased": "{{SUBSCRIPTION_PURCHASED}}"
}
}
STOREFRONT_SUBSCRIPTION_CODE_ACTIVATED
When the user activated a subscription code.
"STOREFRONT_SUBSCRIPTION_CODE_ACTIVATED": {
"templates": {
"action": "sub_code_activated"
},
"parameters": {
"subscription_code": "{{SUBSCRIPTION_CODE}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_SUBSCRIPTION_CODE_ACTIVATED_ERROR_EXISTS
When user tried to activate subscription code, but the code was already activated somewhere else.
"STOREFRONT_SUBSCRIPTION_CODE_ACTIVATED_ERROR_EXISTS": {
"templates": {
"action": "sub_code_activated_error_exists"
},
"parameters": {
"subscription_code": "{{SUBSCRIPTION_CODE}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_SUBSCRIPTION_CODE_ACTIVATED_ERROR_INVALID
When user tried to activate a subscription code but the code was invalid.
"STOREFRONT_SUBSCRIPTION_CODE_ACTIVATED_ERROR_INVALID": {
"templates": {
"action": "sub_code_activated_error_invalid"
},
"parameters": {
"subscription_code": "{{SUBSCRIPTION_CODE}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_SUBSCRIPTION_CODE_ACTIVATED_ERROR_OFFLINE
When user tried to activate a subscription code but was offline.
"STOREFRONT_SUBSCRIPTION_CODE_ACTIVATED_ERROR_OFFLINE": {
"templates": {
"action": "sub_code_activated_error_offline"
},
"parameters": {
"subscription_code": "{{SUBSCRIPTION_CODE}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_SUBSCRIPTION_CODE_DEACTIVATED
When the user deactivated a subscription code.
"STOREFRONT_SUBSCRIPTION_CODE_DEACTIVATED": {
"templates": {
"action": "sub_code_deactivated"
},
"parameters": {
"subscription_code": "{{SUBSCRIPTION_CODE}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_SUBSCRIPTION_CODE_DEACTIVATED_ERROR
When the user tried to deactivate a subscription code but the operation failed due to given error.
"STOREFRONT_SUBSCRIPTION_CODE_DEACTIVATED_ERROR": {
"templates": {
"action": "sub_code_deactivated_error"
},
"parameters": {
"subscription_code": "{{SUBSCRIPTION_CODE}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_SUBSCRIPTION_CODE_DEACTIVATED_ERROR_OFFLINE
When the user tried to deactivate a subscription code but was offline.
"STOREFRONT_SUBSCRIPTION_CODE_DEACTIVATED_ERROR_OFFLINE": {
"templates": {
"action": "sub_code_deactivated_error_offline"
},
"parameters": {
"subscription_code": "{{SUBSCRIPTION_CODE}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_SUBSCRIPTION_CODE_DEACTIVATED_ERROR_UNKNOWN
When the user tried to deactivate a subscription code but the operation failed with unknown error.
"STOREFRONT_SUBSCRIPTION_CODE_DEACTIVATED_ERROR_UNKNOWN": {
"templates": {
"action": "sub_code_deactivated_error_unknown"
},
"parameters": {
"subscription_code": "{{SUBSCRIPTION_CODE}}",
"view": "{{VIEW}}"
}
}
STOREFRONT_SUBSCRIPTION_PURCHASE_CANCELLED
When a purchase failed and the ERROR_CODE is "CANCELLED".
"STOREFRONT_SUBSCRIPTION_PURCHASE_CANCELLED": {
"templates": {
"action": "subscription_purchase_cancelled"
},
"parameters": {
"view": "{{VIEW}}",
"subscription_id": "{{SUBSCRIPTION_ID}}",
"subscription_name": "{{SUBSCRIPTION_NAME}}",
"subscription_type": "{{SUBSCRIPTION_TYPE}}",
"subscription_duration": "{{SUBSCRIPTION_DURATION}}",
"subscription_product_id": "{{SUBSCRIPTION_PRODUCT_ID}}",
"subscription_price": "{{SUBSCRIPTION_PRICE_VALUE}}",
"subscription_price_currency": "{{SUBSCRIPTION_PRICE_CURRENCY}}",
"subscription_price_formatted": "{{SUBSCRIPTION_PRICE}}",
"subscription_purchased": "{{SUBSCRIPTION_PURCHASED}}"
}
}
STOREFRONT_SUBSCRIPTION_PURCHASE_FAILED
When a purchase failed and the ERROR_CODE is not "CANCELLED".
"STOREFRONT_SUBSCRIPTION_PURCHASE_FAILED": {
"templates": {
"action": "subscription_purchase_failed"
},
"parameters": {
"view": "{{VIEW}}",
"subscription_id": "{{SUBSCRIPTION_ID}}",
"subscription_name": "{{SUBSCRIPTION_NAME}}",
"subscription_type": "{{SUBSCRIPTION_TYPE}}",
"subscription_duration": "{{SUBSCRIPTION_DURATION}}",
"subscription_product_id": "{{SUBSCRIPTION_PRODUCT_ID}}",
"subscription_price": "{{SUBSCRIPTION_PRICE_VALUE}}",
"subscription_price_currency": "{{SUBSCRIPTION_PRICE_CURRENCY}}",
"subscription_price_formatted": "{{SUBSCRIPTION_PRICE}}",
"subscription_purchased": "{{SUBSCRIPTION_PURCHASED}}"
}
}
STOREFRONT_SUBSCRIPTION_PURCHASED
When a subscription was successfully purchased.
"STOREFRONT_SUBSCRIPTION_PURCHASED": {
"templates": {
"action": "subscription_purchased"
},
"parameters": {
"view": "{{VIEW}}",
"subscription_id": "{{SUBSCRIPTION_ID}}",
"subscription_name": "{{SUBSCRIPTION_NAME}}",
"subscription_type": "{{SUBSCRIPTION_TYPE}}",
"subscription_duration": "{{SUBSCRIPTION_DURATION}}",
"subscription_product_id": "{{SUBSCRIPTION_PRODUCT_ID}}",
"subscription_price": "{{SUBSCRIPTION_PRICE_VALUE}}",
"subscription_price_currency": "{{SUBSCRIPTION_PRICE_CURRENCY}}",
"subscription_price_formatted": "{{SUBSCRIPTION_PRICE}}",
"subscription_purchased": "{{SUBSCRIPTION_PURCHASED}}"
}
}
STOREFRONT_SUBSCRIPTION_TRIAL_PURCHASED
When a subscription was successfully purchased and product is for a trial period.
"STOREFRONT_SUBSCRIPTION_TRIAL_PURCHASED": {
"templates": {
"action": "subscription_trial_purchased"
},
"parameters": {
"view": "{{VIEW}}",
"subscription_id": "{{SUBSCRIPTION_ID}}",
"subscription_name": "{{SUBSCRIPTION_NAME}}",
"subscription_type": "{{SUBSCRIPTION_TYPE}}",
"subscription_duration": "{{SUBSCRIPTION_DURATION}}",
"subscription_product_id": "{{SUBSCRIPTION_PRODUCT_ID}}",
"subscription_price": "{{SUBSCRIPTION_PRICE_VALUE}}",
"subscription_price_currency": "{{SUBSCRIPTION_PRICE_CURRENCY}}",
"subscription_price_formatted": "{{SUBSCRIPTION_PRICE}}",
"subscription_purchased": "{{SUBSCRIPTION_PURCHASED}}"
}
}
STOREFRONT_SWIPER_<content_type>_CLICKED
When a content_type inside a swiper is clicked and the swiper config has "tapEntry" configured.
"STOREFRONT_SWIPER_ISSUE_CLICKED": {
"templates": {
"action": "swiper_issue_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"issue_id": "{{ISSUE_ID}}",
"issue_name": "{{ISSUE_NAME}}",
"issue_categories": "{{ISSUE_CATEGORIES}}",
"issue_tags": "{{ISSUE_TAGS}}",
"issue_purchasable": "{{ISSUE_PURCHASABLE}}",
"issue_purchased": "{{ISSUE_PURCHASED}}",
"issue_product_id": "{{ISSUE_PRODUCT_ID}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_SWIPER_AD_CLICKED
When an ad inside a swiper is clicked.
"STOREFRONT_SWIPER_AD_CLICKED": {
"templates": {
"action": "swiper_ad_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"ad_id": "{{AD_ID}}"
}
}
STOREFRONT_SWIPER_CATEGORY_CLICKED
When a category inside a swiper is clicked.
"STOREFRONT_SWIPER_CATEGORY_CLICKED": {
"templates": {
"action": "swiper_category_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"ad_id": "{{AD_ID}}",
"category_id": "{{CATEGORY_ID}}",
"category_name": "{{CATEGORY_NAME}}"
}
}
STOREFRONT_SWIPER_PUBLICATION_CLICKED
When a publication inside a swiper is clicked.
"STOREFRONT_SWIPER_PUBLICATION_CLICKED": {
"templates": {
"action": "swiper_publication_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"publication_id": "{{PUBLICATION_ID}}",
"publication_name": "{{PUBLICATION_NAME}}"
}
}
STOREFRONT_TAB_NAVIGATION_CLICKED
When user clicked on an entry at the navigation bar.
"STOREFRONT_TAB_NAVIGATION_CLICKED": {
"templates": {
"action": "tab_navigation_clicked"
},
"parameters": {
"view": "{{VIEW}}",
"target": "{{TARGET}}",
"action": "{{ACTION}}"
}
}
Experience - Dynamic composed action events based on views.json
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.
STOREFRONT_VIEW_BOOKMARKS
The bookmark view is opened.
"STOREFRONT_VIEW_BOOKMARKS": {
"templates": {
"action": "view_bookmarks"
},
"parameters": {
"view": "{{VIEW}}",
"popup": "{{POPUP}}"
}
}
"STOREFRONT_VIEW_FEED": {
"templates": {
"action": "view_feed"
},
"parameters": {
"view": "{{VIEW}}",
"popup": "{{POPUP}}"
}
}
"STOREFRONT_VIEW_HOME": {
"templates": {
"action": "view_home"
},
"parameters": {
"view": "{{VIEW}}",
"popup": "{{POPUP}}"
}
}
STOREFRONT_VIEW_ISSUE_DETAILS
The issue details view is opened.
"STOREFRONT_VIEW_ISSUE_DETAILS": {
"templates": {
"action": "view_issue_details"
},
"parameters": {
"view": "{{VIEW}}",
"popup": "{{POPUP}}"
}
}
The login view is opened.
"STOREFRONT_VIEW_LOGIN": {
"templates": {
"action": "view_login"
},
"parameters": {
"view": "{{VIEW}}",
"popup": "{{POPUP}}"
}
}
STOREFRONT_VIEW_NEWSSTAND
The newsstand view is opened.
"STOREFRONT_VIEW_NEWSSTAND": {
"templates": {
"action": "view_newsstand"
},
"parameters": {
"view": "{{VIEW}}",
"popup": "{{POPUP}}"
}
}
The search view is opened.
"STOREFRONT_VIEW_SEARCH": {
"templates": {
"action": "view_search"
},
"parameters": {
"view": "{{VIEW}}",
"popup": "{{POPUP}}"
}
}
STOREFRONT_VIEW_SUBSCRIPTIONS
The subscriptions view is opened.
"STOREFRONT_VIEW_SUBSCRIPTIONS": {
"templates": {
"action": "view_subscriptions"
},
"parameters": {
"view": "{{VIEW}}",
"popup": "{{POPUP}}"
}
}
