2019-12-18 Release

Account custom parameters in Pulse UI, Pulse APIs, VAST and VMAP, and in HTML5 Pulse SDK, Excel export available in Performance Metrics Explorer, Custom Reporting UI filtering improvement, and Insertion Policy UI and API update.

Account custom parameters

Note: Account custom parameter targeting is not enabled by default. Please contact your Account Manager if you want to start using account custom parameters.

Account custom parameter functionality allows you to target any parameter that does not fit in with the rest of the Pulse targeting rules and where you need a more structured approach than with tags. The parameters are structured as key-value pairs.

To define the account custom parameters for your account, you need to provide your Account Manager with the following information:
  • Pulse UI Name: Display name to be shown in the Pulse UI when selecting targeting. The name must be unique for an account. Maximum of 35 characters are allowed.
  • Ad request/API parameter name: The parameter to use in ad requests and API requests for targeting. The parameter name must be unique for an account. Maximum of 13 characters are allowed, including the acp. prefix. For example, in an ad request it looks like acp.paramName=value. The following characters are allowed:
    • Letters: A through Z, and a through z
    • Numbers: 0 through 9
    • Other characters: - (hyphen) _ (underscore) . (dot) ~ (tilde)
  • Required in ad request: By default, the account custom parameters are not required in ad request URLs. If you choose to have account custom parameters required in the ad request, then all ad request URLs must contain the acp.paramName parameter for each of the account custom parameters where you selected this as required, otherwise the request fails.

To edit or delete any of your configured account custom parameters, contact your Account Manager. If you delete an account custom parameter, it gets removed from the global/campaign/goal targeting, and targeting templates.

Limitations
  • The default amount of account custom parameters you can have for your account is four.
  • Simulating on specific account custom parameters is currently not supported, however the progress bars take the account custom parameters into account when running the background forecasts.
  • Reporting on specific account custom parameters is currently not supported.
  • In the ad request, you can only pass in one value for each of the account custom parameters.
  • When adding targeting values for account custom parameters through the Pulse UI or Pulse APIs, you can add a maximum of 20 values for one account custom parameter.
  • The account custom parameter values cannot contain any spaces or any of the following characters: comma (,), semicolon (;), double quote/quotation mark ("), single quote/apostrophe ('), backslash (\), pipe (|), tilde (~), or ampersand (&).

Account custom parameters in Pulse UI

When enabled and defined, account custom parameters show up in the Pulse UI when adding targeting rules on all levels. Each account custom parameter gets its own block under the global/campaign/goal targeting rules, and in targeting templates. Use the account custom parameter rules to target up to 20 values for each of the account custom parameters defined for your account. For example:

Example account custom parameter targeting

Account custom parameters in Pulse REST APIs

Support for retrieving and updating account custom parameter targeting has been added to the following Pulse APIs:
  • Campaign API, specifically Campaign and campaign rules requests. Pass in the following parameters in the campaign rules request body:
    <accountCustomParameters>
        <ignoreParent>boolean</ignoreParent>
        <parameterName>acp.paramName</parameterName>  
        <rules>
           <ruleType>AT_LEAST_ONE_OF|NONE_OF</ruleType>
           <value>string</value>
        </rules>
    </accountCustomParameters>
  • Goal API, specifically:
    • Goal and goal rules 1.0 requests and Goal and goal rules 1.0.cpvext requests, pass in the following parameters in the goal rules request body:
      <accountCustomParameters>
          <ignoreParent>boolean</ignoreParent>
          <parameterName>acp.paramName</parameterName>
          <rules>
             <ruleType>AT_LEAST_ONE_OF|NONE_OF</ruleType>
             <value>string</value>
          </rules>
      </accountCustomParameters>
    • Goal rules v2 requests, pass in the following parameters in the request body:
      "accountCustomParameterRules": [
        {
          "ignoreParent": <boolean>,
          "parameterName": "acp.paramName",
          "rules": [AccountCustomParameterRuleBean]
          ]
        }
      ]

      where AccountCustomParameterRuleBean is structured as:

      {
        "value": "<string>",
        "ruleType": "AT_LEAST_ONE_OF" | "NONE_OF"
      }
  • Targeting Template API, specifically Targeting template rules requests. Pass in the following parameters in the request body:
    "accountCustomParameterRules": {"acp.paramName": [AccountCustomParameterRuleBean]}

    where AccountCustomParameterRuleBean is structured as:

    {
      "value": "<string>",
      "ruleType": "AT_LEAST_ONE_OF" | "NONE_OF"
    }
  • (read-only) Site API

VAST and VMAP parameter for Account custom parameter

A new parameter, acp.paramName, is available for direct VAST and VMAP integrations to request ads targeted to specific values of the account custom parameters defined for your account. The parameter is structured as a key-value pair in the form of acp.paramName=value, where paramName needs to match the ad request parameter name defined for your Pulse account.

You can only pass in one value for each of the account custom parameters defined for your account. The account custom parameter values cannot contain any spaces or any of the following characters: comma (,), semicolon (;), double quote/quotation mark ("), single quote/apostrophe ('), backslash (\), pipe (|), tilde (~), or ampersand (&).

Account custom parameter in HTML5 Pulse SDK

From version 2.1.19.12.0, the HTML5 Pulse SDK contains the account custom parameter in the content metadata object. This parameter enables you to request ads targeted to specific values of the account custom parameters defined for your account.

In the ad request URL, the parameter is structured as a key-value pair in the form of acp.paramName=value. In the content metadata object, you provide the paramName which needs to match the ad request parameter name defined for your Pulse account.

You can only pass in one value for each of the account custom parameters defined for your account. The account custom parameter values cannot contain any spaces or any of the following characters: comma (,), semicolon (;), double quote/quotation mark ("), single quote/apostrophe ('), backslash (\), pipe (|), tilde (~), or ampersand (&).

Documentation releases:

Excel export in Performance Metrics Explorer

It is now possible to export a performance report in Microsoft Excel (.xlsx) format through the Performance Metrics Explorer UI. The Export XLS button is available in the bottom left corner of the Metrics Summary section, regardless of the selected breakdown.

Export XLS button in Performance Metrics UI

The name of the downloaded file is export.xlsx. The file contains all available campaign performance data, regardless of the breakdown selected at the time of export. This means there are always four sheets which correspond to the data breakdowns available in the Performance Metrics Explorer UI. Each sheet contains the totals for each of the performance metrics.
  • Campaign sheet, with performance metrics totals for the campaigns you filtered on.
  • Goal sheet, with performance metrics totals for the campaigns you filtered on and all of their goals. For active campaigns, goals that have not started yet are not included.
  • Device sheet, with performance metrics totals for the campaigns you filtered on and the device containers targeted by those campaigns.
  • Format Type sheet, with performance metrics totals for the campaigns you filtered on and their ad formats.

Excel export report example

It is also possible to export a shared performance report in Microsoft Excel (.xlsx) format.

Custom Reporting filtering improvement

Previously, when filtering reports in the Custom Reporting user interface, Pulse filtered among the maximum of 200 reports that are loaded and visible in the UI. Now, if you have more than 200 reports, Pulse looks at all of your reports when you use any of the available filters.

This helps you find the reports that are no longer visible in the UI. However, the results still show only a maximum of 200 reports in the UI, so it is recommended to use a combination of filters to narrow down the results.

This improvement is especially good if you are using the refreshable report functionality, since you can run a maximum of two reports at the same time and refreshing a report counts towards your queue. Now, if your clients refresh a shared report that is no longer visible in the UI, you will be able to see that report when filtering on Queued or Processing status. This helps you understand why your queued reports are not processing and why you cannot create more reports.

Documentation releases:

Insertion Policy update

The ability to configure position based breaks in the new insertion policies has been extended. Previously, the number of normal pre-roll, mid-roll, and post-roll ads per ad break could only be set within a range of 1 to 50. Now, we have added the option to have zero ads per pre-roll, (default) mid-roll, and post-roll ad break. This update is available both in the Insertion Policy UI and API.

Zero ads per ad break means that you can have empty pre-roll, mid-roll, and post-roll breaks, but still have the option to show sponsor ads at the desired positions.