7.7.11 Media Integration API - How to create your own integration between ADvendio Connect and any Third Party Media Systems

Version	2.165 and up
License Plan / Edition	ADvendio One

1.1. What is the ADvendio Media Integration API?

The ADvendio Media Integration API is a set of standardized API interfaces for the ADvendio Connect Module. These APIs allow us to handle the communication and integration of Third Party Systems into ADvendio more efficiently and help to cover the different needs for your digital media and media buying-related processes.

1.2. What can you do?

Our approach is focused to standardize the process of system integrations into ADvendio. The big advantage for you as a customer is not only that we’re building integrations faster and more stable, but that you can also use these API services.

Use the Media Integration API to create your own connections between ADvendio and external platforms like AdServers, SSPs, DSPs, Data analytic platforms and more! Here is a list of use cases, where ADvendio Media Integration API can support you for your own Third Party Integrations:

Create bookings based on your ADvendio Media Campaigns or Media Buying Data to help your Ad Ops team seamlessly fulfil your advertising needs
Automatically import delivery, revenue, and cost Information for your bookings, in order to view campaign performance in ADvendio, invoice based on delivery & media spend and reconcile your media buying cost against planned budgets
Sync the current status of your bookings to ADvendio so you can directly see which ones are live and delivering and which might need more attention
On-the-fly availability checks
Sync advertiser, inventory and audience data from Third Party Platforms into ADvendio in order to use these in different ADvendio booking features

1.3. What is required to use Media Integration API and which Services are available?

To start using the ADvendio Media Integration API you will need the following:

ADvendio Version 2.164 or up
An ADvendio One License

To create the integration you will need to set your own server-side REST web services using ADvendio's Media Integration API definitions.

Media Integration API calls are standardized requests and responses that are currently being used by all of our newest ad server integrations. We are also migrating our existing integrations into Media Integration API complaint, independent REST web services.

ADvendio Media Integration API structure

A diagram of the communication between the ADvendio API and a Third Party System using a custom-made integration

Service	ADvendio Feature	Use Cases	Relevant for

Service	ADvendio Feature	Use Cases	Relevant for
Checklogin	Check login / Authentication	Authenticate against Third Party API / Login check from ADvendio	All types of integration
Report	Delivery Reports (Lifetime, Monthly & Daily) Sitebased Delivery Data Buying Delivery Reports	Automatically update the delivery data for your Selling or Buying bookings in ADvendio	All types of integration
Booking	Submit to AdServer (Media Campaigns / Campaign Items)	Use Advendio Media Campaigns and Campaign Items managed by your Sales Team to create bookings for your Third Party System	Media Selling Integration
Import	Transfer to ADvendio	Schedule an automated import of Third Party Data, such as Advertiser data, targeting IDs or inventory data for your product configuration	Media Selling Integration & Media Buying Integration
Ad Status Update Pull	Automatic Status Updates	Automatically sync the current status of your bookings back to ADvendio	Media Selling Integration
Forecast	Check Availability	Use your ADvendio Item configuration to check if your items are available for booking	Media Selling Integration
Submit Buying Order	Media Buying Submit	Use Media Buying data managed in ADvendio to create bookings for a Third Party Media Buying System	Media Buying Integration
Available with March 2024 (2.170) Creative	Creative Upload (+Assignment and Removal)	Use this to upload Ad Creatives, handled via ADvendio into a Third Party Booking Platform and manage the assignment to Line Items.	Media Selling Integration

1.4. How to gain access to the technical API documentation?

You are interested in using the ADvendio Media Integration API to build you own integrations? Great! In order to go ahead you will need to set up the custom integration in your ADvendio Org and then proceed to develop a custom integrations service which will handle the communication with Third Party Systems. You can orient on the guidance we provide on this page.

In order to gain access to the full technical documentation, please contact your Technical Account Manager or our Customer Success Team, so we can provide you with the required material.

1.5. How to start a Custom Integration?

So if you want to build your own Integration between ADvendio and a Third Party Media Platform, it will help to first decide for which cases you want to cover. Roughly we differentiate, between Reporting Only, Sales/Booking Integrations and Media Buying Integrations.

Type	What it can do	Why this Integration Type?	ADvendio Media Integration API Services

Type

What it can do

Why this Integration Type?

ADvendio Media Integration API Services

Reporting Only

Let ADvendio automatically update delivery information for your Campaign Items or Buying Items
Users need to manually set up Campaign Items / Buying Items and provide them with the required Line Item ID to be considered during reporting.

If you want to automatically track Campaign KPI for your Positions in ADvendio
Use the data for invoicing or account related processes
If you’re not planning to dynamically book from ADvendio
Can be used for Sales Integrations and Media Buying Integrations alike

Report
Ad Status Update Pull

Media Sales and Booking Integration

Additionally to reporting only:

Use ADvendio Sales features (such as Inventory Management, Price Rules, Packages, Campaign Builder) to manage your products and inventory for the Third Party booking system
Use ADvendio Media Campaigns and Campaign Items to create bookings for your third party system
Use ADvendio to get on the fly availability checks based on your Campaign Items

If you want to have to possibility to prepare your Sales Campaigns in ADvendio and have your users directly create bookings for your Sales System from ADvendio
Optionally also let your users check the availability of a planned booking from ADvendio before continuing the process

Report
Booking
Ad Status Update Pull
Import
Forecast

Media Buying Integration

Additionally to reporting only:

Use the ADvendio Media Buying features to plan Budgets and set up your Media Buying.
Create bookings for your Third Party Buying platform, based on ADvendio Buying Orders and Buying Items.

If you want your users to create Orders and Items directly in ADvendio and then push them to a Media Buying Platform, to continue the process of setting the booking live there

Report
Submit Buying Order
Buying AdStatus Pull

In order to actively start working on your custom Integration, you will then need to set up the custom connection in your ADvendio environment. Find out more on the steps required:

https://advendio.atlassian.net/wiki/spaces/SO/pages/3423436825