Permission: Campaign entities
The native app message builder allows your organization to create and display messages for devices where you have built a native application. In this article, we will cover how to:
- Create native app message
- Navigate native app message builder
- Edit native app message
- Delete native app message
Note: The documentation for the code to include in your app can be found in our article Native App Messages - App setup. This is required to complete the setup.
Create native app message
Click Messages on the left-hand panel and select a regulatory regime (GDPR Messages or U.S. Privacy Messages)
Click Native App from the GDPR Messages menu or Native Messages from the U.S. Privacy Messages menu.
Use the property field in the upper right-hand corner to select a property for which you will create a native app message.
From the native app message page for the regulatory framework, click + New Message to create a new native app message.
In the following section we will provide a brief overview of how to navigate the native app message builder.
Navigate native app message builder
Set a name for your native message in the field, top-right corner:
The native app message builder is divided into four separate sections:
- Title
- Body
- Choice Options
- Additional Custom Fields
Each section offers your organization some customization on how the message will appear to the end-user. Your organization can choose the font, font size, font colour and background colour.
Note: Remember to click 'Save Message' after any changes to your native message.
Use the panel on the right-hand side of the builder to configure each section:
The 'Title' section allows you to set the title for your native message and choose the font, font size, font weight and colour of the text. The background colour of the title can be set.
Additional Custom Options
Additional custom options are key-value pairs the publisher or dev want to send to their app. The SDK will receive key-value pairs in the message JSON and pass along to the app, the app can take any action your organization's developer sees fit.
For example, a key-value pair for a title border color can be set by specifying a key as "borderColor" (or any name you choose) and the value as "#ff0000".
The 'Body' section allows you to provide information to persuade an end-user to grant consent for your native message. You can choose the font, font size, font weight and colour of the text, the background colour of the description can also be set.
Additional Custom Options
Additional custom options are key-value pairs the publisher or dev want to send to their app. The SDK will receive key-value pairs in the message JSON and pass along to the app, the app can take any action your organization's developer sees fit.
For example, a key-value pair for body border color can be set by specifying a key as "borderColor" (or any name you choose) and its value as "#ff0000".
The 'Choice Options' section allows you to set options for an end-user to accept and grant consent to all vendors, reject all vendors, open the privacy manager or dismiss your native message.
Select a choice option to configure then click 'Add'.
For each choice option the font, font size, font weight and colour can be set. Click on the choice option to open its settings.
Additional Custom Options
Additional custom options are key-value pairs the publisher or dev want to send to their app. The SDK will receive key-value pairs in the message JSON and pass along to the app, the app can take any action your organization's developer sees fit.
For example, a key-value pair for a specific choice option border color can be set by specifying a key as "borderColor" (or any name you choose) and its value as "#ff0000".
Previously for Title, Body & Choice Options sections the "Additional Custom Options" setting applies to a particular section. Additional Custom Fields however applies to the entire message.
Additional Custom Options
As described before, additional custom options are key-value pairs the publisher or dev want to send to their app. The SDK will receive key-value pairs in the message JSON and pass along to the app, the app can take any action your organization's developer sees fit.
For example, a key-value pair for background color can be set throughout the message. You could could choose a key name as "backgroundColor" and its value as "#ffffff". You can specify a key for the background image as "backgroundImg" and set its value to a url where the image is stored.
Click 'Save Message' once you have finished your configuring the choice option. Follow these steps again to choose and configure another choice option or click 'Close' to finish.
Edit native app message
To edit an existing native app message, navigate to a native app message and click the Edit icon inline with the native app message name.
Apply any edits to your native app message and click Save Message when finished.
Delete native app message
To delete an existing native app message, navigate to a native app message and click the Delete icon inline with the native app message name.
Confirm the decision to delete the app message and click Delete in the modal.
Comments
0 comments