Passing Custom Parameters to Advertiser's Landing Page

In some cases there is a need to pass custom data from the pages where the ads are being displayed to the advertisers' landing pages.

To achieve this, Custom Parameters can be used. These parameters and their values can also be used for flexible Custom Targeting.

To pass the value from Publisher to Advertiser via Custom Parameters, you need to configure the specific setup both on Publisher and Advertiser sides.

For example, let us assume that we need to pass two parameters from Publisher's page to Advertiser's landing page:

  • Age = 21
  • Size = small

Publisher-side Setup

The Custom Parameters should be added to Invocation Codes that are provided to the Publisher.

Follow these steps to pass the parameters from the web page into our system:

  1. Log into your network account and go to the Publishers tab.
  2. Navigate to the Site > Zone > Placement.
  3. Add the Custom Parameters to the Invocation Code.
  4. Here you can find the examples of different Invocation Codes with added Custom Parameters

<ins> class="67536869" data-key="8c8f1d6f7e2e1910158e54fc9c735926" data-cp-age="21" data-cp-size="small"</ins>
<script> async defer src="//domain.com/b3a18f14.js"></script>
<!– BEGIN TAG – DO NOT MODIFY –>
              <script type="text/javascript">
              //<![CDATA[
              supp_key = "72c6fe61b1a4b1118bcd67e21e99b1c0";
              supp_channel = "";
              supp_code_format = "ads-sync.js";
              supp_click = "";
              supp_custom_params = {age:"21",size:"small"};
              //]]>
              </script>
              <!– END TAG –>
https://domain.com/zCt3nKWKGS31UM92Sik7Sq56sGkmmRyapTiLIWqtHUEqELapa2SUL9Yy&cp.age=21&cp.size=small
https://www.epom.com/vast.xml?key=44ea95967ad82534e67aec7f04aee119&vastv=3.0&cp.age=21&cp.size=small

📘

Note!

The way to generate and pass the values for the Custom Parameters is generally left to Publishers' consideration.

Advertiser-side Setup

To pass the parameters from our system to the Advertiser's landing page, follow these steps:

  1. Log into your network account and go to the Advertisers tab.
  2. Navigate to the Advertiser > Campaign > Banner.
  3. Add macros for Custom Parameters ?parameter1=$$CUSTOM_PARAM(name1)$$&parameter2=$$CUSTOM_PARAM(name2)$$ to Advertiser's landing page URL field.
    • Any names can be used for the URL parameters instead of 'parameter1' and 'parameter2'.
    • 'name' in the $$CUSTOM_PARAM(name)$$ string should be replaced exactly with the name of Custom Parameter that is passed by the Publisher. For the example above (age and size), the URL would be:
    • https://epom.com/?parameter1=$$CUSTOM_PARAM(age)$$&parameter2=$$CUSTOM_PARAM(size)$$
  4. Click Save.

To check if everything is working properly, visit the Publisher's page and click the Banner. You should be redirected to the landing page, where the $$CUSTOM_PARAM(name)$$ macros will be replaced with the actual values. For our example, it would look like this:

Custom Parameters in Analytics

The Custom Parameters and their values that were passed in a described way, can be seen in the Advanced Analytics if these parameters are white-listed in the Analytics configuration tab in the Network Supervisor account.

📘

Note!

In order to get access to the Advanced Analytics, please contact your personal manager.

Default Custom Parameters

The Custom Parameters can be populated by the pre-defined values that will always be passed in the same way.

To achieve this, follow these steps:

  1. Enable the Default Custom Parameters permission in the Network Supervisor account.
  2. Navigate to the Site > Zone > Placement in the Network Manager account.
  3. Press the Settings button in the Invocation Codes panel and select the Custom Parameter:
  4. Enter the Custom Parameter and its value. It will be passed with each call of an Invocation code.