Publisher request payload reference

Integration Partners
Last Updated: July 31, 2026•

Note: This reference applies whether your container is hosted in Index Cloud or on your own infrastructure (partner-hosted). The fields and privacy rules described here are the same for both deployment models.

This reference describes the fields included in the outbound request at the PublisherClosed The owner of a website or app where advertisements are served. Request extension point, and how privacy settings affect each field. For how these fields reach your handler, see Build a gRPC RTD service.

RTBRequest

The outbound request contains the following top-level fields:

FieldNotes

RTBRequest.tmax

Time budget for the request, in milliseconds

RTBRequest.originator.type

Identifies the originator type - TYPE_PUBLISHER

RTBRequest.lifecycle

Identifies the request as a publisher bid requestClosed An OpenRTB request that is sent from a supply-side platform (SSP) or ad exchange to the DSP requesting a bid response for potential impressions. A bid request contains information about the impression that allows the DSP to decide whether to bid on the impression. - LIFECYCLE_PUBLISHER_BID_REQUEST

RTBRequest.id

UUID generated for the request

RTBRequest.bid_request

Contains the enriched bid request payload that was received by the publisher

RTBRequest.applicable_intents

List of intents applicable to this request - ACTIVATE_DEALS, SUPPRESS_DEALS, ADJUST_DEAL_FLOOR, ACTIVATE_SEGMENTS, ADD_CIDS

How privacy settings affect this data

Specific fields containing personally identifiable information (PII) are anonymized, masked, or omitted based on the request user's consent status.

  • DPA opt-out: Providers that opt out of the data provider agreement are opted out of receiving PII entirely.

  • Consent anonymization: This applies when the provider is not registered in the CMP, or if the user has not provided consent to share data with that provider.

RTBRequest.bid_request

The bid_request object contains the following fields:

FieldNotes

bid_request.id

As provided

bid_request.site vs bid_request.app

Sent as one of site or app, depending on which is present in the original request

bid_request.imp[*].id

As provided

bid_request.imp[*].bidfloor

As provided

bid_request.imp[*].metric[*].type

As provided

bid_request.imp[*].metric[*].value

As provided

bid_request.imp[*].banner.format[*].w

As provided, if banner present

bid_request.imp[*].banner.format[*].h

As provided, if banner present

bid_request.imp[*].banner.w

As provided, if banner present

bid_request.imp[*].banner.h

As provided, if banner present

bid_request.imp[*].banner.pos

As provided, if banner present

bid_request.imp[*].video.w

As provided, if video present

bid_request.imp[*].video.h

As provided, if video present

bid_request.imp[*].video.pos

As provided, if video present

bid_request.imp[*].video.placement

As provided, if video present

bid_request.imp[*].video.plcmt

As provided, if video present

bid_request.imp[*].ext.gpid

As provided, if present

bid_request.site.id

As provided, if site present

bid_request.site.name

As provided, if site present

bid_request.site.domain

As provided, if site present

bid_request.site.cattax

As provided, if site present

bid_request.site.cat

As provided, if site present

bid_request.site.sectioncat

As provided, if site present

bid_request.site.pagecat

As provided, if site present

bid_request.site.page

As provided. Page URL is sanitized - query string, fragment, and embedded credentials are removed

bid_request.site.privacypolicy

As provided, if site present

bid_request.site.ref

As provided, if site present

bid_request.site.search

As provided, if site present

bid_request.site.publisher.id

As provided, if publisher present

bid_request.site.publisher.name

As provided, if publisher present

bid_request.site.publisher.cattax

As provided, if publisher present

bid_request.site.publisher.cat

As provided, if publisher present

bid_request.site.publisher.domain

As provided, if publisher present

bid_request.site.keywords

As provided, if site present

bid_request.site.kwarray

As provided, if site present

bid_request.site.mobile

As provided, if site present

bid_request.site.inventorypartnerdomain

As provided, if site present

bid_request.app.id

As provided, if app present

bid_request.app.name

As provided, if app present

bid_request.app.domain

As provided, if app present

bid_request.app.cattax

As provided, if app present

bid_request.app.cat

As provided, if app present

bid_request.app.sectioncat

As provided, if app present

bid_request.app.pagecat

As provided, if app present

bid_request.app.ver

As provided, if app present

bid_request.app.bundle

As provided, if app present

bid_request.app.privacypolicy

As provided, if app present

bid_request.app.paid

As provided, if app present

bid_request.app.publisher.id

As provided, if publisher present

bid_request.app.publisher.name

As provided, if publisher present

bid_request.app.publisher.cattax

As provided, if publisher present

bid_request.app.publisher.cat

As provided, if publisher present

bid_request.app.publisher.domain

As provided, if publisher present

bid_request.app.keywords

As provided, if app present

bid_request.app.kwarray

As provided, if app present

bid_request.app.storeurl

As provided, if app present

bid_request.app.inventorypartnerdomain

As provided, if app present

bid_request.(site/app).content.id

As provided, if content present

bid_request.(site/app).content.episode

As provided, if content present

bid_request.(site/app).content.title

As provided, if content present

bid_request.(site/app).content.series

As provided, if content present

bid_request.(site/app).content.season

As provided, if content present

bid_request.(site/app).content.genre

As provided, if content present

bid_request.(site/app).content.language

As provided, if content present

bid_request.(site/app).content.livestream

As provided, if content present

bid_request.(site/app).content.contentrating

As provided, if content present

bid_request.(site/app).content.artist

As provided, if content present

bid_request.(site/app).content.album

As provided, if content present

bid_request.(site/app).content.isrc

As provided, if content present

bid_request.(site/app).content.url

As provided. Content URL is sanitized - query string, fragment, and embedded credentials are removed

bid_request.(site/app).content.cattax

As provided, if content present

bid_request.(site/app).content.cat

As provided, if content present

bid_request.(site/app).content.len

As provided, if content present

bid_request.(site/app).content.embeddable

As provided, if content present

bid_request.(site/app).content.langb

As provided, if content present

bid_request.(site/app).content.sourcerelationship

As provided, if content present

bid_request.(site/app).content.keywords

As provided, if content present

bid_request.(site/app).content.kwarray

As provided, if content present

bid_request.(site/app).content.userrating

As provided, if content present

bid_request.(site/app).content.prodq

As provided, if content present

bid_request.(site/app).content.context

As provided, if content present

bid_request.(site/app).content.qagmediarating

As provided, if content present

bid_request.(site/app).content.producer.id

As provided, if producer present

bid_request.(site/app).content.producer.name

As provided, if producer present

bid_request.(site/app).content.producer.cattax

As provided, if producer present

bid_request.(site/app).content.producer.cat

As provided, if producer present

bid_request.(site/app).content.producer.domain

As provided, if producer present

bid_request.(site/app).content.data[*].id

As provided, if content.data present

bid_request.(site/app).content.data[*].name

As provided, if content.data present

bid_request.(site/app).content.data[*].segment[*].id

As provided, if content.data present

bid_request.(site/app).content.data[*].segment[*].name

As provided, if content.data present

bid_request.(site/app).content.data[*].segment[*].value

As provided, if content.data present

bid_request.(site/app).content.data[*].ext.cids

As provided, if content.data present

bid_request.(site/app).content.channel.id

As provided, if channel present

bid_request.(site/app).content.channel.name

As provided, if channel present

bid_request.(site/app).content.channel.domain

As provided, if channel present

bid_request.(site/app).content.network.id

As provided, if network present

bid_request.(site/app).content.network.name

As provided, if network present

bid_request.(site/app).content.network.domain

As provided, if network present

bid_request.device.dnt

As provided, if device present

bid_request.device.ua

As provided, if device present

bid_request.device.ip

May be partially masked or withheld depending on privacy settings

bid_request.device.ipv6

May be partially masked depending on privacy settings

bid_request.device.didsha1

May be withheld depending on privacy settings

bid_request.device.didmd5

May be withheld depending on privacy settings

bid_request.device.dpidsha1

May be withheld depending on privacy settings

bid_request.device.dpidmd5

May be withheld depending on privacy settings

bid_request.device.ifa

May be withheld depending on privacy settings

bid_request.device.carrier

As provided, if device present

bid_request.device.language

As provided, if device present

bid_request.device.langb

As provided, if device present

bid_request.device.make

As provided, if device present

bid_request.device.model

As provided, if device present

bid_request.device.os

As provided, if device present

bid_request.device.osv

As provided, if device present

bid_request.device.hwv

As provided, if device present

bid_request.device.w

As provided, if device present

bid_request.device.h

As provided, if device present

bid_request.device.ppi

As provided, if device present

bid_request.device.pxratio

As provided, if device present

bid_request.device.js

As provided, if device present

bid_request.device.geofetch

As provided, if device present

bid_request.device.lmt

As provided, if device present

bid_request.device.mccmnc

As provided, if device present

bid_request.device.connectiontype

As provided, if device present

bid_request.device.devicetype

As provided, if device present

bid_request.device.geo.lat

May be rounded or withheld depending on privacy settings

bid_request.device.geo.lon

May be rounded or withheld depending on privacy settings

bid_request.device.geo.country

May be withheld depending on privacy settings

bid_request.device.geo.region

May be withheld depending on privacy settings

bid_request.device.geo.regionfips104

May be withheld depending on privacy settings

bid_request.device.geo.metro

May be withheld depending on privacy settings

bid_request.device.geo.city

May be withheld depending on privacy settings

bid_request.device.geo.zip

May be partially masked or withheld depending on privacy settings

bid_request.device.geo.accuracy

As provided, if geo present

bid_request.device.geo.lastfix

As provided, if geo present

bid_request.device.geo.utcoffset

As provided, if geo present

bid_request.device.geo.type

As provided, if geo present

bid_request.device.geo.ipservice

As provided, if geo present

bid_request.device.sua.browsers[*].brand

As provided, if sua present

bid_request.device.sua.browsers[*].version

As provided, if sua present

bid_request.device.sua.platform.brand

As provided, if sua present

bid_request.device.sua.platform.version

As provided, if sua present

bid_request.device.sua.mobile

As provided, if sua present

bid_request.device.sua.architecture

As provided, if sua present

bid_request.device.sua.bitness

As provided, if sua present

bid_request.device.sua.model

As provided, if sua present

bid_request.device.sua.source

As provided, if sua present

bid_request.user

May be withheld entirely depending on privacy settings

bid_request.user.id

As provided, if user present

bid_request.user.consent

As provided, if user present

bid_request.user.eids

Allowlisted list of EIDs shared as provided

bid_request.regs

May be withheld depending on privacy settings

bid_request.regs.coppa

As provided, if regs present

bid_request.regs.gdpr

As provided, if regs present

bid_request.regs.us_privacy

As provided, if regs present

bid_request.regs.gpp

As provided, if regs present

bid_request.regs.gpp_sid

As provided, if regs present

bid_request.source.fd

As provided, if source present

bid_request.source.tid

As provided, if source present

bid_request.source.pchain

As provided, if source present

bid_request.source.schain.complete

As provided, if schain present

bid_request.source.schain.ver

As provided, if schain present

bid_request.source.schain.nodes[*].asi

As provided, if schain.nodes present

bid_request.source.schain.nodes[*].rid

As provided, if schain.nodes present

bid_request.source.schain.nodes[*].sid

As provided, if schain.nodes present

bid_request.source.schain.nodes[*].name

As provided, if schain.nodes present

bid_request.source.schain.nodes[*].domain

As provided, if schain.nodes present

bid_request.source.schain.nodes[*].hp

As provided, if schain.nodes present