Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Fields

supply_tag_

Key:Values associated with the event. This field is a JSON object with String keys and String values, e.g.

IndexField NameField Data Type

Field Description

1ymdhtimestampTimestamp of the event, in UTC, in ISO format. The character "T" serves as the separator between Date and Time parts. Format: YYYY-MM-DDTHH:MM:SS2account_idintSpringServe supply tag Springserve account ID
32demand_tag_idintSpringServe demand tag ID
43campaign_idint

SpringServe campaign ID

54creative_idintCurrently not used
65auction_idString (UUID)Unique ID identifying an auction; different events can be tied together through their auction ID
76user_idString (UUID)User's SpringServe cookie ID
87user_ipStringIP address of the user
98user_agentStringFull user-agent string of the user
109countryString (max length 2)Country code (e.g. "US", "GB", "DE")
1110full_page_urlString

Full-page url that is declared on the incoming ad request.

1211declared_player_sizeString (max length 7)

Declared player size. Sizes are based on width and are defined by the following boundaries:

  • <= 0 - "unknown"
  • 1 <= w <= 249 - "x-small"
  • 250 <= w <= 349 - "small"
  • 350 <= w <= 500 - "medium"
  • 501 <= w <= 799 - "large"
  • 800 <= w - "x-large"
1312detected_player_sizeString (max length 7)Player size detected by our VPAID. Same boundaries as declared_player_size14key_valuesJSON
Code Block
 {"our_campaign_id": "123", "user_segment": "high_value_users"}
1513js_impressionsintImpression served (JS VPAID)1614clicksintVideo ad is clicked on by user1715costnumeric(16,10)Media cost the SpringServe account pays the supply partner (for this event)1816revenuenumeric(16,10)Revenue the SpringServe account is paid by the demand partner (for this event)1917third_party_feesnumeric(16,10)Any third party fees for the demand partner (for this event)2018first_quartileintVideo ad has played through 1/4 of its duration.2119second_quartileintVideo ad has played through 1/2 of its duration.2220third_quartileint

Video ad has played through 3/4 of its duration.

2321fourth_quartileintVideo ad has played through its entire duration.2422ad_requestsint(Demand-side event) Fired any time our VPAID requests a demand tag's VAST endpoint URL2523has_adsint(Demand-side event) VAST endpoint URL responds with a non-empty VAST response2624opportunitiesint

(Demand-side event) Indicates the VPAID received a non-empty VAST response / media file back from VAST endpoint URL, and initiated it

2725errorsint(Demand-side event) Indicates an error occurred with the demand tag. Most common case is due to the demand not filling or our VPAID timing out the demand tag2826device_id_hashedString (max 40)User device identifier for Mobile and Connected TV's, stored hashed for privacy compliance 2927pcdma_user_idString (max 128)30dma_idint31intID corresponding to Demographic Market Area (DMA)28postal_codeString (max 16)32

Postal code for US & CA traffic only.

29stateString (max 7)
3330CityString (max 64)
3431startsintVideo ad started3532app_nameString (Max 256)App name as it is sent from the supply request3633app_bundleString (Max 256)App bundle as it is sent in the supply request3734spotx_channel_idint
3835adomainString (Max 128)39Advertiser domain36duplicate_impressionsintImpressions that are duplicate (ie. same impression beacon fired more than once)4037bid_price_actualnumeric(16,10)Non-price reduced bid value as returned in the bid response from a demand partner4138bid_price_reducednumeric(16,10)Price reduced bid value4239device_idstring (max 40)The user specific Device Identifier, ex: AAID, RIDA, IFA4340coppabooleanWhether supply is COPPA compliant (1) or not (0). Determined by the presence of the corresponding parameter in the ad request.4441us_privacybooleanWhether Supply is CCPA compliant (1) or not (0). Determined by the presence of the corresponding parameter in the ad request.4542dntbooleanDo Not Track enabled (1) or not (0). Determined by the presence of the corresponding parameter in the ad request.4643gdprbooleanWhether Supply is GDPR enabled (1) or not (0). Determined by the presence of the corresponding parameter in the ad request.4744lmtbooleanLimit Ad tracking enabled (1) or not (0). Determined by the presence of the corresponding parameter in the ad request.4845app_idintThe app_id from the incoming dsp_data object4946content_idintContent ID passed in the content_data object5047detected_adomainstringDetected advertiser domain value5148publisher_namestringRTB publisher name field5249publisher_idString (Max 38)RTB publisher ID field5350inventory_sourcestringSource of the supply5451languagestringLanguage of the content5552app_idstringRTB app_id from the incoming dsp_data object5653content_custom1_paramstringCustom parameter for content macros that may not be covered in the standardized content macros5754content_custom2_paramstringCustom parameter for content macros that may not be covered in the standardized content macros5855content_custom3_paramstringCustom parameter for content macros that may not be covered in the standardized content macros5956content_episodestringEpisode name of the content6057content_genre_liststringGenre of the content6158content_producer_namestringProducer of the content59declared_domainString (max length128)Declared domain on the incoming ad request.60event_typeString (max length 128)
61opportunity_response_timebigintAmount of time it takes for the demand tag to fill an impression. This is the time between an ad_request event and an impression event.