Buyer Ping Templates

Reviewed ping setups for common buyer platforms, each filling in a buyer's ping from the few account values it asks for.

GET /buyer_ping_templates

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/buyer_ping_templates

List buyer ping templates.

Returns every buyer ping template with its key, name, description, and the inputs and secrets a ping from it asks for. An input whose required is false may be left out.

GET /buyer_ping_templates/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/buyer_ping_templates/:id

Get a buyer ping template by key.

Returns one buyer ping template by key, with the inputs and secrets a ping from it asks for. An input whose required is false may be left out.

Params

Param name Description
id
Required

The template’s key, as the list of templates returns it, such as ringba_rtb.

  • Must be a String

POST /buyer_ping_templates/:buyer_ping_template_id/pings

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/buyer_ping_templates/:buyer_ping_template_id/pings

Create a buyer's ping from a template.

Creates a ping on a buyer from a template, with the request, acceptance rule and response paths filled in from the template and the account values given. Any secret values given are saved as new Secrets. A template is refused on a buyer whose Trackdrive post it would conflict with. Restricted to account superusers.

Params

Param name Description
buyer_ping_template_id
Required

The template’s key, as the list of templates returns it, such as ringba_rtb.

  • Must be a String
buyer_id
Optional Blank value allowed

The buyer the ping is added to.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
inputs
Optional Blank value allowed

The template’s inputs, keyed by each input’s key, such as {“campaign_id”: “CA9f”}.

  • Must be a Hash
secret_values
Optional Blank value allowed

A value for each of the template’s secrets, keyed by the secret’s key. Each is saved as a new Secret.

  • Must be a Hash
secret_keys
Optional Blank value allowed

For a secret already saved on the account, the saved Secret’s key, keyed by the template secret’s key.

  • Must be a Hash
conversion_setting_id
Optional Blank value allowed

The buyer’s conversion setting the ping is added to. Without one, the buyer’s first is used, and a buyer with none gets one that is always open.

  • Must be an 8-bit integer ID or a 128-bit UUID reference to an object on Trackdrive. Example ID: 289302820, Example UUID: 924c37d5-e70f-42ad-84c2-e85eb0c1bc21