Mass import of rewards
Esteban avatar
Written by Esteban
Updated over a week ago

Description

Do you have a substantial number of rewards? If so, the "File Import" option is tailored for you! Set up the configuration file and upload a large number of rewards all at once. Associate images and/or codes if necessary.

💡 English subtitles are available in the video settings.

Before you begin

ℹ️ This feature is exclusively available in "By Date" mode. If you wish to create rewards by participation or through a lucky draw, refer to this article.

✅ Ensure you have all the necessary information for importing rewards in bulk (names, quantities, distribution dates, etc.).

✅ You must have access to spreadsheet software like Google Sheets or Microsoft Excel, for example.

💡 We recommend creating a folder on your computer containing all the necessary files for bulk import.

Preparation of optional files

This step is necessary if you want to associate images with your rewards and/or create reward codes. If not, proceed to the next step.

Images files

  • Accepted image formats: PNG / JPEG / GIF / SVG

  • Dimensions: 800x800px

  • Size: Maximum 300 KB

Codes files

  • A code file should contain one code per line.

  • .csv format

  • A file is limited to a maximum of 1 million codes.

  • If you have several different types of codes, you will need 1 file per code!

  • Example of code.csv file:

Place your optional files in a folder to facilitate the import process.

Preparation of the global file

To begin, download the configuration file:

Once the file is downloaded, open it using spreadsheet software like Google Sheets or Microsoft Excel. Before placing the file on the platform, remove the first two lines. They provide guidance on organizing your rewards.

Note the names of your reward images and your code files if you have them, then add them when you import the rewards automatically. If you have rewards in multiple languages, create a line for each language with the same quantity and translate its name.

Description of global file columns

Click on a header to view the description.

start_date

  • Date from which the reward should be distributed (use the same start_date and end_date to define an exact distribution date and time).

  • ⚠️ Mandatory Field

  • The requested format is either "DD/MM/YYYY hh:mm:ss" to include seconds, or "DD/MM/YYYY hh:mm" to exclude seconds (which will then be automatically set to 00).

  • Ensure the "date" cells are in the required "Date time" format.

end_date

  • Date until which the reward can be distributed (use the same start_date and end_date to define an exact distribution date and time).

  • ⚠️ Mandatory Field

  • The requested format is either "DD/MM/YYYY hh:mm:ss" to include seconds, or "DD/MM/YYYY hh:mm" to exclude seconds (which will then be automatically set to 00).

  • Ensure the "date" cells are in the required "Date time" format.

associated_page

  • Associated Page (page ID): The identifier of the instant-win page(s) on which the reward will be distributed.

  • ⚠️ Mandatory Field

  • For multiple IW pages, separate the values with a comma.

  • To specify all your Instant Win pages, use the word "all".

  • To retrieve your page ID, go to the desired page, and in the URL, find the sequence of numbers after the wording /page/.

The page ID consists of 6 digits, here's an example:

https://admin.adictiz.io/editor/42821/view/page/332691/lang/1/platform/68328/panel/settings

reward_type

  • Reward type: physical or code

  • ⚠️ Mandatory Field

reward_key

  • Insert a unique identifier for the reward (in case of multilingual rewards, specify the same identifier and quantity).`

  • ⚠️ Mandatory Field

reward_lang

  • Language in which the reward should be configured (associate the country code of the language set up on your campaign, see all country codes here).

  • ⚠️ Mandatory Field

reward_name

  • The name of your reward.

  • If you want to configure rewards for a multilingual campaign, make a line for each reward and translate the name

  • ⚠️ Mandatory Field

reward_quantity

  • Quantity of rewards to distribute

  • If rewards are of the code type, do not specify a quantity. The associated code file will automatically define the number of codes.

  • In the case of multilingual physical rewards, specify the same unique identifier (reward_key) and quantity.

  • ⚠️ Mandatory Field

reward_url

  • URL associated with the reward

  • Optional Field

reward_image

  • Image associated with the reward

  • Insert the filename and extension of the image file. Example: reward.png

  • The name is case-sensitive. The name must be exactly the same, including uppercase letters and accents.

  • Optional Field

file_code

  • Name and extension of the code file associated with the reward (only if reward type = code). Example: reward.csv

  • The name is case-sensitive. The name must be exactly the same, including uppercase letters and accents.

  • Only one code file allowed with a maximum of 1 million codes per file.

  • If you have several different types of codes, you will need 1 file per code!

  • Optional Field

expiration_date

  • Expiration date of the reward (only available in fixed date mode)

  • Format: DD/MM/YYYY hh:mm:ss

  • Optional Field

shop

  • Shops associated with the reward

  • Refer to this article to learn how to import your outlets.

  • Ensure values are separated by commas (if you want to associate all your outlets with a reward, use the word "all" in the cell).

  • If you don't want to associate an outlet with a reward, leave this field empty.

  • Optional Field

exclusion

  • Exclusion period for the reward (not at night or not on weekends): night/week or empty

  • Optional Field

priority

  • Priority of the reward (1, 2, 3, or empty)

  • Optional Field

distribute

  • Distribute rewards daily (yes=1/no=0)

  • Optional Field

mark_test

  • Mark the reward as a test (only account users can win a marked test reward, yes = 1 / no = 0)

  • Optional Field

Example of configuration for bulk import of physical rewards and codes with associated images:

Exporting the global file

Once you have completed the columns in your file, follow these steps to export it:

Export via Google Sheets

  • Click on File, then click on Download.

  • From the drop-down menu, select "Comma-separated values (.csv)".

  • Rename the file after exporting if necessary. It must be called "global_config.csv".

Export via Microsoft Excel

  • Click on "File," then click on "Save As...".

  • From the drop-down menu, select "Comma-separated values (.csv)".

  • Rename the file after exporting if necessary.

⚠️ Warning: Your file must be named "global_config.csv".

Example of a folder containing all files ready for import:

Importing Rewards via File

Step 1

  • In the campaign editor, click on the gift icon and select import by file

  • Once your configuration files are ready, drop them into the import area or click to browse:

  • Your files will be analyzed, and configuration errors may be present. Correct these errors by reimporting corrected or missing files.

  • Click on Generate to proceed to the next step.

Step 2

  • You'll be directed to the summary of rewards.

  • Check all the information and then click on Validate.

✅ The configuration is validated, publish your campaign to make your rewards available online.

💡 When publishing your campaign, some rewards may take some time to be generated. You can leave this page to allow the process to run in the background.

Configuration errors

One or more configuration errors may occur when importing files. Two categories of errors can be identified and corrected:

Error related to a missing file

  • Reimport the missing files.

  • Ensure the filename and extension match the information entered in the global_config.csv file.

Error related to a global file configuration problem

1. Reopen your global_config file in spreadsheet software and identify the errors reported during import. The editor will indicate the relevant lines.

2. Correct these errors and export your file again in .csv format.

3. Delete the previously imported global_config.csv file and reimport your corrected file.

💡 If you notice that a file has been incorrectly named in your global_config file but its extension is correct, it would be more efficient to rename it rather than make changes in the global file. This will save you time.

Q&A

Why are some files optional?

Optional files refer to images linked to rewards, as well as code-type rewards. You have the option not to include them, as it's entirely possible to generate physical rewards without accompanying images.

Why associate an image with my reward?

Associating images with rewards allows you to dynamically display them using image widgets. For instance, display the image of the reward won by the user on the "Won" page of an instant win. Learn more.

Attachment icon
Did this answer your question?