What are tag used for?

Purchasely has a tagging system to fetch information about the price and duration of subscriptions and one-time purchases, as well as the Introductory Offer (for user acquisition) and Promotional Offer (winback/retention) prices and durations.

Thanks to these tags, you don't have to hard code price for each and every stores in your screens and paywalls.

Using these tags will also ease to make your paywall compliant with the App Store Guidelines.

Where can you use tags?

Tags can be used in any label on a Screen. You can add them by simply clicking on the {{TAG}} button of the text field.

You can also directly type them in plain text. To do so, put the name of the tag between 2 pairs of curly brackets. Eg: {{PRICE}}

What are the options when using tags?

You can use 2 types of tags.

• Tags with no parameters refer to the Plan directly mapped with the parent element (eg: the picker to which the text belongs or the purchase button) or to the default Plan configured for this Screen.

  => This way, if you change the Plan associated with the button / picker (or run an Price A/B test), you won't need to update the tag.

• Tags with parameters are mapped with a specific Plan. They appear with the reference of the Plan selected between brackets. If you want to use them, simply select the desired Plan in the widget.

  

  They can be used to reference another Plan in a picker or button than the one which it is mapped with, or to associate a Plan which is not the default one.

Types of tags

General tags:

These tags are most common tags that used in all the paywalls.

Duration tags

These tags help you display the subscription duration in days, weeks , months and etc.

Subscription cost per duration tags

Perfect for showing equivalent cost breakdowns, useful when comparing plans.

Price & Percentage comparison tags

These tags comes handy for your to calculate percentage difference and the price difference between 2 different plans and show them automatically in the respective currency.

Offer tags

These tags can be used to display the price and duration of the both introductory/new user acquisition offers and Winback/retention offers you have created in the stores and declared in the Purchasely console.

Countdown tag

These set of tags are very useful to create dynamic countdowns. You can integrate them in any label of your Screen. 3 different types of Timers are offered:

• Relative countdown
• Absolute countdown
• User countdown

Timers are not only a simple tag but rather a set of tags composed of different sub-tags (TIMER(MONTHS), TIMER(DAYS), TIMER(MINUTES), TIMER(SECONDS)) that can be manipulated independently.

Depending on the format you associate to the Tag, they will appear in the text field with the following format:

They are actually a composition of several tags. In the case above:

• one for hours
• one for minutes
• one for seconds

By default, the tags are separated by colon (":"). You can replace the colons by any string you want directly in the text field:

For more information and capabilities about Countdowns. have a look at the Countdown component

User attribute tags

User attribute tags show the value of a Custom User Attribute in a label. Your app sends the value, and the Screen shows it. For example, use them to greet the user by name or to show a number of articles read.

Syntax

A user attribute tag uses the Liquid syntax:

{{ user.<attribute_key> | default: "<fallback>" | <filter> }}

• user.<attribute_key> is the key of the attribute, as declared in the User Attributes section of the Console.
• default is the text to show when the user does not have a value for this attribute.
• The filters are optional. They change the format of the value. You can chain them.

Examples:

Hello {{ user.firstname | default: "friend" | capitalize }}!

• If firstname is "julie", the device shows: Hello Julie!
• If firstname is not set, the device shows: Hello Friend!

You read {{ user.articles_read | default: "0" }} articles this month

• If articles_read is 12, the device shows: You read 12 articles this month

You can mix user attribute tags with the other tags in the same label, for example {{ user.firstname | default: "" }}, get 1 year for {{PRICE}}.

Add a user attribute tag in the Screen Composer

1. Select a text component. In the Text section, click the {{TAG}} button of the text field.

2. In the User attributes category, click USER_ATTRIBUTE. Type user in the search field to find it quickly.

   

3. PARAM 1: select the attribute. The list shows:

   • your Custom User Attributes of type String, Int, Float and Date,
   • the Insight Attributes of type String,
   • the start and renewal dates of the active subscription, and the dates of the expired subscription.

   To declare a new attribute, click Create new Custom User Attribute at the bottom of the list.
   

   

4. PARAM 2: type the default value. The Screen shows this value when the user does not have a value for the attribute. Click Next.
   

   

5. PARAM 3 (optional): click one or more formatters to add them to the chain. The Preview line shows the result with the default value.
   

   

6. Click Save to insert the tag with its formatters, or Skip to insert it without formatters.

The Console preview has no user, so it shows the default value.

Available formatters (filters)

The Composer shows only the formatters that apply to the type of the attribute.

Set the attribute in your app

The SDK reads the value from the user attributes of the device when it displays the Screen. Set the attribute before you display the Screen. If you change the value while the Screen is open, the label does not change.

Purchasely.setUserAttribute(withStringValue: "julie", forKey: "firstname")
Purchasely.setUserAttribute(withIntValue: 12, forKey: "articles_read")

Purchasely.setUserAttribute("firstname", "julie")
Purchasely.setUserAttribute("articles_read", 12)

Purchasely.setUserAttributeWithString('firstname', 'julie');
Purchasely.setUserAttributeWithNumber('articles_read', 12);

Purchasely.setUserAttributeWithString('firstname', 'julie');
Purchasely.setUserAttributeWithInt('articles_read', 12);

Purchasely.setUserAttributeWithString('firstname', 'julie');
Purchasely.setUserAttributeWithInt('articles_read', 12);

More information: Setting Custom User Attributes.