Parameters

Prev Next

This section describes the parameters that improve monetization or are required by various authorities and governing bodies. These parameters are to be sent in addition to the parameters needed for each service and described elsewhere in this document (i.e. these parameters do not replace the service’s own parameters).

Partner Token

Also see: Access Token.

In order to prevent unwanted re-use of the parameters from unauthorized parties, Triton Digital recommends encapsulating all parameters in a “partner token" (partnertok or X-Partner-Token). The obfuscation of the data also adds an additional privacy layer for end users.

The format of the partner token is documented in the Triton Digital Secure Token Specification. You will need a private key to sign the token; a unique key is assigned to each publisher or partner. Please reach out to Triton Digital Customer Support to get your private key.

The partner token can be provided in two different ways:

  • In the HTTP query string: use the partnertok parameter.

  • In the HTTP header: use the X-Partner-Token header.

Using the example from the Secure Token Specification, the resulting parameter in a query string would be:

partnertok=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImtpZCI6ImExYjJjM2Q0ZTUifQ.eyJpc3MiOiJwZHZ5Iiwic3ViIjoiZm9vQGJhci5jb20iLCJpYXQiOjE0Mjk4MDI3MTYsInRkLXJlZyI6dHJ1ZX0.YeNcfr7Rcpv4P8Tu6Y2bRuGqYUGQM0lHjyK_nD8SWKA


Using a HTTP/HTTPS header is preferred, to avoid caching and potential truncating issues if the resulting URL is too long.

Once a partner token is generated, it is valid for 24 hours. This value was chosen to avoid generating the token too often, which would delay access to content, thus deteriorating the user experience.

Alternatively, the parameters can be provided in clear text directly in the HTTP query string as independent parameters.

Listener Identification

Note that properly-implemented listener ID management is needed in order to correctly target "addressable" (smart) impressions in Yield-Op.

Also see: Listener ID Management.

Triton Digital supports the following specific types of Listener IDs:

Parameter

Description

Value

lsid

Main user identifier for Triton Digital to use as the basis for measurements and frequency capping.

This parameter is recommended.

See Listener ID Management. for usage details.

String

Alpha-numeric characters, including the following list of special characters:

_ = * + . [ ] { } ( ) ~ -

ppid

Publisher provided listener ID. URL-encoded string.

As above.

idfa

Apple Identifier for Advertisers. (Only use if user has not enabled "Limit Ad Tracking.")

As above.

gaid

Android Advertising ID. (Only use if user has not enabled "Opt out of interest-based advertising.")

As above.

rida

Roku ID.

As above.

aifa

Amazon Advertising ID.

As above.

msai

Microsoft ID.

As above.

app

App-generated ID.

As above.

cookie

Cookie-based ID (server generated). This uses an HTTP cookie and doesn’t require specific support from the player.

As above.

<vendor>-uid

Extended identifier for company specified in <vendor>.
ttd: TheTradeDesk (Unified ID 1.0)
uid2: The TradeDesk (Unified ID 2.0)
ramp: Identity Link.
id5: ID5.
pbjs: PubCommon.
nsf: Neustar Fabrick ID.
ltmpan: Lotame Panorama.

As above.

Listener Information

Additional listener information can be provided via the following parameters:

Parameter

Description

Value

lat

Latitude of the listener's current location.

See Note 1, below.

Floating-point value: -90.0 to 90.0

long

Longitude of the listener's current location.

See Note 1, below.

Floating-point value: -180.0 to 180.0

age

Age of the listener, based on information obtained through listener registration.

Integer value: 1 to 125

gender

Gender of the listener, based on information obtained through listener registration.

m” or “f” or “o” for male, female, or other (case-sensitive)

postalcode

Postal/ZIP code of the listener's home location, based on information obtained through listener registration. See Note 2, below.

Valid postal or ZIP code. E.g., 91403 or H3G 1R8

country

Country Code of the listener's home location, based on information obtained through listener registration. See Note 2, below.

ISO 3166-1 alpha-2 two-letter country code (e.g., US)

Note1

Both lat and long need to be provided together (if you specify one, you need to specify both). When specifying latitude/longitude, clients/players should use the highest precision that is reasonable, depending on the device, platform, and battery usage considerations. (We suggest precision of 100 meters.)

Note2

Both postalcode and country should be provided together.

Regulatory

To bring communication and transparency in line with industry practices with respect to your end users’ consent and the legal basis for processing personal information, all publishers shall implement, to the extent applicable based on the legal jurisdiction relevant to the operations, the following parameters to pass instructions encoding such consent:

Parameter

HTTP Header

Description

Value

gpp *

X-gpp

GPP string allowing the transmission of privacy, consent, and consumer choice signals. The string must comply with the IAB Tech Lab Global Privacy Platform specification.

Url-safe base64-encoded GPP string.

gpp_sid *

X-gpp-sid

Section ID to indicates which legislation (i.e., section of the GPP string) is considered “in force”.

Integer

gdpr *


Flag indicating if General Data Protection Regulation (GDPR) regulations apply. GDPR was established by the European Parliament and the Council of the European Union.

0 = GDPR does not apply

1 = GDPR applies

gdpr_consent *

X-gdpr-consent

GDPR transparency and consent string encapsulating relevant details about how transparency and consent was established. The string must comply with the IAB Transparency and Consent Framework specifications.

URL-safe base64-encoded GDPR consent string.

us_privacy


U.S. Privacy String that signals whether or not the U.S. Privacy Regulations apply to the consumer, if an “explicit notice” legal disclosure has been established with a consumer, and if the consumer has chosen to opt out of the sale of their personal data. Version 1 only supports signals pertaining to the California Consumer Privacy Act (CCPA). The string must comply with the U.S. Privacy String format.

String

coppa


Flag indicating if Children's Online Privacy Protection Act (COPPA) regulations apply. COPPA was established by the U.S. Federal Trade Commission.

0 = COPPA restrictions do not apply

1 = COPPA restrictions apply

* In connection with GDPR, Triton Digital is a registered and approved vendor under the Global Vendor List (GVL) TCF v2.0. maintained by the Interactive Advertising Bureau Europe (IAB Europe). Triton Digital’s GVL vendor ID is 239.

Device/Player Information

Parameter

Description

Value

dist

This parameter is used to identify the distribution channel. (I.e., digital property where the listener accesses the audio content.)

String. Any string can be entered. Character limit is 50.

banners

Banner capabilities flags.

This item is currently used for statistical analysis by Triton Digital but is expected to assume a more direct role in the future.

String: comma-separated list of supported banner sizes. For example: banners=728x90,300x250

omid

Flag indicating if player supports the Open Measurement Interface Definition API (usually via the OMSDK), and which version. This parameter can only be provided via the partner token.

0 = OMID is not supported

1 = OMID 1.0 is supported

store-id

Only for mobile app inventory.

App store identifier for an installed app, used to locate the app within the specific store.

Example for iTunes:

store-id=726533955

Example for Google Play:

store-id=com.tritondigital.tritonradio

This parameter is required by programmatic buyers to verify Triton Digital is allowed to sell your inventory using the app-ads.txt framework.

String

bundle-id

Only used for mobile app inventory, where it is required.

Application identifier intended to be unique to the app and independent of the app store where it was distributed.

On Android and iOS, this should be a package name (e.g., com.tritondigital.tritonradio).

String

store-url

Only for mobile app inventory.

App store URL for an installed app making the ad request/stream connection.

The string must be URL encoded.

Example:

store-url=https%3A%2F%2Fplay.google.com%2Fstore%2Fapps%2Fdetails%3F1d%3Dcom.tritondigital.tritonradio

This parameter is required by programmatic buyers to verify Triton Digital is allowed to sell your inventory using the app-ads.txt framework.

URL encoded string of a URL.

agent

The specific agent/player (software) that is used to play the audio stream/file.

String. To obtain valid values for your agent/player, contact your Triton Digital account manager.

agent-family

The type/family that best describes a specific agent/player.

String. Valid values are:

browser
monitoring
player-custom
player-generic
podcast

agent-device

The specific device (hardware) that is used to play the audio stream/file. Although this is optional, Triton Digital recommends using it, since the device can’t always be derived properly from the default "user agent" header.

String.

Valid Values:

amazon-echo

android-asus

android-auto

android-blu

android-generic

android-htc

android-huawei

android-lenovo

android-lg

android-motorola

android-oneplus

android-oppo

android-samsung

android-sony

android-xiaomi

android-zte

appletv

archos

blackberry

blackberry-generic

bose

carplay

chromebook

chromecast

desktop

google-home

googletv

gracedigital

ios-generic

ipad

iphone

ipod

nokia-generic

palm-generic

panasonictv

philipstv

playstation

playstation3

playstation-vita

ps4

roku

samsung-av

samsungtv

sharptv

sonos

squeezebox

technisat

tesla

vtuner

wiiu

winphone-generic

xbox-one

agent-device-family

The type/family that best describes a specific device.

String.

Valid Values:

car

computer

console

dmp

mobile

smarttv

tablet

agent-os

The Operating System that is used to play the audio stream/file. Although this is optional, Triton Digital recommends using it, since the operating system can’t always be derived properly from the default "user agent" header.

String.

Valid Values:

android

bbos

chromeos

ios

linux

macosx

palmos

tizen

windows

winphone

Agent-based device/player parameters can be checked by using the validators listed in the Formatting Targeting Rules in the Triton Digital Booking and Avails APIs document, under Listener Targeting - Player/Device.

Custom Targeting

Publishers who want to differentiate their inventory into custom segments can use the following parameters.

Parameter

HTTP Header

Description

Value

csegid

Custom Segment ID.

Before implementing this, contact Triton Digital Customer Support to enable Custom Segment ID Targeting in your account. Currently, Custom Segment ID Targeting only works with Tap advertising (it is not supported by Yield-Op).

Integer value: 1 to 1000000

ttag

X-ttag

Custom targeting tags that you can match independently in TAP or Yield-Op.

A suggested practice is to send a comma-separated list of tags, using a format such as <key>:<value> for each tag.

Example: ttag=vehicle:ford,vehicle:suv

Note that the use of a comma-separated tag list and key:value pairs based on a colon separator ( : ) is just a suggestion; other characters will also work, although some special characters might cause problems and spaces should not be used. Also, commas ( , ) are not a good choice within each tag because the TAP user inteface where TTags are entered for flight targeting interprets commas as tag separators, making it difficult for traffickers to enter a tag such as vehicle,ford (it would be interpreted as two separate tags; vehicle and ford).

See TTags Usage Example.

Alphanumeric characters plus UTF-8 symbols. Note that "&" and "=" are not valid characters.

dmp-segments

X-dmp-segments

Identifiers for third-party DMP segments which the listeners belong to.

CSV list of segment IDs. For example:
dmp-segments=46,47,48,49,50,52,53,54,55

N/A.

X-DMP-Segment-IDs

Identifiers for third-party DMP segments which the listeners belong to.

This version of the segments parameter is only used for specific DMP integrations that leverage the player and/or SDK. For more information about when and how to use this feature, speak with your Triton Digital Client Success Manager.

This parameter is not supported in partner token or HTTP query string.

DMP name (e.g., "dmp_1_name") and comma-separated segment IDs (e.g., 123,234,345).

Example for the DMP Blork Audience with segment IDs 1234 and 5678: and DMP ACME Segmenter with segment IDs 4321 and 8765:

{"blork_audience":[1234,5678], "acme_segmenter":[4321,8765]}

TTags Usage Example

You have a custom in-dash player for motor vehicles. You define the type of vehicle in the player with custom TTags so that ad campaigns in Tap can target that vehicle. If, for example, your player is in a Ford four-wheel-drive SUV, you can create the following custom TTags:

ttag=vehicle:ford

ttag=vehicle:4wd

ttag=vehicle:SUV

Parameter for the above example:

ttag=vehicle:ford,vehicle:4wd,vehicle:SUV

As a result, the player will accept ads from Tap campaigns that target:

  • All Ford vehicles.

  • All four-wheel-drive vehicles.

  • All SUVs.

  • Specifically Ford four-wheel-drive vehicles.

  • Specifically Ford SUVs.

  • Specifically Ford four-wheel-drive SUVs.

It will not accept specific targeting of other brands of vehicles, or specific targeting of Ford two-wheel-drive vehicles, etc.

Tip (Streaming Radio)

If you have access to your station's radio automation system, you can use content targeting metadata cart triggers/cue points to target your Tap flights to specific live streaming content. For more information, see the Triton Digital knowledge base article Using Content Targeting Cue Points to Target a Livestream Show.