PING from TrackDrive to Ringba

(also referred to as Real Time Bidding in Ringba)

In TrackDrive - Create PING/POST Buyer

To do a PING/POST on TrackDrive to a Ringba Buyer, you will make use of a PING type of Conversion Setting on the TrackDrive Buyer that you setup.

The easiest way to do this, is to copy the buyer from Templates named “** Ringba RTB Buyer Example”.  From the Setup/Buyers menu option, use the blue button named “New From Template” and copy in the buyer.  Edit the Attribute information to have the correct Number, Buyer ID, Name, etc etc to match your new buyer information.

In the URL of the Webhook URL for the Conversion Settings, there is a section of the URL that says “REPLACE_ME”.  Put the RTB Token from the URL given to you from your Ringba Buyer in that field.

By default, the response they are sending from Ringba, we will check to ensure they are accepting the bid, and if they do we will override buyer Number, Duration, and Revenue with the information they sent on the PING response.

We send two important fields that are needed for the POSTBACK from Ringba which you must define in the system in order for the call to inherit that data.  Those fields are named “trackdrive_call_uuid” and “trackdrive_subdomain”.

Custom Fields:

NOTE: You can read about the IDE setup on Ringba with their own article here.  Data can also be posted to Ringba using the Real Time Bidding Method as well, which is documented in a different support article.

Both TrackDrive and Ringba allow defining custom fields; for example, first_name, last_name, email, etc., to exchange data between any platform via API.  Ringba uses the term “URL Parameters” and TrackDrive uses “Tokens” as terminology referring to Custom Fields. 

NOTE: It is best practice to define the field names you want to use on any platform and try to stay consistent in naming conventions.  For example, always use “first_name” as the custom field name for First Name, and don’t conform to instructions you get from a publisher or buyer and add “firstname” or “fn” as well because they have used those naming conventions. Any platform will allow you to map your field name to their field name and vice versa.

In Ringba - Create Custom Field Names

Ringba has a menu option under Integrations/URL Parameters to setup your custom fields. To add a new URL Parameter, click the “+ CREATE URL PARAMETER” button.

URL Parameter: This is basically the database name for a field.  Most platforms will not allow a space in a field name, so it is normal to use naming conventions like “first_name” or “social_security_number” so that the field name is more easily read with underscores where a space would belong.  In the example above, the field name “trackdrive_call_uuid” and “trackdrive_subdomain”  are being used to pass the TrackDrive Unique ID for the Call to Ringba, so that the optional step of getting a Postback from Ringba to TrackDrive can use that field name.

NOTE: To see how a TrackDrive names standard field names, you may reference the following Posting Instructions.  On TrackDrive, we try to keep the standard field names at the top, and then vertical specific field names at the bottom.  In the example posting instructions, you will see that the field names related specifically to the Medicare Offer are at the bottom of the example.

Reporting Menu Name: If you need this field to appear on reports or select it in Pixels/Webhooks, the Reporting Menu Name field must be set to “User”.

Report Name: This is the friendly name as it will appear on the Reporting Column Headers.  However, any field you want to use in tag filters to trigger pixels to fire, the URL Parameter Name and the Report Name MUST MATCH or the pixel filters will always say they don't match.

By defining these field names, you are able to accept data from TrackDrive.

POSTBACK: Ringba Buyer to TrackDrive Traffic Source

 

 

       

 

 

 

Postback Conversions from Ringba to TrackDrive

(Using “auth_token” Authorization)

 

NOTE: Before a buyer can Postback conversion to TrackDrive, in TrackDrive you must add the Buyer to a Team and turn on the API Permission, then on the Calls section, give permission to update the Buyer Converted, Revenue, Traffic Source Converted, Payout, and Contact Fields (optional, only needed if additional data will come in the Postback payload).

 

In Ringba - Setup Postback Pixel to TrackDrive in the Campaign

 

Ringba has a section of the Campaign Setup for Tracking Pixels, you have the option to use existing Pixels or add a new one, for simplicity, we will only discuss adding a new pixel to be used to send the Postback to TrackDrive when a call converts for the Publisher.  NOTE: Once you have a pixel configured for a Publisher Postback, it can be used on any Campaign in Ringba for a Postback to TrackDrive since we are using the “trackdrive_call_uuid” to do the update to the call, which will allow this to work for any call update on any offer.

 

 

Pictured below is a setup for posting data to TrackDrive when the Publisher converts on a call:

 

 

Name: Add a logical name for this Pixel configuration. For example: " TrackDrive Global Postback for Publisher Chris Jones".

 

Fire Pixel On: Select “Payout” as the trigger point for this pixel to fire.  You will want to set two filters as the Trigger for when the Postback will fire to TrackDrive.  The first will be a filter for the Publisher who is sending you the call, and the second will be a filter to ensure the field named “trackdrive_call_uuid” exists in the call data from an IDE or RTB data post from TrackDrive.

 

URL: Below is the URL to use but you MUST replace the TrackDrive Subdomain:

 

https://TrackDrive_Publisher_Subdomain_Here.trackdrive.com/api/v1/calls/update_call/[tag:user:trackdrive_call_uuid]
 

NOTE: The Filter used above to check if the TrackDrive Call UUID exists assumes that you created the URL Parameters to accept the TrackDrive Subdomain (future need to place a single Postback Pixel to all TrackDrive Publishers) and TrackDrive Call UUID as fields.

NOTE: Ensure that you turn on the Advanced Options so you can change to a Post JSON Protocol configuration as pictured.

 

HTTP Method: Select “POST” as the protocol. 

 

Content Type: Select “application/json” as the Content-type header.

 

Body:

 

(for ease in setting this up, the JSON Payload is below, just fix the fields in squiggly brackets. The tokens in square brackets do not change and you use them exactly as denoted.)

{
    "auth_token": "TrackDrive_Auth_Token_From_Profile",
    "buyer_converted": "true",
    "revenue": "[Call:ConversionPayout]",
    "offer_converted": "true",
    "post_call_tokens": {}
}

 

The JSON Payload above is the minimum setup to use to Postback to TrackDrive from Ringba.  However, more data can be appended if available in the Ringba data.  For example, the “external_buyer_forwarded_duration” may be a custom field a TrackDrive user wants back in the hashed “post_call_tokens” values of the Postback.  However, additional data is usually not sent on Postbacks for most tracking purposes, and the example payload above is all you will need.