Yes-Bid Log Fields

Yes-Bid Logs Schema

Name

Type

Is Nullable

Description

uuid

string

true

The unique BidSwitch ID of this user. For in-app traffic the lowercase IDFA, or Android ID is used

request

record

false

request.datetime

string

false

bid_context_wrapper

record

false

bid_context_wrapper.bid

record

false

bid_context_wrapper.bid.id

string

false

The unique bid request ID, generated by the client

bid_context_wrapper.bid.time

integer

false

The bid event timestamp: seconds since epoch

bid_context_wrapper.bid.datetime

string

false

The bid event timestamp, YYYY-MM-DD HH:MM:SS

bid_context_wrapper.bid.ssp

string

false

Supplier identification string, e.g. rubicon

bid_context_wrapper.user

record

false

bid_context_wrapper.user.ip

string

false

Specifies the IPv4 address closest to the device, string 0.0.0.0 is used if unknown

bid_context_wrapper.user.languages

array of strings

false

The Alpha-2/ISO 639-1 code of browser language, e.g. en. Either an empty array or an array containing one value

bid_context_wrapper.user.segments

array of strings

false

A list of pixel segments associated with the user ID

bid_context_wrapper.user.audience_segments

array of strings

false

A list of audience segments associated with the user ID

bid_context_wrapper.user.gender

string

true

Specifies the user gender, e.g. F

bid_context_wrapper.user.yob

integer

true

The year of the user’s birth as a 4-digit integer, e.g. 1977

bid_context_wrapper.user.ifa

string

true

The native identifier for advertisers. An ID assigned by the device or browser for use as an advertising identifier, for example Apple’s IDFA or Android’s Advertising ID

bid_context_wrapper.user.lat

float

true

Latitude from -90 to 90 (South is negative), e.g. 52.35

bid_context_wrapper.user.lon

float

true

Longitude from -180 to 180 (West is negative), e.g. 4.9167

bid_context_wrapper.user.carrier

string

true

A carrier or an ISP derived from the IP address, e.g. WIFI

bid_context_wrapper.user.connectiontype

string

true

A connection type value, one of the following: Unknown, Ethernet, WIFI, Cellular Network - Unknown Generation, Cellular Network - 2G, Cellular Network - 3G, Cellular Network - 4G

bid_context_wrapper.user.dnt

integer

true

Do not track. 1 - true, 0 - false

bid_context_wrapper.user.mccmnc

string

true

A mobile carrier as the concatenated MCC-MNC code, e.g. 310-005

bid_context_wrapper.user.ec_geo

record

false

bid_context_wrapper.user.ec_geo.country

string

false

The ISO code of the country matching the user’s IPv4 address, e.g. GB

bid_context_wrapper.user.ec_geo.region

string

false

The ISO code of the first subdivision of the address matching user’s IPv4 address, e.g. ENG

bid_context_wrapper.user.ec_geo.subregion

string

true

The ISO code of the second subdivision of address matching user’s IPv4 address, e.g. ‘LND’, an empty string if not applicable

bid_context_wrapper.user.ec_geo.city

string

false

The name of the city (in English) matching the user’s IPv4 address, e.g. London

bid_context_wrapper.user.ec_geo.dma

integer

false

The metro code of the address matching the user’s IPv4 address, e.g. 803

bid_context_wrapper.user.ec_geo.zip

string

false

The postal code of the address matching the user’s IPv4 address, e.g. 92509

bid_context_wrapper.user.ec_geo.country_region

string

false

Concatenation of the country, the first subdivsion and the second subdivision of the address, e.g. GB-ENG-LND

bid_context_wrapper.user.ec_geo.geo_isp

string

true

The Internet Service Provider associated with the user’s IPv4 address, e.g. Spectrum

bid_context_wrapper.user.ec_geo.digital_element_country

string

false

The two letter code of the country matching the user’s IPv4 address, e.g. UK

bid_context_wrapper.user.ec_geo.digital_element_region

string

false

The ISO code of the region of the address matching the user’s IPv4 address, e.g. LND

bid_context_wrapper.user.ec_geo.digital_element_city

string

false

The name of the city (in English) matching the user’s IPv4 address, e.g. London

bid_context_wrapper.user.ec_geo.digital_element_postal_code

string

false

The postal code of the address matching the user’s IPv4 address

bid_context_wrapper.user.ec_geo.digital_element_postal_ext

string

false

The postal code ext of the address matching the user’s IPv4 address

bid_context_wrapper.user.ec_geo.digital_element_country_region

string

false

Concatenation of the country and region of the address, e.g. ‘UK-LND’

bid_context_wrapper.user.ec_agent

record

false

bid_context_wrapper.user.ec_agent.device

record

false

bid_context_wrapper.user.ec_agent.device.type

string

false

The device type associated with the device’s user agent string

bid_context_wrapper.user.ec_agent.device.maker

string

false

The device maker associated with the device’s user agent string

bid_context_wrapper.user.ec_agent.device.model

string

false

The device model associated with the device’s user agent string

bid_context_wrapper.user.ec_agent.os

record

false

bid_context_wrapper.user.ec_agent.os.name

string

false

The operating system name associated with the device’s user agent string

bid_context_wrapper.user.ec_agent.os.version

string

false

The operating system version associated with the device’s user agent string

bid_context_wrapper.user.ec_agent.browser

record

false

bid_context_wrapper.user.ec_agent.browser.name

string

false

browser name associated with device’s user agent string

bid_context_wrapper.user.ec_agent.browser.version

string

false

The browser version associated with the device’s user agent string

bid_context_wrapper.supply

record

false

bid_context_wrapper.supply.slot_id

string

false

The ID of the impression being shown, unique within the bid request, e.g. 1

bid_context_wrapper.supply.site_page

string

false

The URL of the site.page, e.g. dailymail.co.uk?kw=153a. This string is empty in in-app requests

bid_context_wrapper.supply.ec_site_domain

string

false

The host part of the URL from either the site.domain or the app.domain field of the request, e.g. aol.com

bid_context_wrapper.supply.ec_page_domain

string

false

The host part of the URL from the site.page, e.g. dailymail.co.uk. This string is empty in in-app requests

bid_context_wrapper.supply.publisher_id

string

false

An exchange specific identifier consisting of the Supplier exchange name, and the publisher ID attached with an underline, e.g. rubicon_25

bid_context_wrapper.supply.site_id

string

false

An exchange specific identifier consisting of the Supplier’s exchange name, and the target site ID (for website requests) or the application ID (for in-app requests) attached with an underline, e.g. rubicon_123

bid_context_wrapper.supply.topframe

string

false

Indicates if the banner is in the top frame as opposed to an iframe. 1 - true, 0 - false. An empty string means that topframe is not applicable

bid_context_wrapper.supply.visibility

string

false

Ad Position as defined in the OpenRTB protocol, one of the following: UNKNOWN, ABOVE_THE_FOLD, ABOVE_OR_BELOW_THE_FOLD, BELOW_THE_FOLD, HEADER, FOOTER, SIDEBAR, FULLSCREEN

bid_context_wrapper.supply.is_secure_request

boolean

false

Specifies if the page is SSL compliant: true if secure, false if insecure (false being the default value)

bid_context_wrapper.supply.blocked_adv_categories

array of strings

false

Blocked Advertiser Categories listed in the IAB taxonomy and extended with additional sensitive categories, e.g. IAB10-1, IAB25, BSW3. Creatives belonging to at least one of the listed categories are banned from bidding on the given request.

bid_context_wrapper.supply.is_app

integer

false

Indicates if the request has an app section. 1 - yes, 0 - no

bid_context_wrapper.supply.content_categories

array of strings

false

An array of IAB content categories for the impression or the publisher site (for in-app), e.g. IAB1, IAB2-3

bid_context_wrapper.supply.pub_categories

array of strings

false

An array of IAB content categories for the publisher, e.g. IAB1, IAB2-3

bid_context_wrapper.supply.s2s_call

boolean

false

Specifies the notification type(s) supported by the supplier: false for only browser (u2s) notifications, true for both browser and server-to-server (s2s) notifications

bid_context_wrapper.supply.requested_sizes

array of strings

false

An array of sizes (wxh) that may be used for bidding on banner creatives

bid_context_wrapper.supply.grapeshot_channels

array of strings

false

Grapeshot channels applicable to the bid request coming either from a site page or an app bundle, e.g. gs_entertain, gv_safe

bid_context_wrapper.supply.source_name

string

true

The site or the application name, e.g. Test application

bid_context_wrapper.supply.app_bundle

string

true

The application bundle or package name, e.g. com.example.mygame. This string is empty in website requests

bid_context_wrapper.supply.content_type

string

false

The creative type, either display (default), video or native (in case a video/native object is present in the request)

bid_context

record

false

bid_context.demand

record

false

bid_context.demand.client_id

integer

true

The numeric ID of the client for whom the request was intended

bid_context.demand.advertiser_id

integer

false

The numeric ID of the advertiser associated with the client and the creative

bid_context.demand.campaign_id

integer

false

The numeric ID of the campaign associated with the client and the creative

bid_context.demand.line_item_id

integer

false

The numeric ID of the line item associated with the client and the creative

bid_context.demand.creative_id

integer

false

The numeric id of the creative

bid_context.demand.strategy_id

integer

true

The ID of the optimization strategy used

bid_context.demand.can_track_clicks

boolean

false

The value of the ‘can_track_clicks’ creative field

bid_context.demand.creative_size

string

false

Concatenation of width, ‘x’ symbol and height creative fields, only ‘x’ with missing width and height

bid_context.demand.creative_viewability_vendors

array of strings

false

An array of viewability vendors

bid_context.demand.bid_amount

double

false

The bid amount value in the bid currency

bid_context.demand.deal_id

string

true

The deal ID, e.g. AA-1234

bid_context.demand.tag_type

string

false

Either iframe (default) or video (if a video object is present in the request)

details

record

false

details.ssp_bid_id

string

false

The unique ID of the bid request, provided by BidCore, e.g. b5ba5ed2-547e-4e86-8a84-34a440dad6db

details.selleruid

string

true

The unique BidSwitch ID of this user

Yes-Bid Logs Example

{
   bid_context_wrapper:
   {
      bid:
      {
         datetime: '2021-01-31 00:15:03'
         id: '602d8289-fcf0-4762-af9f-ce800a23a29d'
         ssp: 'triplelift'
         time: 1612052103
      }
      user:
      {
         ip: '98.127.90.141'
         segments:
         [
         ]
         lon: None
         yob: 0
         connectiontype: 'Unknown'
         mccmnc: None
         languages:
         [
            'en'
         ]
         dnt: None
         carrier: None
         ifa: None
         ec_agent:
         {
            device:
            {
               model: 'Motorola_Other'
               type: 'Phone'
               maker: 'Motorola'
            }
            os:
            {
               version: 'Android_8'
               name: 'Android'
            }
            browser:
            {
               version: 'Chrome_88'
               name: 'Chrome'
            }
         }
         gender: ''
         lat: None
         ec_geo:
         {
            dma: 751
            digital_element_postal_ext: '8129'
            digital_element_postal_code: '82070'
            zip: '82070'
            city: 'Laramie'
            country: 'US'
            region: 'WY'
            geo_isp: 'Spectrum'
            digital_element_city: 'laramie'
            subregion: ''
            digital_element_country: 'us'
            digital_element_region: 'wy'
            digital_element_country_region: 'us-wy'
            country_region: 'US-WY-'
         }
         audience_segments:
         [
         ]
      }
      supply:
      {
         s2s_call: False
         pub_categories:
         [
         ]
         site_page: 'https://thechive.com/2020/12/30/what-the-hell-am-i-looking-at-here-23-photos/'
         grapeshot_channels:
         [
         ]
         blocked_adv_categories:
         [
            'BSW1'
            'BSW10'
            'BSW2'
            'BSW4'
            'IAB25-3'
            'IAB26'
            'IAB9-9'
         ]
         site_id: 'triplelift_35940'
         visibility: 'UNKNOWN'
         ec_site_domain: 'thechive.com'
         requested_sizes:
         [
            '300x250'
            '320x50'
            '300x250'
            '300x50'
         ]
         content_categories:
         [
            'IAB1'
            'IAB10'
            'IAB18'
            'IAB24'
            'IAB8'
            'IAB9'
         ]
         is_app: 0
         slot_id: '1'
         content_type: 'display'
         ec_page_domain: 'thechive.com'
         topframe: ''
         source_name: None
         is_secure_request: True
         publisher_id: 'triplelift_4762'
         app_bundle: None
      }
   }
   request:
   {
      datetime: '2021-01-31 00:15:03'
   }
   uuid: '3fbd8a0b-b881-4194-a5d9-56aa66f772b8'
   bid_context:
   {
      demand:
      {
         deal_id: None
         bid_amount: 0.00025
         creative_id: 500001
         campaign_id: 500002
         can_track_clicks: True
         creative_viewability_vendors:
         [
         ]
         advertiser_id: 500003
         client_id: 500000
         creative_size: '300x50'
         line_item_id: 500004
         strategy_id: 1
         tag_type: 'iframe'
      }
   }
   details:
   {
      selleruid: '3fbd8a0b-b881-4194-a5d9-56aa66f772b8'
      ssp_bid_id: '905c09c3-e3fc-4e6f-a439-cfd100c4aa66'
   }
}