Optimize Programmatic Line Item Settings With API

Solveiga
Solveiga
  • Updated

When you run active programmatic campaigns, you can optimize programmatic line item settings to better reach your campaign goals. You can optimize the settings manually or apply recommendations provided by Adform IQ. Adform IQ analyzes your campaign performance data, including KPIs, delivery, remaining flight time, and inventory trends. It then recommends optimization strategies for your programmatic line item settings, specifically for targeting websites and apps, deals, inventory sources, or schedule time slots. It also predicts the potential impact of these changes and forecasts KPI performance if the recommendations are applied.

Tip

For more information about optimizing programmatic line items, see  Optimize Programmatic Line Item Settings and Guide to Programmatic Line Item Optimization.

After you've created a campaign, order, and programmatic line item, you can adjust and optimize line item settings to improve delivery, performance, and efficiency. Optimization becomes available when KPIs are defined, the selected buying strategy aligns with those KPIs, and the line item has collected enough delivery data during its flight.

With the RTB Line Item Recommendations API, you can generate, view, and apply optimization recommendations suggested by Adform IQ or manually optimize your line item settings for targeting websites and apps, deals, inventory sources, and schedule time slots.

With the Recommendation Preferences - Line Items API, you can mark recommendations as ignored to prevent them from appearing again.

Authentication

To authenticate and use Adform APIs, your user account must have the necessary permissions and your OAuth client must have the required scopes assigned to it.

To optimize programmatic line item settings, Adform DSP and Ad Server user account must have these permissions assigned by the business account admin:

  • Manage Campaigns & Orders

  • Manage Programmatic Line Items

Depending on your objectives and workflow, you'll need some or all of the following scopes assigned to your OAuth client by Adform Support (technical@adform.com):

  • https://api.adform.com/scope/buyer.rtb.lineitems.recommendations: Grants access to RTB Line Item Recommendations API.

  • https://api.adform.com/scope/buyer.recommendation.preferences: Grants access to Recommendation Preferences - Line Items API.

Tip

If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.

Prerequisites

To use line item optimization recommendations APIs, use the following IDs in your requests:

ID

Used To

Retrieve From

lineItemId

Specify the line item for which to retrieve available recommendations, generate recommendations manually, o apply recommendations

RTB Line Items Setup API

recommendationId

Specify the recommendation to apply to a line item or to ignore for the user

Provided as part of response body after generating or retrieving recommendations (see steps 1 - 3 in Workflow)

jobId

Specify the applied recommendation job to check its status

Provided as part of response body after applying recommendations (see step 4 in Workflow)

Note

Additional IDs might be used, but the listed ones are required to pass a request.

Workflow

Adform IQ starts generating recommendations one day after a programmatic line item's budget flight begins. New recommendations are generated every three days, or one day after you update the line item's settings. This gives programmatic line items enough time to collect data for optimization strategies. Once recommendations become available, you can use them to optimize line item settings. 

Note

Adform IQ generates recommendations only if the programmatic line items have defined KPIs, buying strategy, and have gathered sufficient data during the budget flight. For more information, see Apply Optimization Strategies.

Tip

To learn how to use Adform APIs, read the Guide to Using Adform APIs.

To optimize programmatic line item settings with RTB Line Item Recommendations API, use these endpoints:

  1. POST Endpoint in RTB Line Item Recommendations API: To retrieve a list of all currently available recommendations for eligible line items across all active campaigns.

  2. GET Endpoint in RTB Line Item Recommendations API: To retrieve current recommendations and supply forecast for a single programmatic line item.

  3. POST Endpoint in RTB Line Item Recommendations API: To generate new recommendations manually for a specific line item.

  4. POST Endpoint in RTB Line Item Recommendations API: To apply recommendations.

  5. GET Endpoint in RTB Line Item Recommendations API: To retrieve the status of applied recommendation jobs.

To mark recommendations as ignored with Recommendation Preferences - Line Items API, use these endpoints:

  1. (Optional) POST Endpoint in Recommendation Preferences - Line Items API: To mark specific recommendations as ignored so they aren't shown again for the same user.

  2. (Optional) GET Endpoint in Recommendation Preferences - Line Items API: To retrieve the list of recommendations that have been marked as ignored by the user.

After you've applied recommendations to optimize programmatic line item performance, you can use reporting and forecasting to monitor the results.

Adform IQ

Was this article helpful?

/
How we can make it better?

Thank you for your feedback!