This document provides guidelines for implementing Server-to-Server (S2S) integration with Insticator using the OpenRTB 2.5 protocol.

To view the GDPR compliancy & supported country list jump to the bottom of the article.

Requirements:

RTB End Point:

For web: https://ex.ingage.tech/v1/ortb

Cookie Sync URLs:

[Recommended] iframe sync example:

<iframe
  style="width: 1px; height: 1px; border: 0; position: absolute; left: -9999px;"
  src="https://usync.ingage.tech?gdpr=1&gdpr_consent=BOEFEAyOEFEAyAHABDENAI4AAAB9vABAASA&us_privacy=1YNN&r=https://sync.partner.com/api?userId=$UID&gdpr=${user.gdpr}&gdpr_consent=${user.consentStr}&us_privacy=${user.usPrivacy}"
  width="1"
  height="1">
</iframe>

img sync example:

<img
  style="width: 1px; height: 1px; border: 0; position: absolute; left: -9999px;"
  src="https://sync.ingage.tech?gdpr=1&gdpr_consent=BOEFEAyOEFEAyAHABDENAI4AAAB9vABAASA&us_privacy=1YNN&r=https://sync.partner.com/api?userId=$UID&gdpr=${user.gdpr}&gdpr_consent=${user.consentStr}&us_privacy=${user.usPrivacy}"
  width="1"
  height="1">
</img>

You can pass the following query parameters & macro in the URL:

gdpr: Indicates whether GDPR applies (0 for no, 1 for yes).
gdpr_consent: Encoded consent string as per GDPR guidelines.
us_privacy: US privacy string, typically representing CCPA compliance.
r: The r(Required) query param will have the sync url of the partner in order to synchronise the user with us.
$UID: macro to get Insticator's userId in your redirect url

adUnitId (Mandatory):

The adUnitId should be included in the bid request within the imp object, under the ext.insticator.adUnitId key.

Publisher Id (Mandatory):

The publisher.id should be included in the bid request within the publisher object.

Implementation:

You will need to construct the Bid Request body according to the details outlined in the below specification and POST it to the appropriate Insticator RTB endpoint (web or app).

Incoming Bid Request Object specification supported by Insticator:

Insticator supports the following fields in the top-level bid request object:

Field	Type	Description
`id`	string	(Required)* Unique ID of the bid request.
`imp`	array of objects	(Required)* The impressions offered in this bid request. See Impression Object below.
`site`	object	Details via a Site object about the publisher’s website. Only applicable and recommended for websites. See Site object below.
`app`	object	Specifies information about the app for the impressions. Applicable for app impressions. See App Object below.
`device`	object	Details via a Device object about the user’s device to which the impression will be delivered.. See Device Object below.
`user`	object	Specifies information about the person to whom the impressions will be delivered. See User Object below.
`test`	integer	Indicates that this auction is in test mode and is not billable. If not present, the default is used.`0`: live mode; billable (default);`1`: test mode; not billable
`cur`	array of strings	Specifies an array of allowed currencies for bids on this impression. USD is assumed by default. We don't support currency conversion as of now for the direct ORTB requests.
`bcat`	array of strings	Blocked advertiser categories using the IAB content categories.
`badv`	array of strings	Specifies a list of blocked top-level advertiser domains that correspond to brand URLs . For more information, see the Brand Service.
`regs`	object	Specifies information about an industry, legal, or governmental regulation in force for this request. See Regs Object below.
`ext`	object	Used for identifying Insticator-specific extensions to the OpenRTB bid request.
`tmax`	integer	Maximum time in milliseconds the exchange allows for bids to be received including Internet latency to avoid timeout. This value supersedes any a priori guidance from the exchange. ( This is controlled by insticator at their end )
`bapp`	array of strings	Block list of applications by their platform-specific exchangeindependent application identifiers. On Android, these should be bundle or package na
`source`	object	A Source object that provides data about the inventory source and which entity makes the final decision. See source bject below.
`wlang`	array of strings	White list of languages for creatives using ISO-639-1-alpha-2. Omission implies no specific restrictions, but buyers would be advised to consider language attribute in the Device and/or Content objects if available.

Source Object:

Insticator supports the following fields in source object.

Field	Type	Description
`fd`	integer	Entity responsible for the final impression sale decision, where 0 = exchange, 1 = upstream source.
`tid`	string	Transaction ID that must be common across all participants in this bid request (e.g., potentially multiple exchanges).
`pchain`	string	Payment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0
`ext`	object	Placeholder for Insticator-specific extensions to OpenRTB. It contains the schain object as well.

Extension object of Source:

Insticator uses the extension object of the Source as a source of schain object.

Field	Type	Description
`schain`	object	schain object i.e supply chain object includes the details of the version, Specifies the SupplyChain fields included in the OpenRTB bid request for supply path transparency. See Schain Object below

Schain Object:

Insticator supports the following fields in the supply chain object.

Field	Type	Description
`ver`	string	Version of the supply chain spec in use.
`complete`	enum	Flag indicating whether the chain contains all nodes involved in the transaction leading back to the owner of the site, app or other medium of the inventory, where 0 = no, 1 = yes.
`node`	object	Array of SupplyChainNode objects in the order of the chain. In a complete supply chain, the first node represents the initial advertising system and seller ID involved in the transaction, i.e. the owner of the site, app, or other medium. In an incomplete supply chain, it represents the first known node. The last node represents the entity sending this bid request, which will be the Insticator node. Insticator supports the following fields in the nodes object. Note: In order for a node to be considered complete, the following fields must be included in the node object. asi (mandatory string): The canonical domain name of the SSP, Exchange, Header Wrapper, etc system that bidders connect to. This should be the same value as used to identify sellers in an ads.txt file if one exists. sid (mandatory string): The identifier associated with the seller or reseller account within the advertising system. rid (optional string): The OpenRTB RequestId of the request as issued by the seller. hp (mandatory integer): Indicates whether this node will be involved in the flow of payment for the inventory. For version 1.0 of SupplyChain, this property should always be 1.

Field

Type

Description

ver

string

Version of the supply chain spec in use.

complete

enum

Flag indicating whether the chain contains all nodes involved in the transaction leading back to the owner of the site, app or other medium of the inventory, where 0 = no, 1 = yes.

node

object

Array of SupplyChainNode objects in the order of the chain. In a complete supply chain, the first node represents the initial advertising system and seller ID involved in the transaction, i.e. the owner of the site, app, or other medium. In an incomplete supply chain, it represents the first known node. The last node represents the entity sending this bid request, which will be the Insticator node. Insticator supports the following fields in the nodes object.

Note: In order for a node to be considered complete, the following fields must be included in the node object.

asi (mandatory string): The canonical domain name of the SSP, Exchange, Header Wrapper, etc system that bidders connect to. This should be the same value as used to identify sellers in an ads.txt file if one exists.
sid (mandatory string): The identifier associated with the seller or reseller account within the advertising system.
rid (optional string): The OpenRTB RequestId of the request as issued by the seller.
hp (mandatory integer): Indicates whether this node will be involved in the flow of payment for the inventory. For version 1.0 of SupplyChain, this property should always be 1.

Impression Object:

Insticator supports the following fields in the impobject, A single request may contain an array of imp object.

Field	Type	Description
`id`	string	(Required)* Specifies a unique identifier for this impression within the context of the bid request.
`banner`	object	Required if this impression is offered as a banner ad. See Banner Object below.
`video`	object	Required if this impression is offered as a video ad. See Video Object below.
`instl`	integer	Indicates whether the impression is interstitial or full screen.`0`: the impression is not interstitial or full screen (default)`1`: the impression is interstitial or full screen
`tagid`	string	Specifies an identifier for the specific ad placement or ad tag that was used to initiate the auction. If set, this is the Insticator placement code. Omitted when sending to buyers if seller visibility settings prohibit sharing.
`secure`	integer	Indicates whether the impression requires secure HTTPS URL creative assets and markup. If omitted, the secure state is unknown but non-secure HTTP support can be assumed.`0`: the impression is not secure`1`: the impression is secure
`displaymanager`	string	Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner. Recommended for video and/or apps
`displaymanagerver`	string	Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile). Used by some ad servers to customize ad code by partner. Recommended for video and/or apps.
`bidfloor`	float	Minimum bid for this impression expressed in CPM.Note: The `bidfloor` field should be the publisher's net CPM floor price on incoming ad requests. This floor price must be greater than the existing hard floor, set on the platform, in order to override it for the given auction.
`bidfloorcur`	string	Specifies the currency for this bid using ISO-4217 alphabetic codes. Defaults to USD. Insticator only support USD cur.
`iframebuster`	string	Array of exchange-specific names of supported iframe busters.
`pmp`	object	Specifies information about a private marketplace deal that is in effect for this impression. See Private Marketplace Object below.
`ext`	object	(Required)*Used for identifying Insticator-specific extensions to the impression object. See Impression Extension Object below.

Impression extension object:

Insticator supports these fields in extension object of impression.

Field	Type	Description
insticator	object	(Required)It contains insticator specific config for impression specific details.

Insticator object for Impression extension object:

Supported fields.

Fields	Type	Description
adUnitId	string	Required A unique id (can be used for multiple impressions) to identify the internal setup at insticator with the partner to serve the impressions properly.

Banner Object:

Support fields by Insticator for banner impressions.

Field	Type	Description
`w`	integer	(Required) Specifies the exact width of the banner in pixels.
`h`	integer	(Required) Specifies the exact height of the banner in pixels.
`btype`	array of integers	Specifies the banner creative types to block. Refer to section 5.2 of the IAB specification for a list of types.
`battr`	array of integers	Specifies the banner creative attributes to block. Refer to section 5.3 of the IAB specification for a list of attributes.
`pos`	integer	(Recommended)Specifies the position of the banner on the screen. Currently supported values are:`0`: Unknown (default)`1`: Above the fold `3`: Below the fold
`api`	array of integers	Specifies the supported API frameworks for this impression. Parsed, but not used. If an API is not explicitly listed, VPAID support is deduced from MIME types sent: VPAID 1 and 2 would be allowed for JavaScript and Flash MIME types. Refer to section 5.6 of the IAB specification for a list of API frameworks.
`format`	object array	Array of format objects representing the banner sizes permitted. If none are specified, then use of the `h` and `w` attributes is highly recommended.
`ext`	object	Insticator specific details. ( None so far )

Format object ( for banner impression ):

Insticator supports following fields in format object.

Field	type	Description
`h`	string	Determine the height of the creative in pixels.
`w`	string	Determine the width of the creative in pixels.

Video Object:

Support fields by Insticator for the video impressions.

Field	Type	Description
`mimes`	array of strings	(Required)* Content MIME types supported (e.g., “video/x-ms-wmv”, “video/mp4”)
`minduration`	integer	(Recommended)* Specifies the minimum video ad duration, in seconds.
`maxduration`	integer	(Recommended)* Specifies the maximum video ad duration, in seconds.
`w`	integer	(Required)* Specifies the width of the video player, in pixels.
`h`	integer	(Required)* Specifies the height of the video player, in pixels.
`startdelay`	integer	(Recommended)* Specifies the start delay of the video: `> 0`: For values greater than zero, the delay before video start, in seconds. `0` : Pre-roll `-1`: Generic mid-roll `-2`: Generic post-roll
`battr`	array of integers	Specifies the video creative attributes to block. Refer to section 5.3 of the IAB specification for a list of attributes.
`placement`	integer	Placement type for the impression, Values from `1-5` ( Deprecated for prebid version > 9.0 )
`plcmt`	integer	Plcmt type for the impression, Values from `1-4`
`linearity`	integer	(Recommended)*Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed ( Insticator supports `1`)
`skip`	integer	Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. If a bidder sends markup/creative that is itself skippable, the Bid object should include the attr array with an element of 16 indicating skippable video
`skipmin`	integer	Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable
`skipafter`	integer	Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable.
`sequence`	integer	If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.
`maxextended`	integer	Maximum extended ad duration if extension is allowed. If blank or 0, extension is not allowed. If -1, extension is allowed, and there is no time limit imposed. If greater than 0, then the value represents the number of seconds of extended play supported beyond the maxduration value.
`battr`	array of integers	Blocked creative attributes. Refer to List 5.3 in Ortb 2.5 spec.
`minbitrate`	integer	Specifies the minimum bit rate, in kilobytes per second. If specified, only return creatives having at least one media file within the appropriate bit range.
`maxbitrate`	integer	Specifies the maximum bit rate, in kilobytes per second. If specified, only return creatives having at least one media file within the appropriate bit range.
`boxingallowed`	integer	Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes.
`playbackmethod`	array of integers	Specifies the allowed playback methods. If not specified, all are assumed to be allowed. Currently supported values are: `1`: Autoplay, sound on `2`: Autoplay, sound off `3`: Click to play `4`: Mouse over to play `5`: Entering Viewport with Sound On `6`: Entering Viewport with Sound Off by Default
`playbackend`	integer	The event that causes playback to end. E.g `1`: On Video Completion or when Terminated by User `2`: On Leaving Viewport or when Terminated by User `3`: On Leaving Viewport Continues as a Floating/Slider Unit until Video Completion or when Terminated by User
`pos`	integer	(Recommended)*Specifies the position of the video on the screen. Currently supported values are: `0`: Unknown (default) `1`: Above the fold `3`: Below the fold
`companionad`	array of objects	Specifies an array of banner objects if companion ads are available. See Banner Object above.
`api`	array of integers	(Recommended)*Specifies the supported API frameworks for this impression. If an API is not explicitly listed, it is assumed not to be supported. Currently supported values are: `1`: VPAID 1.0 `2`: VPAID 2.0 `3`: MRAID-1 `4`: ORMMA `5`: MRAID-2 `6`: MRAID-3 `7`: OMID-1
`companiontype`	array of integers	Specifies the VAST companion ad types. Recommended if one or more `companionad` objects are included. Currently supported values are: `1`: Static resource `2`: HTML resource `3`: iframe resource
`protocols`	array of integers	(Recommended)Array of supported video protocols of the creative types that are eligible. Following are the currently supported values: `1`: VAST 1.0 `2`: VAST 2.0 `3`: VAST 3.0 `4`: VAST 1.0 Wrapper `5`: VAST 2.0 Wrapper `6`: VAST 3.0 Wrapper `7`: VAST 4.0 `8`: DAAST 1.0 Warning:** As Insticator does not verify VAST1.0 & DAAST compliance in creatives, requests that exclusively support VAST1.0 & DAAST values in `protocols` will not result in any bids.
`ext`	object	Used for identifying Insticator-specific extensions to the video object. See Video Extension Object below.

Site Object:

PLEASE NOTE: THE REQUEST SHOULD NOT CONTAIN BOTH SITE AND AN APP OBJECT. ONLY ONE IS ALLOWED

Supported fields for site object for Insticator.

Field	Type	Description
`id`	string	(Recommended)* The seller's site ID.
`domain`	string	(Recommended)*Specifies the domain of the site (for example, `publishersite.com`) where the impression will be shown. Set as the referrer domain on the impression if available, or extracted from the `page` field.
`ref`	string	Referrer URL that caused navigation to the current page.
`name`	string	Site name (may be aliased at the publisher’s request).
`cat`	array of strings	(Recommended)*Specifies a list of IAB content categories (listed in section 5.1 of the specification).
`sectioncat`	array of strings	Array of IAB content categories that describe the current section of the site.
`pagecat`	array of strings	Array of IAB content categories that describe the current section of the site.
`page`	string	(Recommended)*Specifies the full URL of the page where the impression will be shown (for example, `page.publishersite.com/path/to/page`). This should be the referrer URL and is preferred over the `domain` field.
`publisher`	object	(Required)*Specifies information about the publisher. See Publisher Object below.
`keywords`	string	(Recommended)*Comma-separated list of keywords about the site. Keywords are global to the request and apply to all `imp` objects.
`content`	object	(Recommended)*Details about the Content within the site. See Content Object below.
`ext`	object	Insticator-specific extensions to OpenRTB

App object:

Supported fields for app object for Insticator.

Field	Type	Description
`id`	string	Specifies the seller's app ID.
`bundle`	string	(Required)Specifies the application bundle or package name (e.g., `com.longtv.tv`). This is intended to be a unique ID across multiple exchanges.
`domain`	string	Specifies the domain of the app (for example, `mygame.publishersite.com`) where the impression will be shown. Set as the referrer domain on the impression if available.
`storeurl`	string	App store URL for an installed app.
`cat`	array of strings	(Recommended)Specifies a list of IAB content categories (listed in section 5.1 of the specification).
`publisher`	object	(Required)Specifies information about the publisher. See Publisher Object below.
`name`	string	The full name of the app (i.e., Angry Birds). (This value may be aliased at the publisher's request.)
`keywords`	string	(Recommended)Comma-separated list of keywords about the app. Keywords are global to the request and apply to all `imp` objects.
`content`	object	(Recommended)Details about the Content within the app. See Content Object below.

Publisher Object:

Supported fields for publisher object for Insticator.

Field	Type	Description
`id`	string	(Required)Insticator specific publisher id.
`domain`	string	Highest level domain of the publisher
`name`	string	Publisher name.

Content Object:

Supported fields for content object for Insticator.

Field	Type	Description
`genre`	string	Genre that best describes the content (e.g., rock, pop, etc).
`id`	string	ID uniquely identifying the content.
`language`	string	(Recommended)*Content language using ISO-639-1-alpha-2.
`ext`	object	Placeholder for exchange-specific extensions to OpenRTB.
`episode`	integer	Episode number.
`title`	string	Content title. Video Examples:* "Search Committee" (television), "A New Hope" (movie), or "Endgame" (made for web). Non-Video Example:* "Why an Antarctic Glacier is Melting So Quickly" (Time magazine article).
`series`	string	Video Examples:* "The Office" (television), "Star Wars" (movie), or "Arby 'N' The Chief" (made for web). Non-Video Example:* "Ecocentric" (Time Magazine blog).
`season`	string	Content season (e.g., "Season 3").
`artist`	string	Artist credited with the content.
`album`	string	Album to which the content belongs; typically for audio.
`isrc`	string	International Standard Recording Code conforming to ISO-3901.
`producer`	object	Details about the content Producer. Refer to section 3.2.12 in the IAB specification.
`url`	string	URL of the content, for buy-side contextualization or review.
`cat`	string array	(Recommended)*Array of IAB content categories that describe the content producer. Refer to list 5.1 in the IAB specification.
`prodq`	integer	Production quality. Refer to List 5.11 in the IAB specification.
`videoquality`	integer; DEPRECATED	Deprecated in favor of `prodq`. Video quality. Refer to List 5.11 in the IAB specification.
`context`	integer	Type of content (game, video, text, etc.). Refer to List 5.16 in the IAB specification.
`contentrating`	string	Content rating (e.g., MPAA).
`userrating`	string	User rating of the content (e.g., number of stars, likes, etc.).
`qagmediarating`	integer	Media rating per IQG guidelines. Refer to List 5.17 in the IAB specification.
`keywords`	string	(Recommended)*Comma-separated list of keywords describing the content.
`livestream`	integer	`0` = not live `1` = content is live (e.g., stream, live blog).
`sourcerelationship`	integer	`0` = indirect `1` = direct.
`len`	integer	Length of content in seconds; appropriate for video or audio.
`data`	object array	Additional content data. Each Data object represents a different data source. Refer to Section 3.2.16 in the IAB specification.

Device Object:

Supported fields for device by Insticator.

Field	Type	Description
`ua`	string	(Recommended)* Specifies the user agent string from the browser. User agent often identifies such information as the application, operating system, and software vendor acting on behalf of the user, e.g., "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.0.4) Gecko/2008102920 Firefox/3.0.4".
`geo`	object	Specifies the location of the device, as derived from the device's location services (such as cell tower triangulation or GPS) or IP address. See Geo Object for details.
`dnt`	integer	Specifies the Do Not Track setting: `0`: Do Not Track is set to false in browser (tracking is allowed) `1`: Do Not Track is set to true in browser (user has opted out of tracking)
`ip`	string	(Recommended)*Specifies the IPv4 address closest to the device. Omitted when sent to buyers if seller visibility settings prohibit sharing.
`ipv6`	string	Specifies the IPv6 address closest to the device. Used only for geolocation for buyer targeting.
`devicetype`	integer	Specifies the type of device, using IAB values: `1`: Mobile/Tablet `2`: Personal Computer `3`: Connected TV `4`: Phone `5`: Tablet `6`: Connected Device `7`: Set Top Box
`make`	string	Specifies the make of the device. Only used if not supported via the `ua` field.
`model`	string	Specifies the model of the device. Only used if not supported via the `ua` field.
`os`	string	This is the code field that you obtain from operating system code.
`carrier`	string	Specifies carrier for the device. Only used if not supported via the `ua` field.
`language`	string	Specifies the browser language; use ISO 639-1 or ISO 3166 alpha-2.
`ifa_type`	string	Identify the source of the IFA, whether that is device-generated (and therefore used across apps) or whether it is a publisher-provided IFA, or a temporary/session IFA (e.g., `dpid`, `ppid`, `sspid`, `sessionid`, `idfa`, `aaid`, `rida`, `afai`, `tifa`, `vida`, `lgudid`).
`ifa`	string	The "identifier for advertising" is an unhashed device ID sanctioned for advertiser use. This will be the IDFA on iOS or AAID on Android. Example: `"ifa": "AA000DFE74168477C70D291f574D344790E0BB12"`.
`didsha1`	string	Specifies the SHA1-encrypted unique identifier for the mobile device.
`didmd5`	string	Specifies the MD5-encrypted unique identifier for the mobile device.
`dpidsha1`	string	Specifies the SHA1-encrypted, platform-specific (e.g., ANDROID_ID or UDID for iOS) unique identifier for the mobile device.
`dpidmd5`	string	Specifies the MD5-encrypted, platform-specific (e.g., ANDROID_ID or UDID for iOS) unique identifier for the mobile device.
`lmt`	integer	"Limit Ad Tracking" signal commercially endorsed (e.g., iOS, Android), where `0`=tracking is unrestricted, `1`=tracking must be limited per commercial guidelines.
`sua`	object	Structured user agent information defined by a UserAgent object. If both ‘ua’ and ‘sua’ are present in the bid request, ‘sua’ should be considered the more accurate representation of the device attributes. This is because the ‘ua’ may contain a frozen or reduced user agent string.
`ext`	object	Insticator specific extenstion object.

Device extension object:

Supported fields for device.ext object by Insticator.

Field	Type	Description
sua	object	Structured user agent information defined by a UserAgent object. If both ‘ua’ and ‘sua’ are present in the bid request, ‘sua’ should be considered the more accurate representation of the device attributes. This is because the ‘ua’ may contain a frozen or reduced user agent string.

User Object:

Insticator supports following fields for userobject.

Field	Type	Description
`id`	string	The seller's unique ID for this user.
`buyeruid`	string	The Insticator unique ID of this user.
`yob`	integer	Specifies the year of birth as a 4-digit integer. Omitted when sent to buyers if unknown or value set to 0.
`gender`	string	Specifies the gender. Set to null if unknown. Omitted when sent to buyers if unknown. `M`: male `F`: female `O`: other
`keywords`	string	Comma separated list of keywords about the user. Keywords are global to the request and apply to all imp objects.
`geo`	object	Location of the user’s home base defined by a Geo object. This is not necessarily their current location. Note:* By default, this field is not supported. Contact support or your account representative for more information.
`ext`	object	Used for identifying Insticator-specific extensions to OpenRTB for the user object.

User extension object:

Insticator supports following fields for user.extobject

Field	Type	Description
`eids`	object array	This object can contain one or more UIDs from a single source or a technology provider. Extended Identifiers support in OpenRTB allows buyers to use audience data in real-time bidding. For more information, see eid Object.

eid object:

Insticator supports following fields for user.ext.eid[0]object

Field	Type	Description
`source`	string	Source of technology provider responsible for the set of included IDs.
`uids`	object array	Array of extended ID UID objects from the given source.

Geo Object:

Supported fields for geo object by Insticator.

Field	Type	Description
`lat`	float	Specifies the latitude of the device, as derived from the device's location services (such as cell tower triangulation or GPS) or IP address. This can range from -90 to 90. South is negative.
`lon`	float	Specifies the longitude of the device, as derived from the device's location services (such as cell tower triangulation or GPS) or IP address. This can range from -180 to 180. West is negative.
`country`	string	Country code using ISO-3166-1-alpha-3 Note:* By default, this field is not supported. Your account can be enabled to add support for this field, in which case country + zip will be used to determine location information. Contact support or your account representative for more information.
`zip`	string	Zip or postal code. Note:* By default, this field is not supported. Your account can be enabled to add support for this field, in which case country + zip will be used to determine location information. Contact support or your account representative for more information.
`accuracy`	integer	Estimated location accuracy in meters; recommended when lat/lon are specified and derived from a device’s location services (i.e., type = 1). Note that this is the accuracy as reported from the device. Consult OS specific documentation (e.g., Android, iOS) for exact interpretation.
`region`	string	Region code using ISO-3166-2; 2-letter state code if USA
`city`	string	City using United Nations Code for Trade & Transport Locations. See Appendix A for a link to the codes.
`metro`	string	Google metro code; similar to but not exactly Nielsen DMAs. See Appendix A for a link to the codes
`lastfix`	integer	Number of seconds since this geolocation fix was established. Note that devices may cache location data across multiple fetches. Ideally, this value should be from the time the actual fix was taken.
`ipservice`	integer	Service or provider used to determine geolocation from IP address if applicable (i.e., type = 2). Refer to List 5.23.
`utcoffset`	integer	Local time as the number +/- of minutes from UTC.

Regs object:

Insticator supports following fields for regsobject.

Field	Type	Description
`coppa`	integer	Indicates if this request is subject to the United States Children's Online Privacy Protection Act (COPPA). 0:* Not subject to COPPA. Treat as a normal auction 1:* Subject to COPPA. Limit what is allowed for targeting and logging as required.
`ext`	object	Used for identifying Xandr-specific extensions to OpenRTB for the reg object.
`gpp`	string	Indicates the actual IAB GPP consent string. It implies which vendors are permitted to process personal data and under which conditions. Example: `{ "Regs": { "ext": { "gpp": "DBACNYA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN", "gpp_sid": [5]} } }`
`gpp_sid`	array	Optional: Indicates which regulations or GPP logics are to be applied, or whether a user is located in a country (EEA country) with a framework that is part of the GPP Example: `{ "Regs": { "ext": { "gpp": "DBACNYA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN", "gpp_sid": [5]} } }`

Regs Extension Object:

Insticator supports following fields for regs.extobject.

Field	Type	Description
`gdpr`	integer	Optional. Indicates whether the request is subject to General Data Protection Regulation (GDPR) regulations. 0:* No, the request is not subject to GDPR regulations. 1:* Yes, the request is subject to GDPR regulations. No value indicates Unknown.
`gdprConsentString`	string	Optional. GDPR consent string parsed as indication that the consent is provided.
`us_privacy`	string	Optional. Indicates whether the request complies with the California Consumer Privacy Act (CCPA) regulations. This field complies with the IAB US Privacy specification. Refer to the IAB's string specifications for possible values. Example: { "Regs": { "ext": { "us_privacy": "1YNN" } } }`
`gpp`	string	Indicates the actual IAB GPP consent string. It implies which vendors are permitted to process personal data and under which conditions. Example: `{ "Regs": { "ext": { "gpp": "DBACNYA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN", "gpp_sid": [5]} } }`
`gpp_sid`	array	Optional: Indicates which regulations or GPP logics are to be applied, or whether a user is located in a country (EEA country) with a framework that is part of the GPP. Example: `{ "Regs": { "ext": { "gpp": "DBACNYA~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN", "gpp_sid": [5]} } }`
`dsa`	object	Provides details on the Digital Services Act (DSA) compliance. Example: `{ "dsarequired": 1, "pubrender": 0, "transparency": [ { "domain": "request.tomato.com", "dsaparams": [1] }, { "domain": "request2.tomato.com", "dsaparams": [1, 2, 3] } ], "datatopub": 1 }`

Sample Request

{
  "id": "priceche149cf433990fdf",
  "tmax": 3000,
  "source": {
    "fd": 1
  },
  "site": {
    "domain": "bostonhockeynow.com",
    "page": "https://bostonhockeynow.com/videoOnly?pbjs_debug=true",
    "ref": null,
    "publisher": {
    "id": "e363f57c-d3cb-4fa3-85d0-a115d9ebaea0"
    }
  },
  "device": {
    "w": 1267,
    "h": 1262,
    "js": true,
    "ext": {
      "localStorage": false,
      "cookies": false
    },
    "dnt": 0,
    "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0",
    "language": "en",
    "sua": {
      "source": 1,
      "platform": {
        "brand": "macOS"
      },
      "browsers": [
        {
          "brand": "Not/A)Brand",
          "version": [
            "8"
          ]
        },
        {
          "brand": "Chromium",
          "version": [
            "126"
          ]
        },
        {
          "brand": "Microsoft Edge",
          "version": [
            "126"
          ]
        }
      ],
      "mobile": 0
    }
  },
  "regs": {
    "ext": {
      "gdpr": 1,
      "us_privacy": "1YNN"
    },
    "coppa": 0
  },
  "user": {
    "id": "c1dfbae6-a36d-4cb0-9e2d-504c3df6700b"
  },
  "imp": [
    {
      "id": "28130237951fac",
      "tagid": "div-insticator-ad-2",
      "secure": 1,
      "ext": {
        "insticator": {
          "adUnitId": "01EX2DK7MW4BNN8TS2R0AT576D"
        }
      },
      "video": {
        "mimes": [
          "application/javascript",
          "video/mp4",
          "video/mpeg",
          "video/x-flv",
          "video/ogg"
        ],
        "w": 300,
        "h": 250,
        "minduration": 5,
        "maxduration": 30,
        "protocols": [
          2,
          3,
          5,
          6,
          7
        ],
        "linearity": 1,
        "minbitrate": 300,
        "playbackmethod": [
          1
        ],
        "playbackend": 2,
        "delivery": [
          2
        ],
        "api": [
          2,
          7
        ],
        "plcmt": 2,
        "context": "instream"
      }

    }
  ]
}

{
  "id": "priceche149cf433990fdf",
  "tmax": 3000,
  "source": {
    "fd": 1
  },
  "site": {
    "domain": "bostonhockeynow.com",
    "page": "https://bostonhockeynow.com/videoOnly?pbjs_debug=true",
    "ref": null,
    "publisher": {
    "id": "e363f57c-d3cb-4fa3-85d0-a115d9ebaea0"
    }
  },
  "device": {
    "w": 1267,
    "h": 1262,
    "js": true,
    "ext": {
      "localStorage": false,
      "cookies": false
    },
    "dnt": 0,
    "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36 Edg/126.0.0.0",
    "language": "en",
    "sua": {
      "source": 1,
      "platform": {
        "brand": "macOS"
      },
      "browsers": [
        {
          "brand": "Not/A)Brand",
          "version": [
            "8"
          ]
        },
        {
          "brand": "Chromium",
          "version": [
            "126"
          ]
        },
        {
          "brand": "Microsoft Edge",
          "version": [
            "126"
          ]
        }
      ],
      "mobile": 0
    }
  },
  "regs": {
    "ext": {
    },
    "coppa": 0
  },
  "user": {
    "id": "c1dfbae6-a36d-4cb0-9e2d-504c3df6700b"
  },
  "imp": [
    {
      "id": "28130237951fac",
      "tagid": "div-insticator-ad-2",
      "secure": 1,
      "ext": {
        "insticator": {
          "adUnitId": "01EX2DK7MW4BNN8TS2R0AT576D"
        }
      },
    "banner": {
                "format": [
                    {
                        "w": "300",
                        "h": "250"
                    }
                ]
            }
    }
  ],
  }
}

GDPR compliancy:

If the users are from GDPR or any other privacy regulated area, it is required to have a CMP withTCF v2.2 in place and enable the below vendor ids (Consent & Legitimate Interest) for optimized performance. We can provide a CMP support if required, but if publisher is using own CMP we are requesting to ensure the following IAB vendors are granted Vendor Consent rights:

Vendor ID	Vendor Name
58 617 50 793 32 143 24 91 814 755 10 333 910 109 241 69 76 1043 52 157 80 104 13 23 36 45 1126	33Across Onfocus (Adagio) Adform A/S Amazon Advertising Xandr, Inc. Connatix Native Exchange Inc. Epsilon Criteo SA Eskimi Google Advertising Products Index Exchange Inc. InMobi Pte Ltd Insticator LoopMe Limited OneTag Limited OpenX Pubmatic, Inc TypeA Holdings Ltd Magnite, Inc Seedtag Advertising S.L Sharethrough, Inc Sonobi, Inc Sovrn, Inc Nexxen Inc. Nexxen Group LLC Equativ Microsoft Advertising

Vendor ID

Vendor Name

58 617 50 793 32 143 24 91 814 755 10 333 910 109 241 69 76 1043 52 157 80 104 13 23 36 45 1126

33Across
Onfocus (Adagio)
Adform A/S
Amazon Advertising
Xandr, Inc.
Connatix Native Exchange Inc.
Epsilon
Criteo SA
Eskimi
Google Advertising Products
Index Exchange Inc.
InMobi Pte Ltd
Insticator
LoopMe Limited
OneTag Limited
OpenX
Pubmatic, Inc
TypeA Holdings Ltd
Magnite, Inc
Seedtag Advertising S.L
Sharethrough, Inc
Sonobi, Inc
Sovrn, Inc
Nexxen Inc.
Nexxen Group LLC
Equativ
Microsoft Advertising

Supported Countries:(as of May 2025)

Country	Alpha-2	Alpha-3
Australia	AU	AUS
Austria	AT	AUT
Belgium	BE	BEL
Canada	CA	CAN
Cyprus	CY	CYP
Czechia	CZ	CZE
Denmark	DK	DNK
Estonia	EE	EST
Finland	FI	FIN
France	FR	FRA
Germany	DE	DEU
Hong Kong	HK	HKG
Hungary	HU	HUN
Ireland	IE	IRL
Italy	IT	ITA
Liechtenstein	LI	LIE
Luxembourg	LU	LUX
Macao	MO	MAC
Mexico	MX	MEX
Monaco	MC	MCO
Montenegro	ME	MNE
Netherlands	NL	NLD
New Zealand	NZ	NZL
Norway	NO	NOR
Poland	PL	POL
Portugal	PT	PRT
Qatar	QA	QAT
Saudi Arabia	SA	SAU
Singapore	SG	SGP
Slovakia	SK	SVK
South Africa	ZA	ZAF
Spain	ES	ESP
Sweden	SE	SWE
Switzerland	CH	CHE
United Arab Emirates	AE	ARE
United Kingdom	GB	GBR
United States	US	USA

Quality guidance:

We recommend following the quality guidance to improve monetization outcomes.