7.7.11.1 How to set up and test a Custom Integration to ADvendio Connect?
Version | 2.165 and up |
|---|---|
License Plan / Edition | ADvendio One |
Steps to Create and Setup Custom Integration
Step 1: Prepare Salesforce Configuration and Record Types
Use a record type called: CUSTOM on the object Connection, Connection ID & Ad Type
Important:
Make sure you have sufficient permissions updated for this action
You might want to create custom page layouts for the fields
Step 2: Setup Custom Integration
How do you set up the connection to Custom Integration in ADvendio?
To start using the ADvendio Custom Integration, you will need to set up a new record type Custom.
Please, follow the steps below:
In the main ADvendio menu search and click on the Connections option
Create a new connection record by selecting the option “New”
Select CUSTOM as a new record type
A window New Connection: CUSTOM will open, enter data in the field “User Name” (mandatory), a password, etc.
Fill in necessary fields needed for your integration: user name, password, etc
You can store required credentials in the fields depending on what information you might need.
Each Connection record created can be used for ONLY one Custom integration. But you can create as many custom Connection records as you need.
Step 3: Setup Service Endpoint for the Custom Integration
To finalize the preparation of your custom integration:
In the Custom Endpoint field enter the endpoint URL (this is a link to your hosted web server which is handling the communication with the Third Party System and will receive HTTPS requests in ADvendio Media Integration API format).
Click Save
Please use the field: Custom Endpoint on your Connection record for this.
Step 4: Use the Checklogin Service for Authentication
When the connection is set up, you can start creating an authentication process for the Third Party System of your choice. For this, you will need to create a web service that accepts requests defined in our Check Login Interface, according to our Service documentation.
We offer you several fields to store required credentials like:
User Name
Password
Additional Username
Additional Password
Access Token
Network ID
In case the authentication requires one or more sets of credentials feel free to use the field you need and leave the others empty in ADvendio.
Once your web service is uploaded (and defined in the Custom Endpoint URL you provided), use the button ‘Check Login’ for a test from ADvendio.
If the feature works properly you should receive a message stating ‘Login successful!’
In order to gain access to our full Service Interface documentation please contact your Technical Account Manager or our Customer Success Team.
Step 5: Prepare Media Inventory and other features
Depending on what features you need to use you can set up Inventory, Media Buying and other ADvendio features.
To use Campaign Items for the Custom Integration (for Delivery Reports or for bookings) CIs need to be related to an AdType which is related to your Custom connection.
For Media Buying: your buying orders need to be related to the custom connection record.
Selling and Media Buying Examples
Media Selling
Follow these steps:
Create a custom Ad Type record in ADvendio, and set the fields based on your integration needs. ADvendio API provides a variety of fields for integration, and you can choose which ones to use.
After creating the Ad Type, create a new Ad Spec and use the Ad Type you created, along with a Site and Placement. If necessary, create new Sites & Placements, but note that the setup does not directly affect your custom integration.
Create an Ad Price for your Ad Spec to determine how you want to sell your Ad and make sure the Ad Price is active and set to true.
Finally, create a Media Campaign, select an account you want to use as an Advertiser and choose your Ad Spec in the Media Search to create a Campaign Item for testing your custom integration.
Media Buying
Create a Buying Order and assign it to the Custom Connection record you've created, follow these steps:
Select an Advertiser that you want to create a Buying Order.
Set up the required fields for the Buying Order according to how they are used in your Custom Integration.
Once the Buying Order is set up, create a Buying Item by clicking on the "New Item" button.
Fill in the required fields for the Buying Item, such as the product name, quantity, dates and price.
Save the Buying Item and the Buying Order.
Advertiser Data on Accounts
To create an Account in Salesforce that represents the Advertiser you want to use in the third-party system follow the steps:
Log in to your Salesforce and navigate to the Accounts tab.
Click the "New" button to create a new Account.
Fill in the required fields for the Account, such as Record Type, Account Name, Address, Vat, Billing, Revenue and Contact Information.
Save the Account.
As mentioned above ADvendio will provide the name of the created Account in the API request for booking by default, but you can create an External Account ID to store a specific ID number if desired.