Voluum Documentation

A CSV Template with Edited Campaigns

Voluum TRK Bulk Actions Campaign

Regardless if you download the CSV file for all or selected campaigns, all data should be provided according to a certain pattern. To successfully import updated entities of campaigns, you need to keep the proposed file structure and, if required, double check the data modified in the file. You can perform all updates locally on your machine.

Moreover, if you make a decision that some campaigns do not require any updates, those ones should be removed from the file to make the process of importing the file to Voluum as fast as possible.

The below table visualizes what kind of data is required in the file and which data properties are optional for a single campaign entity updated in the CSV file. You need to keep in mind that the first line in the CSV template is always blocked for a description of columns.

# 1. Campaign ID;2. Campaign's name;3. Traffic source ID;4. Country code;5. Cost model;6. Cost value;7. Redirect mode;8. Tags;9. Flow ID;10. Destination URL

a920b457-db6c-4a0f-8d5e-bb18a34e23df;My Campaign;29b10f90-d807-460a-911d-29a6df682b84;CA;AUTO;;REGULAR;health summer;ed8307a2-7680-4960-a79f-17e23bae15fe;

Moreover, there are basic rules that you need to follow to avoid issues with the file upload:

  1. The file must be properly formatted CSV and saved using UTF-8 character encoding.

  2. One CSV file can contain up to 250 campaigns. It means that there should be up to 251 rows in the file - the first row is dedicated for a description of columns.

  3. One campaignis represented on a separate row in the CSV file.

  4. In the file, each row must end with a line break.

  5. Each column must be separated with a semicolon.

    Caution

    Voluum Note: Each property of the campaign needs to be separated with a semicolon.

    • If you edit the CSV file in one of the text editors, you will be able to see the semicolons while editing it.

    • If you edit the CSV file with Excel, you need to pay attention to the delimiter setting set locally on your machine. If Excel uses semicolons as separators, then each property is located in a separate Excel column. You should see that the CSV file looks as follows while editing it:

      bulk_import_campaign_excel_file.png
  6. Only certain pieces of information are required and they are associated with the required fields in the campaign's form in Voluum. Other properties might remain blank.

  7. If you leave the optional properties blank in the CSV file, the values of the properties might be respectively overridden with the default values after importing to Voluum.

    For example, if you leave the Country code property blank in the file, the Country setting in Voluum will be set to Global.

  8. You need to keep the Flow ID and Destination URL settings blank if you want the campaign to remain the campaign with paths. You cannot transform the campaign with the flow or destination URL into the campaign with path(s).

  9. Campaign's properties need to be added according to the following patterns:

1. Campaign ID

Property: Required

Description:

This is a unique campaign ID specific for Voluum. The ID is always generated when you add an entity to Voluum.

Note

Voluum Info: The campaign ID is automatically available in the downloaded CSV file.

If something got messed up with the ID, you can easily find it by performing the following steps:

  1.  In Voluum, go to Campaigns. The Campaigns view will show up.

  2. If the ID is not displayed in the Campaigns view, perform the steps in the picture below:

    bulk_import_campaign_id.png
  3. After clicking the Apply button, the campaign ID should show up in one of the columns of the Campaigns view.

Example:

Campaign ID that is available in the CSV file: a831b457-db6c-4a0f-8d5e-bb18a34e23df

2. Campaign name

Property: Required

Description:

This is a unique campaign’s name.

If you are familiar with the Voluum campaign’s name pattern, it should be the custom suffix of the campaign’s name that you provide in the Name field in Voluum:

{selected_traffic_source} - {country_label or Global} - {your unique custom name}

You need to keep in mind that the {country_label or Global} phrase is added automatically by Voluum while saving the campaign entity.

Example:

Campaign's name that should be added to the CSV file: My Campaign

bulk_import_campaign_name.png

3. Traffic source ID

Property: Required

Description:

This is an ID of the traffic source that is specific for Voluum. The traffic source enity is required to create the campaign, so this is also a required property in the CSV file.

You can easily get the traffic ID by performing the following steps:

a. Sign in to Voluum.

b. Go to Traffic sources. The Traffic sources view will show up.

c. If the ID is not displayed in the Traffic sources view, perform the steps in the picture below:

bulk_import_traffic_source_id.png

d. After clicking the Apply button, the traffic source ID should show up in one of the columns of the Traffic sources view.

e. Find the ID of your traffic source and copy it to your CSV file.

Example:

Traffic source ID that should be added to the CSV file: 29b10f90-d807-460a-911d-29a6df682b84

bulk_import_campaign_traffic_source.png

4. Country code

Property: Optional

Description:

This is a two-letter country code. Voluum accepts the country codes provided according to a certain pattern - if required, you can download the file with codes for all countries: two-letter_country_codes.csv

If you leave the Country code property blank, then the Global value will be set for your campaign.

Example:

Country code that should be added to the CSV file: CA

bulk_import_campaign_country.png

5. Cost model

Property

  • It should be left blank, if Zeropark is set as a traffic source

  • Otherwise, one of the available options needs to be provided

Description:

The cost model property allows you to track your cost spent on the traffic.

Available options: NOT_TRACKED, CPC, CPM, CPA, CPA_REVSHARE, AUTO.

Caution

Voluum Note: Keep in mind that the Cost model options are case sensitive.

Example:

Cost model that should be added to the CSV file: AUTO

bulk_import_campaign_cost_model.png

6. Cost value

Property: Only required if the Cost model option is set to one of those: CPC, CPM, CPA, or CPA_REVSHARE

Description:

  • For the CPC, CPM, CPAcost model: The cost value amount that is provided manually for a given cost model. If provided, you should use a period as a decimal separator.

  • For the CPA_REVSHARE cost model: The fraction of the offer(s)' payout that is taken as the offer(s)' cost paid to the traffic source. If provided, you should use a period as a decimal separator.

Example:

  • For the CPC, CPM, CPA cost model: Cost value that should be added to the CSV file: 0.08

    bulk_import_campaign_cost_value.png
  • For the CPA_REVSHARE cost model: Fraction that should be added to the CSV file: 0.84

    bulk_import_campaign_cost_revshare.png

7. Default redirect mode

Property: Required unless the Flow ID is set

Description:

The redirect modes that are available in Voluum.

Available options: REGULAR (known also 302), HTML (known also Meta refresh),DOUBLE_HTML (known also Double meta refresh)

Caution

Voluum Note: Keep in mind that the Redirect mode options are case sensitive.

Example:

Redirect mode value that should be provided in the CSV file: REGULAR

bulk_import_campaign_redirect_mode.png

8. Tags

Property: Optional

Description:

You can add one or more tags to your campaign entity to easily search for the campaign in Voluum. If you want to use more that one tag, they should be separated by spaces.

Example:

Tags that should be added to the CSV file: health summer

bulk_import_lander_tags.png

9. Flow ID

Property: Only required, if the Destination URL is blank

Description:

Flow ID is one of the available destination options that can be provided in Voluum. In terms of the bulk import feature, you can:

  • Change the flow for the campaign by changing the Flow ID, or

  • Remove the flow ID from the CSV file and provide the destination URL in the next column in the file.

    Caution

    Voluum Note: You cannot set a path for the campaign in the CSV file, if the exported campaign was not originally set with the path. It means that you can leave neither the Flow ID nor Destination URL value blank for the campaign if one of those values was provided in the exported file.

    You can easily get the flow ID by performing the following steps:

a. Sign in to Voluum.

b. Go to Flows. The Flows view will show up.

c. If the ID is not displayed in the Flows view, perform the steps in the picture below:

Flow_ID.png

d. After clicking the Apply button, the flow ID should show up in one of the columns of the Flows view.

e. Find the ID of the flow you are looking for and copy it to your CSV file.

Example:

Flow ID that should be added to the CSV file: ed8307a2-7680-4960-a79f-17e23bae15fe

10. Destination URL

Property: Only required, if the Flow ID is blank

Description:

Destination URL is one of the available destination options that can be provided for the campaign in Voluum. In terms of the bulk import feature, you can:

  • Change the destination URL for the campaign, or

  • Remove the destination URL from the CSV file and provide the Flow ID in the previous column in the file.

    Caution

    Voluum Note: You cannot set a path for the campaign in the CSV file, if the exported campaign was not originally set with the path. It means that you can leave neither the Flow ID nor Destination URL value blank for the campaign if one of those values was provided in the exported file.

Example:

Destination URL that should be added to the CSV file: http://voluum.html?geo={country}&os={os}

bulk_import_campaign_destination_url.png

Search results

    No results found