Refactoring of campaigns and orders emission plan

In next few weeks we will introduce the following changes in API commands. These changes are a part of refactoring in campaigns and orders emission plan, which will prepare our system to release new features in AdOcean.

Removing an option from the emission plan in the interface

During that release, a checkbox "maximize impressions for reach-based delivery" will be permanently removed from the system. Option has been visible in the Number of events section when reach indicator was chosen.

Changes in API command execution:

AddCampaign and UpdateCampaign

• Removal of emissionSettings and emissionSettingsState parameters. These parameters were used to set the "maximize impressions for reach-based delivery" option in the emission plan of the campaign that will no longer be available.
• impressionMode parameter will now be replaced by three new parameters:
  • emissionMode parameter can take one of the following values: FOR_EACH_ORDER or FOR_ENTIRE_CAMPAIGN.
    • FOR_ENTIRE_CAMPAIGN - defines a plan for the campaign using the algorithm and overMode parameters (described below),
    • FOR_EACH_ORDER - defines a plan for each order separately (replacement for ORDERS settings from the previous version).
  • algorithm parameter can take one of the following values: none, STANDARD, PUBLISHER_PRIORITY, PUBLISHER_SHARE, ORDER_PRIORITY:
    • none - chosen if the campaign is in the FOR_EACH_ORDER mode,
    • STANDARD - a default value,
    • PUBLISHER_PRIORITY - campaign will be delivered according to predefined publishers' priorities,
    • PUBLISHER_SHARE - campaign will be delivered according to predefined publishers' shares,
    • ORDER_PRIORITY - a new option that will allow to deliver the campaign according to orders' priorities.

    If the campaign is in the FOR_EACH_ORDER mode, then the algorithm cannot be defined (algorithm parameter should not be a part of the request). Otherwise, set one of the 4 available values. In case none of them is chosen (parameter is sent with an empty value), STANDARD will be selected as a default value.

  • overMode parameter can take one of the following values: none, NO_OVER, OVER_AFTER_CAMPAIGN:
    • none - chosen if the campaign is in the FOR_EACH_ORDER mode,
    • NO_OVER - overEmit option for the campaign will be disabled,
    • OVER_AFTER_CAMPAIGN - overEmit option for the campaign will be enabled, campaign will still be emitted after its end date until reaching the plan or for the maximum of 30 days.

    If the campaign is in the FOR_EACH_ORDER mode, then overMode cannot be defined (overMode parameter should not be a part of the request). Otherwise, set one of the available values. In case none of them is chosen (parameter is sent with an empty value), NO_OVER will be selected as a default value.

  AddOrder, UpdateOrder, AddSurround, UpdateSurround

  • Removal of emissionSettings and emissionSettingsState parameters. These parameters were used to set the "maximize impressions for reach-based delivery" option in the emission plan that will no longer be available.
  • Removal of an impressionLimit parameter (deprecated).
  • impressionMode parameter will now be replaced by two new parameters:
    • algorithm parameter can take one the following values: none, STANDARD, PUBLISHER_PRIORITY, PUBLISHER_SHARE:
      • none - chosen if the campaign is in the FOR_ENTIRE_CAMPAIGN mode,
      • STANDARD - a default value,
      • PUBLISHER_PRIORITY - campaign will be delivered according to predefined publishers' priorities,
      • PUBLISHER_SHARE - campaign will be delivered according to predefined publishers' shares,

      If the campaign is in the FOR_ENTIRE_CAMPAIGN mode, then the algorithm for the order cannot be defined (algorithm parameter should not be a part of the request). Otherwise, set one of the 3 available values. In case none of them is chosen (parameter is sent with an empty value), STANDARD will be selected as a default value.

    • overMode parameter can take one of the following values: none, NO_OVER, OVER_AFTER_ORDER, OVER_AFTER_CAMPAIGN:
      • none - chosen if the campaign is in the FOR_ENTIRE_CAMPAIGN mode,
      • NO_OVER - overEmit option for the order will be disabled,
      • OVER_AFTER_ORDER - overEmit after order's end date option will enabled,
      • OVER_AFTER_CAMPAIGN - overEmit only after campaign's end date option will be enabled.

      If the campaign is in the FOR_ENTIRE_CAMPAIGN mode, then overMode for the order cannot be defined (overMode parameter should not be a part of the request). Otherwise, set one of the 3 available values. In case none of them is chosen (parameter is sent with an empty value), NO_OVER will be selected as a default value.

    • Please notice that if the campaign is in the FOR_EACH_ORDER mode, then the ASAP feature can be defined with the use of impressionSpeed parameter (impressionSpeed=100).

  Changes in API command response:

  
  

  GetCampaignInfo / GetCampaignsList

  • Removal of the impressionMode response field,
  • New response field: emissionMode - will contain one of the following values: FOR_EACH_ORDER or FOR_ENTIRE_CAMPAIGN.
  • New response field: algorithm - will contain one of the following values: (empty), STANDARD, PUBLISHER_PRIORITY, PUBLISHER_SHARE, ORDER_PRIORITY.
  • New response field: overMode - will contain one of the following values: (empty), NO_OVER, OVER_AFTER_CAMPAIGN.
  
  

  GetOrderInfo / GetOrdersList / GetSurroundInfo

  
  
  • Removal of an impressionMode field from the response.
  • New response field: algorithm - will contain one of the following values: (empty), STANDARD, PUBLISHER_PRIORITY, PUBLISHER_SHARE.
  • New response field: overMode - will contain one of the following values: (empty), NO_OVER, OVER_AFTER_ORDER, OVER_AFTER_CAMPAIGN.
  • Removal of an emissionSettings field from the response.

New template - Interscroller

We are presenting a new creative template which will reveal an ad on a page during scrolling. The ad will take an entire width of the browser viewport. You can set the percentage of the viewport's height that the ad should cover. For more details please visit AdOcean demo page.

adocean api interscroller