Import Campaign messaging content

This section will help you understand how to import campaign messaging content while creating a campaign. This would be useful when you want to create a campaign with multiple locale and variations. 

Before arriving at the Import option, create a general Push campaign. On MoEngage dashboard, click on Create Campaign > General Push 

mceclip0.png

Fill all the details on Segmentation page (Step 1 of Campaign Creation) and click Next. For more details on filling this section, refer the help section here

Here is a step by step guide for creating a campaign using Import feature.

  1. Import Campaign
  2. Download Template
  3. Template Overview
  4. Important Guidelines
  5. Input values in the Excel
  6. Upload the template
  7. Preview Grid

Import Campaign

In the Messaging page (Step 2 of Campaign Creation), click on Import Campaign button

mceclip2.png

Download Template

Choose the locales and number of variations from the respective dropdowns and click on Download. 

mceclip4.png

The Choose Locales dropdown will show the list of locales configured for your account. Once you have chosen all the locales, these locales will be shown for a quick reference. You can dismiss any locale directly from here. A default locale will be auto-selected and is not removable. The campaign always assumes 1 default locale even when no locale is selected.

For variations, you can choose the number of variations you wish to add in your campaign. 

Note: You can check the list of configured locales on Settings >> App Settings >> Locale Settings. If you want to add a new locale, you can do that on Locale Settings page and it will reflect in the Choose Locales dropdown in Import Campaign dialog. 

Template Overview

On clicking the Download button, an Excel template will open with chosen locale and variations. This is how it will look like - 

mceclip0.png

Imp: Please do not make ANY changes in the row/column names in the template. You can only add content in the empty cells corresponding to these rows/columns or add more rows in case you want to add more locales/variations. We strongly advise downloading a new template rather than making these changes manually.

Its recommended you to keep the MoEngage dashboard open on a new tab for better understanding and ease of use while working with this template. 

The template has the following structure:

  • Each row represents a particular locale<>variation<>platform combination. 
  • The columns are divided into various sections so that they provide similar experience as the sections on dashboard - Message, Rich content and Actions.
  • There are 6 main sections in the Excel - Input, Message, Rich content, Default Click Action,Action button configuration (Action button 1 & 2), Fallback content. 
  • Input: This section contains the locales, variations & platforms that you had provided as an Input in the Import Campaign dialog (You chose platforms on Segmentation page). Please don't change the locale number/locale name/variation/platform names otherwise the system will not be able to validate the template when you upload it. Please be very cautious while adding/deleting any of these fields.

mceclip3.png

  • Message: The Message section in the Excel template will contain all the fields (as columns E to M) that are present under the Message section on MoEngage dashboard.  
  • Rich Content: The Rich content section in the Excel template will contain all the fields (as columns N to X) that are present under the rich content section on MoEngage dashboard.
  • Actions > Default Action Button: The default Action button section in the Excel template will contain all the fields (as columns Y to AD) that are present under the Actions>> Default Click Action section on MoEngage dashboard. 
  • Actions > Action Buttons: The Action button section in the Excel template will contain all the fields (as columns AE to AM) that are present under the Actions>> Add Action Button section on MoEngage dashboard. At max, 2 action buttons can be configured for Android & Web. The Action Button2 configuration section (as columns AN to AV) is for the 2nd Action button and contains same fields as Action Button1.  Whereas, iOS allows only 1 more action button which is handled in default Action button section. 
  • Fallback Message: The columns from AW till CN correspond to the Fallback message configuration and contain same sections that are described above. Use this section only if you use personalization and want to setup a Fallback option. 

Important Guidelines

Please be extra careful that you don't make any changes in the pre-populated row or columns in the downloaded template.  To be more specific, here are some guidelines:

  • Don't change the structure of the Excel i.e. do not delete any column from the downloaded template. 
  • You can add/remove a locale or variation from your campaign but we highly advise not to do so initially, especially until you get a hang of the complete feature.
    • Until then, here's how you can edit locale/variation/platform: Go back to Import Campaign dialog. Make the necessary changes in the locale, variation or platform selection and download the template again. Now add the content to this new template. If you are copy/pasting from the previous version be very careful so as not to put data in wrong row/column.
    • If you want to make any changes to platform, go back to dashboard >> Step 1 Segmentation in Campaign Creation and change the platform. 
  • However, if you have used the feature a couple of times and want to re-use an existing template without downloading it from MoEngage dashboard, here are a few things you need to be careful about: 
    • Make sure that you maintain the locale<> variation<> platform combination as shown in the image below. For eg if you want to add a locale and you already have 3 variations and 2 platforms, you would need to add a total of 6 rows. Make sure to add correct locale number as well from Locale Settings on MoEngage dashboard. 
    • Default locale: Make sure to not remove the default locale. Its a mandatory field and the template is expected to have atleast 1 locale which is the default locale A default locale always have locale name as "default" and the locale number as "0"
    • If you want to add 1 more variation, let's say a 4th variation, and have 2 platforms (Android & iOS), you would need to add 2 rows (V4 for Android and V4 for iOS) in each locale block. 

mceclip1.png

    • Further, if you want to delete any locale make sure to delete the entire block of that locale. But, if you want to delete variation, let's say 2nd variation, then delete the corresponding variation rows (V2) from each locale block.
  • Don't change the names of any pre-filled rows or columns in the downloaded template. 
  • Don't delete or shift anything in the tab "Dropdown values" in the Excel. 
  • Don't change the names of the 2 tabs present in the template. 

Input values in the Excel

Each row in the Excel corresponds to a different combination such as row 1 could be default locale <> variation 1 <> Android. Row 2 would be for iOS. Be extra careful when filling out information corresponding to the rows so as not to put Android related information in iOS or vice-versa.

There are some mandatory fields while some are optional. In case you didn't fill in the mandatory cell our system will give error. But if you forgot to leave an optional field empty unintentionally, then the system will not be able to decide whether it was intentional or a mistake and hence not throw an error.

However, if you put some wrong value in the optional field then the system will handle it. For eg., image is an optional field. However if you provide a wrong image URL error will be shown.

Quick Tip: In case you are targeting both Android & iOS platforms and you wish to fill all Android first and then all iOS, use filters in Excel. 

Here is a detailed description on each column of the Excel:

Message

mceclip4.png

Message Section in the Excel template

 

mceclip5.png

 Corresponding Message section on the MoEngage dashboard

  • Notification channel [Android only] Column E | Mandatory field:

This field is applicable to Android platform only. In the Excel, please leave this field empty for other platforms. 

Under this field, you need to enter the ID for the notification channel that you wish to use. To get this ID, go to MoEngage dashboard (Step2 Messaging) and click on Notification channel dropdown. Click on Manage Notification Channel, as shown below.

mceclip1.png

On clicking, Manage Android Notification Channels dialog will open. It lists all Notification Channel and their corresponding IDs. Copy the ID from here and paste in the corresponding cell in Excel.

mceclip2.png

For eg. If you wish to use the channel C123, then you will need to paste its ID moe_abc in the Excel. If you wish to use same Notification channel for all the variations in Android, you will have to paste the same ID in the all the cells corresponding to Android.

Tip: Filter the Excel with platform=Android. Paste ID in first cell under column E and drag it.

mceclip3.png

 

  • Message Title | Column F:

This field is mandatory for Android & Web; optional for iOS.

Please enter a message title for all the platforms in the Excel, the same way you would do on the MoEngage dashboard.

If you wish to add personalisation here, you will have to enter personalisation attribute in the Excel. For this, go to MoEngage dashboard and add the personalised attribute in the Message Title from dropdown. It will add an attribute in the curly braces as shown below. 

mceclip4.png

Copy/paste this attribute in the Excel as shown below. 

Note: Its very important to paste the attribute in correct format, else it will not be treated as a valid attribute. An error will be shown for this once you upload the Excel. 

mceclip5.png

  • Message | Column G | Mandatory field:

Please enter a message for all the platforms in the Excel, the same way you would do on the MoEngage dashboard, just like Message Title. 

  • Subtitle [iOS only] | Column H | Optional field:

If you wish to add a subtitle for your iOS messages, use this field. You can add personalisation for this field in the same way as explained in Message Title section above.

  • Content-Available [iOS only] | Column I | Optional field:

If you want to allow your app to refresh in background, Choose Yes from the dropdown in the Excel. 

  • Message Summary [Android only] | Column J | Optional field:

If you wish to add a summary for your Android messages, use this field.You can add personalisation for this field in the same way as explained in Message Title section above.

  • Redirect URL [Web only] | Column K | Mandatory field:

Enter the redirect URL in the Excel. The user will be redirected to this URL on notification click. 

  • Icon Image [Web only] | Column L | Optional field:

 Currently, only default web icon is supported via import option. Enter "default" in this field. In case you miss this field, we will automatically consider the default web icon. 

mceclip6.png

  • Notification dismiss [Web only] | Column M | Optional field:

If you want to automatically dismiss the notification after 20 sec., Choose Yes from the dropdown in the Excel else select No

Rich Content

mceclip6.pngRich Content Section in the Excel template

 mceclip7.png

Corresponding Rich content section on the MoEngage dashboard

 

Note: This entire section is optional for all platforms.

In Android, you can add total 3 rich content - 1I mage + 1 Coupon + 1 Sound.

In iOS, you can add total 3 rich content - 1 of either Image/Audio/Video + 1 coupon + 1 notification sound

In Web, you can only add an image as rich content

  • Use Coupon | Column N:

Select Yes from the dropdown if you wish to add a Coupon to your Push Notification (PN). Make sure to enter a coupon code in the next column 

  • For Coupon: Coupon Code | Column O:

Enter a coupon code for each supported platform for which you wish to add a coupon code in the PN. The Coupon code can be entered in the format - OFFER10

  • Use Image | Column P:

Select Yes from the dropdown if you wish to add an Image to your PN. Make sure to enter a valid Image URL in the next column 

  • For Image: Image URL | Column Q:

Enter a valid Image URL in this column.

- Android: Supported image formats are JPEG & PNG. The maximum allowed size is 5 MB. 

- For iOS: Supported image formats are JPEG, PNG, and GIF. The maximum allowed size is 10 MB 

  • For Image: Mi Push Image [Android only] | Column R

 Currently, this option is not supported via Excel. If you wish to use an image for Mi Push, add it via dashboard once you have uploaded the Excel template.

  • Use Notification Sound | Column S:

Select Yes from the dropdown if you wish to add a sound to your PN. Make sure to enter the notification sound filename in the next column

  • For Notification Sound: Filename | Column T:

The sound file should be in your app bundle. Choose a sound filename as per the platform. Android supports .wav .mp3 and other prevalent sound formats while iOS supports .aiff , .caf & .wav

  • Use Audio [iOS Only] | Column U:

Select Yes from the dropdown if you wish to add an audio to your iOS PN. Make sure to enter the audio filename in the next column

  • For Audio: Audio URL [iOS Only] | Column V:

The audio file should be hosted somewhere and be directly playable. iOS 10 and above supports .wav and .mp3 formats of audio files. The maximum allowed size of an audio piece is less than 5 MB.

  • Use Video [iOS Only] | Column W:

Select Yes from the dropdown if you wish to add a video to your iOS PN. Make sure to enter the audio filename in the next column

  • For Video: Video URL [iOS Only] | Column X:

The video file should be hosted somewhere and be directly playable. iOS 10 and above supports MPEG, MPEG2, MPEG4 & AVI formats. The maximum size of the videos should be less than 50 MB.

mceclip7.png

Sample Rich Content fields in the template

Default Click Action

mceclip8.png

Default Action Button Section in the Excel template

 mceclip10.png

Corresponding Default Action Button Section on the MoEngage dashboard

Default Click Action is mandatory field for Android. It's optional for iOS and not applicable in case of Web. 

  • Action dropdown | Column Y:

Select one of the actions from the dropdown in Excel - Navigate to a screen/  Deeplinking/ Richlanding.

  • For Navigate to a screen: Enter screen name | Column Z:
  • Deeplinking URL | Column AA:
  • Richlanding URL | Column AB:

Make sure to put the values correctly in the above 3 columns basis what you have selected in the dropdown. For eg:

- If you select Navigate to a screen in the column Y > enter screen name in column Z & leave columns AA & AB empty corresponding to a row.

- If you select Deeplinking in the column Y > enter Deeplinking URL in column AA & leave columns Z & AB empty corresponding to a row.

- If you select Richlanding in the column Y> enter Richlanding URL in column AB & leave columns Z & AA empty corresponding to a row.

  • Default Action: Key value pair | Column AC:

You can add additional key value pairs for the Action you have selected above. This column takes care of additional K-V pairs for all 3 actions as only 1 action is allowed for a platform.

Make sure you add K-V pair in the specific format:  {"key1":"value1"}

In case, you want to add multiple key value pairs the format looks like this: {"key1":"value1","key2":"value2","key3":"value3"}

mceclip8.png

mceclip9.png

Sample template with Default Actions added

  • Category for additional actions [iOS only] | Column AD | Optional field:

Type the name of one of the additional actions if you wish to add them to your iOS notification.

mceclip11.png

mceclip12.png

 

Action Buttons

mceclip12.png

Action Button1 configuration Section in the Excel template

mceclip13.png

Corresponding Action Buttons setup on the MoEngage dashboard

Note: This entire section is optional for all supported platforms (Android & Web). It's not applicable for iOS. 

  • Add Action Button1 | Column AE:

Select Yes if you wish to add an action button to your Push Notification. 

  • Action button1: Name [Android Only] | Column AF:

Enter the name of the Action button that you want to appear on the notification. Eg. "Click" or "Manage" or "Clear"

  • Action button1: Icon [Android Only] | Column AG:

Enter the name of the system/app icon. Action Button icons are not supported from Android N. For version prior to Android N, you can add the required icons in appropriate shape and size in your app bundle so that you can then use those custom icons for notification buttons.

  • Click Action1 [Android only] | Column AH:

Select one of the actions from the dropdown in the Excel.

mceclip13.png

  • Click Action1 parameters [Android only] | Column AI:

Based on the Action you selected above, add click action parameters as explained below:

If Click Action is: Enter the following in Click Action parameters Sample value Comments
Navigate to a screen Screen Name com.moengage.demoapp.MainActivity  
Deeplinking Deeplinking URI https://www.moengage.com/  
Richlanding Richlanding URL

https://app.moengage.com/v3

/#/create/genpushV2/

 
Share Text to be shared Click to win referral  
Call  Phone Number 9876543210  
Copy Text to be copied copy this text  
Set User Attribute User Attribute and User Attribute value 

eventAttr_Name,AddToCart

where,User Attribute = eventAttr_Name & its value = AddToCart 

Copy the user attribute from MoEngage dashboard & paste here. Both params need to be added in the same cell separated by comma

Snooze Time duration for Snooze in hours 1  You can put any integer value in the range 1to 24 hrs.
Remind Later Remind today in (hours); Remind tomorrow in (hours) 2,3 You can put any integer value in the range 1to 24 hrs for both the params. And, both need to be added in the same cell separated by comma
Custom Action Custom Action text any text  
Track event Event Name, Event Value product_purchase,2 Both params need to be added in the same cell separated by comma (without any space)


Refer the help section for more clarity on Click Action parameters or go to MoEngage dashboard. 

  • Action Button1: Key value pair [Android Only] | Column AJ:

If you want to add additional parameters to the Click Action parameter that you have set up above, then add it in the same format as explained in section Default Click Action  >> Default Action: Key value pair | Column AC. Key-value pairs for are only applicable 

  • Button1 Title [Web only] | Column AK:

Enter the name of the Action button that you want to appear on the notification. Eg. "Click" or "Manage" or "Clear"

  • Button1 Icon [Web only] | Column AL:

 Enter the URL for button icon.Keep aspect ratio of 24 x 24 (Width:Height) in px.

  • Button1 URL [Web only] | Column AM:

 You can add a URL of the page where you want your users to be re-direct when they click this action button. This is optional field. 

Note: If you want to add a 2nd Action button, select Yes for the field "Add Action button 2" (Column AN) and follow same steps as mentioned under Action Buttons section. 

Fallback Message

mceclip15.png

Fallback message configuration Section in the Excel template

 mceclip16.png

Corresponding Fallback Message section on the MoEngage dashboard

Use this section only if you have used personalisation in the primary message content. All the fields for the Fallback message remain same as the above fields in the Message, Rich Content & Actions sections respectively. Make sure not to use any personalisation attribute in this section.

We cannot copy non-personalised fields in the Fallback section in Excel due to Excel limitations. Hence, you would have to manually add the non-personalised fields in the respective Fallback message sections in columns AW till CN.

Upload the template

Once you have added all the content in the Excel, upload it to the MoEngage dashboard. Come back to Import Campaign dialog. Either click Browse and select your Excel file or drag/drop the file. Click Upload button. 

mceclip0.png

If there are any errors in the uploaded Excel, all the errors will be shown with cell number where that error has occurred. 

mceclip4.png

Please go back to the Excel, make the necessary corrections in that cell and re-upload the file.

On successful upload, you will see a success message that informs you about the configuration of the uploaded file (no. of locales, variations and platforms). Also, it shows the locale names for quick reference. This would help you cross-check that you have not uploaded a different file by mistake. if you are OK with the uploaded configuration, Click Next. 

mceclip0.png

Re-Upload: After successful upload, if you still make some changes in the Excel data and re-upload the updated file, then your old file will be over-written with this one. 

Preview Grid

On clicking Next in the Import Campaign, Preview screen will open.

mceclip7.png

It contains mobile-previews of all the locale/variation configurations uploaded via Excel template. Locales are present as rows and variations as columns. You can choose to preview a particular platform or all the platforms from the dropdown present at top-left corner.

 mceclip8.png

If you have configured personalisation message as well as fallback for a particular locale, the personalised and fallback preview will be displayed one below another. 

In case you are not satisfied with how a particular notification looks or for eg. if you forgot to add a button to this particular notification, click on its Preview. It will take you to the respective notification configuration on the UI. 

mceclip10.png

Click on Preview Screen

 mceclip9.png

Takes to corresponding tab on Messaging

 

 

 

Here, you can add that button that you had missed. Or you can change just any part of the message. Once done, click on themceclip11.png button on the top right corner on Messaging screen. It will again take you to Preview screen. 

For some reason, if you are not happy with how your notifications look; or you just realised that you forgot adding one more locale, click on mceclip12.png button on the Preview screen which will take you to the Import Campaign dialog. Add that locale (that you missed) to the list of locales you selected before and download the template. Enter all the necessary details in the template and upload it.

Tip: In this case, you can copy/paste data from the previous Excel template that you uploaded. And add content corresponding to all the rows for the new locale.

Once you are satisfied with your campaign content, close the Preview screen by clicking mceclip13.png button.

This will take you to the Messaging step of Campaign creation with all the locale/variation data populated. 

Note: You can open the Preview Grid anytime by clicking the mceclip11.png from the Messaging tab on UI.

Click mceclip3.png button on the Messaging step to proceed to Scheduling (Step 3 of Campaign Creation). 

Enter all the details on scheduling page.For more details on filling this section, refer the help section here

Finally, click on Create Campaign to launch the campaign.

Was this article helpful?
0 out of 0 found this helpful