Placeholder

36min

Getting started
A purple application technically consists of a native app part and an experience part that runs within a web view. 
The placeholders in this documentation are listed under the Native app﻿ or Experience﻿ subchapters based on the origin they occur. In addition, event-specific placeholders are listed explicitly in the subchapters Event specific﻿.
Native app
Content
Parameter placeholder
Description
CONTENT_ID
The content id is composed of the issues publication id and issue id.
Value is based on this template:
<publication_id>/<issue_id>﻿
CONTENT_NAME
The content name comes from the name of the issue. 
Example for composing the value of CONTENT_ID:
If the 
puplication has the id "my_publication_id" and 
the issue has the id "my_issue_id" 
the result will be: 
"my_publication_id/my_issue_id"
Bookmark
Parameter placeholder
Description
BOOKMARK_SECTION
The section comes from the section within TOC.
BOOKMARK_TITLE
The bookmark title comes from the name of the issue. 
Issue
Parameter placeholder
Description
ISSUE_ID
The id of the issue.
ISSUE_NAME
The name of the issue.
All custom issue properties 
﻿
﻿
A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.
The key names are based on the custom property names. The custom property names are transformed before use. 
Key is based on this template:
PROPERTY_<transformed_name_of_custom_property>﻿
Transform is done as follows:
custom property name is converted to uppercase
hyphens are replaced with underscores
Example for custom property transformation:
If there is a custom property like this: 
"my-custom-issue-property" 
the transform finally leads to:
"PROPERTY_MY_CUSTOM_ISSUE_PROPERTY"
Page
Parameter placeholder
Description
PAGE_ALIAS
The alias of the page.
PAGE_ID
The id of the page.
PAGE_INDEX
The index of the page.
PAGE_LABEL
The label of the page.
PAGE_NUMBER
The number of the page.
PAGE_SECTION
The section of the page.
PAGE_TITLE
The title of the page.
Publication
Parameter placeholder
Description
PUBLICATION_ID
The id of the publication.
PUBLICATION_NAME
The name of the publication.
All custom publication properties
﻿
﻿
A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.
The key names are based on the custom property names. The custom property names are transformed before use. 
Key is based on this template:
PROPERTY_<transformed_name_of_custom_property>﻿
Transform is done as follows:
custom property name is converted to uppercase
hyphens are replaced with underscores
Example for custom property transformation:
If there is a custom property like this: 
"my-custom-publication-property" 
the transform finally leads to:
"PROPERTY_MY_CUSTOM_PUBLICATION_PROPERTY"
Experience
Bookmark
Parameter placeholder
Description
BOOKMARK_CREATION_DATE
The date the bookmark was created.
BOOKMARK_DESCRIPTION
The description of the bookmark. 
BOOKMARK_PAGE_LABEL
The page label of the referenced page from the issue.
BOOKMARK_TITLE
The title of the bookmark.
Custom bookmark data
A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.

The key names are based on the custom data names. The custom data names are transformed before use. 

Key is based on this template:
BOOKMARK_CUSTOM_DATA_<transformed_custom_data_name>

Transform is done as follows:
custom property name is converted to uppercase
hyphens are replaced with underscores
Example for custom property transformation:
If there is a custom property like this: 
"my-custom-bookmark-data-property" 
the transform finally leads to:
"BOOKMARK_CUSTOM_DATA_MY_CUSTOM_BOOKMARK_DATA_PROPERTY"
Category
Parameter placeholder
Description
CATEGORY_ID
The id of category.
CATEGORY_NAME
The name of category.
CATEGORY_PARENT_CATEGORY_ID
The id of the parent category.
All custom category properties
A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.

The key names are based on the custom property names. The custom property names are transformed before use. 

Key is based on this template:
CATEGORY_PROPERTY_<transformed_name_of_custom_property>

Transform is done as follows:
custom property name is converted to uppercase
hyphens are replaced with underscores
Example for custom property transformation:
If there is a custom property like this: 
"my-custom-category-property" 
the transform finally leads to:
"CATEGORY_PROPERTY_MY_CUSTOM_CATEGORY_PROPERTY"
Issue
Some events will not include the price. In that case the placeholders ISSUE_PRICE, ISSUE_PRICE_CURRENCY and ISSUE_PRICE_VALUE are not available.
Parameter placeholder
Description
ISSUE_ID
The id of the issue.
ISSUE_LATEST
Indicates whether the issue is the current one or not within its publication.
ISSUE_NAME
The name of the issue.
ISSUE_PRICE
Formatted price when the price is available.
ISSUE_PRICE_CURRENCY
Currency of price when the price is available.
ISSUE_PRICE_VALUE
Value of price when the price is available.
ISSUE_PRODUCT_ID
The product id to purchase that issue by single purchase.
ISSUE_PURCHASABLE
Indicates if that issue is purchasable.
ISSUE_PURCHASED
Indicates if that issue has already been purchased.
ISSUE_TYPE
The value of this field is "ISSUE".
All custom issue properties
A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.

The key names are based on the custom property names. The custom property names are transformed before use. 

Key is based on this template:
ISSUE_PROPERTY_<transformed_name_of_custom_property>

Transform is done as follows:
custom property name is converted to uppercase
hyphens are replaced with underscores
All source issue parameters
A list of parameter placeholders for the source issue. 
Source parameter is based on this template:
SOURCE_<issue_parameter>﻿
Example for custom property transformation:
If there is a custom property like this: 
"my-custom-issue-property" 
the transform finally leads to:
"ISSUE_PROPERTY_MY_CUSTOM_ISSUE_PROPERTY"
Product
Parameter placeholder
Description
PRODUCT_DESCRIPTION
The description of the product.
PRODUCT_HIDDEN
Indicates wether this product is hidden or not.
PRODUCT_ID
The id of the product.
PRODUCT_NAME
The name if the product.
PRODUCT_PRICE
The formatted price of the price.
PRODUCT_PRICE_CURRENCY
The currency of the price.
PRODUCT_PRICE_VALUE
The value of the price.
PRODUCT_PURCHASED
Indicates if the product is purchased by the user.
PRODUCT_TYPE
The type of the product.
All custom product properties
A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.

The key names are based on the custom property names. The custom property names are transformed before use. 

Key is based on this template:
PRODUCT_PROPERTY_<transformed_name_of_custom_property>

Transform is done as follows:
custom property name is converted to uppercase
hyphens are replaced with underscores
Example for custom property transformation:
If there is a custom property like this: 
"my-custom-product-property" 
the transform finally leads to:
"PRODUCT_PROPERTY_MY_CUSTOM_PRODUCT_PROPERTY"
Publication
Parameter placeholder
Description
PUBLICATION_ID
The id of the publication.
PUBLICATION_NAME
The name of the publication.
PUBLICATION_TYPE
The type of the publication.
All custom publication properties
A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.

The key names are based on the custom property names. The custom property names are transformed before use. 

Key is based on this template:
PUBLICATION_PROPERTY_<transformed_name_of_custom_property>

Transform is done as follows:
custom property name is converted to uppercase
hyphens are replaced with underscores
All parameters of the related source publication.
A list of parameter placeholders for the source publication. 

Source parameter is based on this template:
SOURCE_<publication_parameter>﻿
Example for custom property transformation:
If there is a custom property like this: 
"my-custom-publication-property" 
the transform finally leads to:
"PUBLICATION_PROPERTY_MY_CUSTOM_PRODUCT_PROPERTY"
Subscription
Parameter placeholder
Description
SUBSCRIPTION_DURATION
The duration of the subscription.
SUBSCRIPTION_ID
The id oft the subscription.
SUBSCRIPTION_NAME
The name of the subscription.
SUBSCRIPTION_PRICE
The formatted price of the price.
SUBSCRIPTION_PRICE_CURRENCY
The currency of the price.
SUBSCRIPTION_PRICE_VALUE
The value of the price.
SUBSCRIPTION_PRODUCT_ID
The product id of the subscription.
SUBSCRIPTION_PURCHASED
Indicates if the subscription is purchased by the user.
SUBSCRIPTION_TYPE
The type of the subscription.
All custom subscription properties
A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.

The key names are based on the custom property names. The custom property names are transformed before use. 

Key is based on this template:
SUBSCRIPTION_PROPERTY_<transformed_name_of_custom_property>

Transform is done as follows:
custom property name is converted to uppercase
hyphens are replaced with underscores
Example for custom property transformation:
If there is a custom property like this: 
"my-custom-subscription-property" 
the transform finally leads to:
"SUBSCRIPTION_PROPERTY_MY_CUSTOM_SUBSCRIPTION_PROPERTY"
content.open
Some events will provide these placeholders when the corresponding issue was opened by the javascript API "content.open".
Parameter placeholder
Description
ISSUE_CATEGORIES
The categories of the issue as comma separated list.
ISSUE_LATEST
Indicates whether the issue is the current one or not within its publication.
ISSUE_PRODUCT_ID
The product id to purchase that issue by single purchase.
ISSUE_PURCHASABLE
Indicates if that issue is purchasable.
ISSUE_PURCHASED
Indicates if that issue has already been purchased.
ISSUE_TAGS
The tags of the issue as comma separated list.
ISSUE_TYPE
The value of this field is "ISSUE".
PUBLICATION_TYPE
The type of the publication.
View context for action events
Parameter placeholder
Description
VIEW
The view name within the action event was triggered.
View context for view events
Parameter placeholder
Description
POPUP
Indicates whether the view was opened within a popup.
Possibles values are:
true or false
VIEW
The view name within the view event was triggered.
Event specific
CONTENT_OPEN_FAILED
Parameter placeholder
Description
ISSUE
Possible values are:
"<issueId>"
"alias/<alias>"
"external_id/<external_issue_id>"
PRESENTER_ARTICLE_VISIBILITY
Parameter placeholder
Description
ARTICLE_ID
The id of the article.
PERCENTAGE_IN_VIEW
The percentage in view for this article.
PRESENTER_CONTENT_URL_OPENED
Parameter placeholder
Description
URL
The value of the URL.
STOREFRONT_<content_type>_SEARCH_RESULT_PAGE_HIT_CLICKED
Parameter placeholder
Description
PAGE_INDEX
The index of the page.
PAGE_LABEL
The label of the page.
PAGE_NUMBER
The number of the page.
PAGE_TITLE
The title of the page.
STOREFRONT_HTML_LINK_OPEN_<action>
Actions are as follows:
﻿APP_BROWSER﻿
﻿EXTERNAL﻿
﻿INLINE﻿
Parameter placeholder
Description
LINK_TEXT
The text for the link.
TARGET_URL
The value of the URL.
STOREFRONT_LOGIN_LINK_CLICKED
Parameter placeholder
Description
TARGET_URL
The value of the URL.
STOREFRONT_POPUP_CLOSE_CLICKED
Parameter placeholder
Description
POPUP
Indicates if a view is shown within a popup or not.
STOREFRONT_PRODUCT_LOAD_FAILED
Parameter placeholder
Description
error
The error which occurs while loading product information.
productId
The product id.
STOREFRONT_SEARCH_PERFORMED
Parameter placeholder
Description
PHRASE
The phrase the user searched for.
STOREFRONT_SUBSCRIPTION_CODE_<action>
Actions are as follows:
﻿ACTIVATED﻿
﻿ACTIVATED_ERROR_EXISTS﻿
﻿ACTIVATED_ERROR_INVALID﻿
﻿ACTIVATED_ERROR_OFFLINE﻿
﻿DEACTIVATED﻿
﻿DEACTIVATED_ERROR﻿
﻿DEACTIVATED_ERROR_OFFLINE﻿
﻿DEACTIVATED_ERROR_UNKNOWN﻿
Parameter placeholder
Description
SUBSCRIPTION_CODE
The value of the subscription code.
STOREFRONT_TAB_NAVIGATION_CLICKED
Parameter placeholder
Description
ACTION
The type of the action of the tapped navigation entry. The value is based on the file "navigation.json".
TARGET
The path of the tapped navigation entry. The value is based on the file "navigation.json".
Placeholder for ad related events
Parameter placeholder
Description
AD_ID
The id of the ad.
Placeholder for purchase related events
Parameter placeholder
Description
CURRENCY_CODE
The locale based currency code (e.g. "USD").
PRICE
The price of the purchased product.
PRODUCT_ID
The related product id.
TRANSACTION_ID
The related transaction id from google play store or apple store.
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿
﻿

Parameter placeholder	Description
CONTENT_ID	The content id is composed of the issues publication id and issue id. Value is based on this template: <publication_id>/<issue_id>
CONTENT_NAME	The content name comes from the name of the issue.

Parameter placeholder	Description
BOOKMARK_SECTION	The section comes from the section within TOC.
BOOKMARK_TITLE	The bookmark title comes from the name of the issue.

Parameter placeholder	Description
ISSUE_ID	The id of the issue.
ISSUE_NAME	The name of the issue.
All custom issue properties	A list of key/value pairs. Key/value pairs with empty values are omitted for tracking. The key names are based on the custom property names. The custom property names are transformed before use. Key is based on this template: PROPERTY_<transformed_name_of_custom_property> Transform is done as follows: custom property name is converted to uppercase hyphens are replaced with underscores

Parameter placeholder	Description
PAGE_ALIAS	The alias of the page.
PAGE_ID	The id of the page.
PAGE_INDEX	The index of the page.
PAGE_LABEL	The label of the page.
PAGE_NUMBER	The number of the page.
PAGE_SECTION	The section of the page.
PAGE_TITLE	The title of the page.

Parameter placeholder	Description
PUBLICATION_ID	The id of the publication.
PUBLICATION_NAME	The name of the publication.
All custom publication properties	A list of key/value pairs. Key/value pairs with empty values are omitted for tracking. The key names are based on the custom property names. The custom property names are transformed before use. Key is based on this template: PROPERTY_<transformed_name_of_custom_property> Transform is done as follows: custom property name is converted to uppercase hyphens are replaced with underscores

Parameter placeholder	Description
BOOKMARK_CREATION_DATE	The date the bookmark was created.
BOOKMARK_DESCRIPTION	The description of the bookmark.
BOOKMARK_PAGE_LABEL	The page label of the referenced page from the issue.
BOOKMARK_TITLE	The title of the bookmark.
Custom bookmark data	A list of key/value pairs. Key/value pairs with empty values are omitted for tracking. The key names are based on the custom data names. The custom data names are transformed before use. Key is based on this template: BOOKMARK_CUSTOM_DATA_<transformed_custom_data_name> Transform is done as follows: custom property name is converted to uppercase hyphens are replaced with underscores

Parameter placeholder	Description
CATEGORY_ID	The id of category.
CATEGORY_NAME	The name of category.
CATEGORY_PARENT_CATEGORY_ID	The id of the parent category.
All custom category properties	A list of key/value pairs. Key/value pairs with empty values are omitted for tracking. The key names are based on the custom property names. The custom property names are transformed before use. Key is based on this template: CATEGORY_PROPERTY_<transformed_name_of_custom_property> Transform is done as follows: custom property name is converted to uppercase hyphens are replaced with underscores

Parameter placeholder	Description
ISSUE_ID	The id of the issue.
ISSUE_LATEST	Indicates whether the issue is the current one or not within its publication.
ISSUE_NAME	The name of the issue.
ISSUE_PRICE	Formatted price when the price is available.
ISSUE_PRICE_CURRENCY	Currency of price when the price is available.
ISSUE_PRICE_VALUE	Value of price when the price is available.
ISSUE_PRODUCT_ID	The product id to purchase that issue by single purchase.
ISSUE_PURCHASABLE	Indicates if that issue is purchasable.
ISSUE_PURCHASED	Indicates if that issue has already been purchased.
ISSUE_TYPE	The value of this field is "ISSUE".
All custom issue properties	A list of key/value pairs. Key/value pairs with empty values are omitted for tracking. The key names are based on the custom property names. The custom property names are transformed before use. Key is based on this template: ISSUE_PROPERTY_<transformed_name_of_custom_property> Transform is done as follows: custom property name is converted to uppercase hyphens are replaced with underscores
All source issue parameters	A list of parameter placeholders for the source issue. Source parameter is based on this template: SOURCE_<issue_parameter>

Parameter placeholder	Description
PRODUCT_DESCRIPTION	The description of the product.
PRODUCT_HIDDEN	Indicates wether this product is hidden or not.
PRODUCT_ID	The id of the product.
PRODUCT_NAME	The name if the product.
PRODUCT_PRICE	The formatted price of the price.
PRODUCT_PRICE_CURRENCY	The currency of the price.
PRODUCT_PRICE_VALUE	The value of the price.
PRODUCT_PURCHASED	Indicates if the product is purchased by the user.
PRODUCT_TYPE	The type of the product.
All custom product properties	A list of key/value pairs. Key/value pairs with empty values are omitted for tracking. The key names are based on the custom property names. The custom property names are transformed before use. Key is based on this template: PRODUCT_PROPERTY_<transformed_name_of_custom_property> Transform is done as follows: custom property name is converted to uppercase hyphens are replaced with underscores

Parameter placeholder	Description
PUBLICATION_ID	The id of the publication.
PUBLICATION_NAME	The name of the publication.
PUBLICATION_TYPE	The type of the publication.
All custom publication properties	A list of key/value pairs. Key/value pairs with empty values are omitted for tracking. The key names are based on the custom property names. The custom property names are transformed before use. Key is based on this template: PUBLICATION_PROPERTY_<transformed_name_of_custom_property> Transform is done as follows: custom property name is converted to uppercase hyphens are replaced with underscores
All parameters of the related source publication.	A list of parameter placeholders for the source publication. Source parameter is based on this template: SOURCE_<publication_parameter>

Parameter placeholder	Description
SUBSCRIPTION_DURATION	The duration of the subscription.
SUBSCRIPTION_ID	The id oft the subscription.
SUBSCRIPTION_NAME	The name of the subscription.
SUBSCRIPTION_PRICE	The formatted price of the price.
SUBSCRIPTION_PRICE_CURRENCY	The currency of the price.
SUBSCRIPTION_PRICE_VALUE	The value of the price.
SUBSCRIPTION_PRODUCT_ID	The product id of the subscription.
SUBSCRIPTION_PURCHASED	Indicates if the subscription is purchased by the user.
SUBSCRIPTION_TYPE	The type of the subscription.
All custom subscription properties	A list of key/value pairs. Key/value pairs with empty values are omitted for tracking. The key names are based on the custom property names. The custom property names are transformed before use. Key is based on this template: SUBSCRIPTION_PROPERTY_<transformed_name_of_custom_property> Transform is done as follows: custom property name is converted to uppercase hyphens are replaced with underscores

Parameter placeholder	Description
ISSUE_CATEGORIES	The categories of the issue as comma separated list.
ISSUE_LATEST	Indicates whether the issue is the current one or not within its publication.
ISSUE_PRODUCT_ID	The product id to purchase that issue by single purchase.
ISSUE_PURCHASABLE	Indicates if that issue is purchasable.
ISSUE_PURCHASED	Indicates if that issue has already been purchased.
ISSUE_TAGS	The tags of the issue as comma separated list.
ISSUE_TYPE	The value of this field is "ISSUE".
PUBLICATION_TYPE	The type of the publication.

Parameter placeholder	Description
VIEW	The view name within the action event was triggered.

Parameter placeholder	Description
POPUP	Indicates whether the view was opened within a popup. Possibles values are: true or false
VIEW	The view name within the view event was triggered.

Parameter placeholder	Description
ISSUE	Possible values are: "<issueId>" "alias/<alias>" "external_id/<external_issue_id>"

Parameter placeholder	Description
ARTICLE_ID	The id of the article.
PERCENTAGE_IN_VIEW	The percentage in view for this article.

Parameter placeholder	Description
URL	The value of the URL.

Parameter placeholder	Description
PAGE_INDEX	The index of the page.
PAGE_LABEL	The label of the page.
PAGE_NUMBER	The number of the page.
PAGE_TITLE	The title of the page.

Parameter placeholder	Description
LINK_TEXT	The text for the link.
TARGET_URL	The value of the URL.

Parameter placeholder	Description
TARGET_URL	The value of the URL.

Parameter placeholder	Description
POPUP	Indicates if a view is shown within a popup or not.

Parameter placeholder	Description
error	The error which occurs while loading product information.
productId	The product id.

Parameter placeholder	Description
PHRASE	The phrase the user searched for.

Parameter placeholder	Description
SUBSCRIPTION_CODE	The value of the subscription code.

Parameter placeholder	Description
ACTION	The type of the action of the tapped navigation entry. The value is based on the file "navigation.json".
TARGET	The path of the tapped navigation entry. The value is based on the file "navigation.json".

Parameter placeholder	Description
AD_ID	The id of the ad.

Parameter placeholder	Description
CURRENCY_CODE	The locale based currency code (e.g. "USD").
PRICE	The price of the purchased product.
PRODUCT_ID	The related product id.
TRANSACTION_ID	The related transaction id from google play store or apple store.

Updated 20 Oct 2023

Did this page help you?

Attributes

Content types