How to Add FreeWheel Sponsorship Parameters to your Player Tag

The FreeWheel Sponsorship macro (known as 'fwkeyvalues'), allows you to pass your sponsorship tag name to FreeWheel to target appropriate sponsorships using this player.

 

How to Apply the 'fwkeyvalues' Macro to Your Player Tag

To apply the 'responsive' macro to your player tag, perform the following steps:

  1. Obtain one of your Player Tags from the portal. For further details, please see How to grab a Player Tag.

  2. Go to your preferred text editor, and paste your Player Tag into it.

    Your player tag should resemble the following example:
    <!-- TAG START { player: "Player Events", owner: "Support", for: "Support" } -->
    <div id="56e547dbe4b09eb92cf71b7d" class="vdb_player vdb_56e547dbe4b09eb92cf71b7d56d5921ce4b0f5991ad44713">
    <script type="text/javascript" src="//delivery.vidible.tv/jsonp/pid=56e547dbe4b09eb92cf71b7d/vid=56f17cc8e4b05b1a3f583e69/56d5921ce4b0f5991ad44713.js"></script>
    </div>
    <!-- TAG END { date: 04/10/16 } -->



  3. Check if your player tag has any existing macros by locating the "vdb_params" declaration within your player tag. 

    Note: An exitsitng "vdb_params" decleration means that your player Tag already has at least one specified macro.


    The following table describes how to proceed in each case:


    My Player Tag Has a "vdb_params" decleration

    Add the following text to these two places in your Player Tag:

    1. At the end of the first <div> tag, within the existing 'vdb_params' declaration, right after the existing macro within the existing double quote (") symbols.
    2. At the end of the <script> tag, within the query string, right after the existing macro, within the existing double quote (") symbols. 
      m.fwkeyvalues=sponsorship%3DSPONSORSHIP_NAME

    Important! This text includes a '%3D' ASCII value that represents an equals (=) symbol. Make sure to keep this syntax in your macro.

    Your Player Tag should resemble the following:

    Note: The existing macro parameter and value are highlighted in blue, while the responsive parameter and value are highlighted in red.

    Important! Macro parameters and values are passed in two places within your Player Tag, first on the <div> level, and second to the server by adding it to the <script> tag query string.

    <!-- TAG START { player: "Player Events", owner: "Support", for: "Support" } -->
    <div id="56e547dbe4b09eb92cf71b7d" class="vdb_player vdb_56e547dbe4b09eb92cf71b7d56d5921ce4b0f5991ad44713" vdb_params="m.parameterX=valueY&m.fwkeyvalues=sponsorship%3DSPONSORSHIP_NAME">
    <script type="text/javascript" src="//delivery.vidible.tv/jsonp/pid=56e547dbe4b09eb92cf71b7d/vid=56f17cc8e4b05b1a3f583e69/56d5921ce4b0f5991ad44713.js?m.parameterrX=valueY&m.fwkeyvalues=sponsorship%3DSPONSORSHIP_NAME"></script>
    </div>
    <!-- TAG END { date: 04/10/16 } -->


     

    My Player Tag Does not have a "vdb_params" decleration

     

    1. Add the following text at the end of the first <div>, right before the closing angled bracket (>):
      vdb_params="m.fwkeyvalues=sponsorship%3DSPONSORHIP_NAME"
    2. Add the following text at the end of the <script> tag, right before the closing double quote (") and closing bracket (>) symbols:
      ?m.fwkeyvalues=sponsorship%3DSPONSORSHIP_NAME 
      Note: Verify that you have added the question mark (?) symbol prefix.

    Important! This text includes includes a '%3D' ASCII value that represents an equals symbol. Make sure to keep this syntax in your macro.

    Your Player Tag should resemble the following:

    Note: The macro declaration including the responsive parameter and value are highlighted in red.
    Note: The macros are declared both on the <div> and the <script> levels.

    Important! Macro parameters and values are passed in two places within your Player Tag, first on the <div> level, and second to the server by adding it to the <script> tag query string.

    <!-- TAG START { player: "Player Events", owner: "Support", for: "Support" } -->
    <div id="56e547dbe4b09eb92cf71b7d" class="vdb_player vdb_56e547dbe4b09eb92cf71b7d56d5921ce4b0f5991ad44713" vdb_params="m.fwkeyvalues=sponsorship%3DSPONSORHIP_NAME">
    <script type="text/javascript" src="//delivery.vidible.tv/jsonp/pid=56e547dbe4b09eb92cf71b7d/vid=56f17cc8e4b05b1a3f583e69/56d5921ce4b0f5991ad44713.js?m.fwkeyvalues=sponsorship%3DSPONSORSHIP_NAME"></script>
    </div>
    <!-- TAG END { date: 04/10/16 } -->

     

  4. Replace the 'SPONSORSHIP_NAME' placeholder with your required FreeWheel sponsorship name.

  5. Copy your complete Player Tag from your text editor and embed it in your web sites.

    In this summary example we have set our responsive parameter to '1' meaning that responsive is active:

    <!--TAG START { player: "Player Events", owner: "Support", for: "Support" } -->
    <div id="56e547dbe4b09eb92cf71b7d" class="vdb_player vdb_56e547dbe4b09eb92cf71b7d56d5921ce4b0f5991ad44713" vdb_params="m.fwkeyvalues=sponsorship%3DAutos:General">
    <script type="text/javascript" src="//delivery.vidible.tv/jsonp/pid=56e547dbe4b09eb92cf71b7d/vid=56f17cc8e4b05b1a3f583e69/56d5921ce4b0f5991ad44713.js?m.fwkeyvaleus=sponsorship%3DAutos:General"></script>
    </div>
    <!-- TAG END { date: 04/10/16 } -->


Have more questions? Submit a request