---
title: Placeholder
slug: experience/placeholder
description: Learn about the structure of a purple application with this document. Discover how it is composed of a native app and a web view experience. Find detailed explanations and examples for various parameters like content ID, bookmark section, issue ID, and cu
docTags: 
createdAt: 2023-03-24T10:48:41.000Z
---

## Getting started

A purple application technically consists of a native app part and an experience part that runs within a web view.&#x20;

The placeholders in this documentation are listed under the [Native app](docId\:HWgaxh6bT5orBprp0V9VG) or [Experience](docId\:HWgaxh6bT5orBprp0V9VG) subchapters based on the origin they occur. In addition, event-specific placeholders are listed explicitly in the subchapters [Event specific](docId\:HWgaxh6bT5orBprp0V9VG).

## Native app

### Content

| **Parameter placeholder** | **Description**                                                                                                                                                                           |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CONTENT\_ID               | The content id is composed of the issues publication id and issue id.<br />Value is based on this template:<br /><font color="#3b9f0f">&lt;*publication_id*&gt;/&lt;*issue_id*&gt;</font> |
| CONTENT\_NAME             | The content name comes from the name of the issue.                                                                                                                                        |

:::hint{type="info"}
Example for composing the value of **CONTENT\_ID**:

If the&#x20;

- puplication has the id "<font color="#3b9f0f">**my_publication_id**</font>" and&#x20;
- the issue has the id "<font color="#3b9f0f">**my_issue_id**</font>"&#x20;

the result will be:&#x20;
"<font color="#3b9f0f">**my_publication_id/my_issue_id**</font>"
:::

### 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 <br /><br /> | A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.<br />The key names are based on the custom property names. The custom property names are transformed before use. <br />Key is based on this template:<br /><font color="#3b9f0f">PROPERTY_&lt;*transformed_name_of_custom_property*&gt;</font><br />Transform is done as follows:<br />1) custom property name is converted to **uppercase**
2) **hyphens** are replaced with **underscores** |

:::hint{type="info"}
Example for custom property transformation:

If there is a custom property like this:&#x20;
"**my-custom-issue-property**"&#x20;

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<br /><br /> | A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.<br />The key names are based on the custom property names. The custom property names are transformed before use. <br />Key is based on this template:<br /><font color="#3b9f0f">PROPERTY_&lt;*transformed_name_of_custom_property*&gt;</font><br />Transform is done as follows:<br />1) custom property name is converted to **uppercase**
2) **hyphens** are replaced with **underscores** |

:::hint{type="info"}
Example for custom property transformation:

If there is a custom property like this:&#x20;
"**my-custom-publication-property**"&#x20;

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.<br /><br />The key names are based on the custom data names. The custom data names are transformed before use.<br /><br />Key is based on this template:<br /><font color="#3b9f0f">BOOKMARK_CUSTOM_DATA_&lt;transformed_custom_data_name&gt;</font><br /><br />Transform is done as follows:<br />1) custom property name is converted to **uppercase**
2) **hyphens** are replaced with **underscores** |

:::hint{type="info"}
Example for custom property transformation:

If there is a custom property like this:&#x20;
"**my-custom-bookmark-data-property**"&#x20;

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.<br /><br />The key names are based on the custom property names. The custom property names are transformed before use.<br /><br />Key is based on this template:<br /><font color="#3b9f0f">CATEGORY_PROPERTY_&lt;transformed_name_of_custom_property&gt;</font><br /><br />Transform is done as follows:<br />1) custom property name is converted to **uppercase**
2) **hyphens** are replaced with **underscores** |

:::hint{type="info"}
Example for custom property transformation:

If there is a custom property like this:&#x20;
"**my-custom-category-property**"&#x20;

the transform finally leads to:
"**CATEGORY\_PROPERTY\_MY\_CUSTOM\_CATEGORY\_PROPERTY**"
:::

### Issue

:::hint{type="warning"}
Some events will not include the price. In that case the placeholders **ISSUE\_PRICE**, **ISSUE\_PRICE\_CURRENCY** and **ISSUE\_PRICE\_VALUE&#x20;**&#x61;re 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 "<font color="#3b9f0f">**ISSUE**</font>".                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| All custom issue properties | A list of key/value pairs. Key/value pairs with empty values are omitted for tracking.<br /><br />The key names are based on the custom property names. The custom property names are transformed before use.<br /><br />Key is based on this template:<br /><font color="#3b9f0f">ISSUE_PROPERTY_&lt;transformed_name_of_custom_property&gt;</font><br /><br />Transform is done as follows:<br />1) custom property name is converted to **uppercase**
2) **hyphens** are replaced with **underscores** |
| All source issue parameters | A list of parameter placeholders for the source issue. <br />Source parameter is based on this template:<br /><font color="#3b9f0f">SOURCE_&lt;issue_parameter&gt;</font>                                                                                                                                                                                                                                                                                                                                 |

:::hint{type="info"}
Example for custom property transformation:

If there is a custom property like this:&#x20;
"**my-custom-issue-property**"&#x20;

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.<br /><br />The key names are based on the custom property names. The custom property names are transformed before use.<br /><br />Key is based on this template:<br /><font color="#3b9f0f">PRODUCT_PROPERTY_&lt;transformed_name_of_custom_property&gt;</font><br /><br />Transform is done as follows:<br />1) custom property name is converted to **uppercase**
2) **hyphens** are replaced with **underscores** |

:::hint{type="info"}
Example for custom property transformation:

If there is a custom property like this:&#x20;
"**my-custom-product-property**"&#x20;

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.<br /><br />The key names are based on the custom property names. The custom property names are transformed before use.<br /><br />Key is based on this template:<br /><font color="#3b9f0f">PUBLICATION_PROPERTY_&lt;transformed_name_of_custom_property&gt;</font><br /><br />Transform is done as follows:<br />1) custom property name is converted to **uppercase**
2) **hyphens** are replaced with **underscores** |
| All parameters of the related source publication. | A list of parameter placeholders for the source publication.<br /><br />Source parameter is based on this template:<br /><font color="#3b9f0f">SOURCE_&lt;publication_parameter&gt;</font>                                                                                                                                                                                                                                                                                                                      |

:::hint{type="info"}
Example for custom property transformation:

If there is a custom property like this:&#x20;
"**my-custom-publication-property**"&#x20;

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.<br /><br />The key names are based on the custom property names. The custom property names are transformed before use.<br /><br />Key is based on this template:<br /><font color="#3b9f0f">SUBSCRIPTION_PROPERTY_&lt;transformed_name_of_custom_property&gt;</font><br /><br />Transform is done as follows:<br />1) custom property name is converted to **uppercase**
2) **hyphens** are replaced with **underscores** |

:::hint{type="info"}
Example for custom property transformation:

If there is a custom property like this:&#x20;
"**my-custom-subscription-property**"&#x20;

the transform finally leads to:
"**SUBSCRIPTION\_PROPERTY\_MY\_CUSTOM\_SUBSCRIPTION\_PROPERTY**"
:::

### content.open

:::hint{type="warning"}
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 "<font color="#3b9f0f">**ISSUE**</font>".          |
| 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.<br />Possibles values are:<br />**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:<br />1) "\<<font color="#3b9f0f">*issueId*</font>>"
2) "alias/\<<font color="#3b9f0f">*alias*</font>>"
3) "external\_id/\<<font color="#3b9f0f">*external_issue_id*</font>>" |

### 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**       |
| ------------------------- | --------------------- |
| TARGET\_URL               | The value of the URL. |

### STOREFRONT\_\<<font color="#3b9f0f">content_type</font>>\_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\_\<<font color="#3b9f0f">action</font>>

:::hint{type="info"}
Actions are as follows:

- <font color="#3b9f0f">APP_BROWSER</font>
- <font color="#3b9f0f">EXTERNAL</font>
- <font color="#3b9f0f">INLINE</font>
:::

| **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\_\<<font color="#3b9f0f">action</font>>

:::hint{type="info"}
Actions are as follows:

- <font color="#3b9f0f">ACTIVATED</font>
- <font color="#3b9f0f">ACTIVATED_ERROR_EXISTS</font>
- <font color="#3b9f0f">ACTIVATED_ERROR_INVALID</font>
- <font color="#3b9f0f">ACTIVATED_ERROR_OFFLINE</font>
- <font color="#3b9f0f">DEACTIVATED</font>
- <font color="#3b9f0f">DEACTIVATED_ERROR</font>
- <font color="#3b9f0f">DEACTIVATED_ERROR_OFFLINE</font>
- <font color="#3b9f0f">DEACTIVATED_ERROR_UNKNOWN</font>
:::

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

























