Site Object

Note

Fields marked with an asterisk (*) are optional.

Site Object Properties

Value

Type

Description

id

string

(Recommended) An exchange specific identifier comprised of the Supplier’s exchange name, and the target site ID appended following an underscore. For example, if a Supplier such as Rubicon sends a bid request for site ID "123", the field becomes "rubicon_123"

name*

string

Site name (may be masked by publisher request), for example, "Test Site"

domain*

string

Domain of the site, used for advertiser side blocking. "testsite.com"

content*

object

Passes the content object, see the Content Object section for details

cattax*

int

The taxonomy in use for cat. If no cattax field is supplied, the IAB Content Category Taxonomy 1.0 (1) is assumed. For the most up to date list, refer to the AdCOM 1.0 list List.

  • 1 IAB Tech Lab Content Category Taxonomy 1.0

  • 2 IAB Tech Lab Content Category Taxonomy 2.0

  • 3 IAB Tech Lab Ad Product Taxonomy 1.0

  • 4 IAB Tech Lab Audience Taxonomy 1.1

  • 5 IAB Tech Lab Content Taxonomy 2.1

  • 6 IAB Tech Lab Content Taxonomy 2.2

  • 500+ Vendor-specific codes

sectioncat*

array of strings

Array of IAB content categories that describe the current section of the site. The taxonomy to be used is defined by the cattax field

pagecat*

array of strings

Array of IAB content categories that describe the current page or view of the page. The taxonomy to be used is defined by the cattax field

cat*

array of strings

Array of IAB content categories for the site. ["IAB1", "IAB2-3"]

page*

string

URL of the page where the impression will be shown. "http://testsite.com/main.asp"

ref*

string

Referrer URL that caused navigation to the current page, for example, "http://testsite.com/main.asp"

search*

string

Search string that caused navigation to the current page.

privacypolicy*

integer

Indicates if the site has a privacy policy.

  • 0 = No

  • 1 = Yes.

mobile*

integer

Mobile-optimized signal.

  • 0 = No

  • 1 = Yes.

publisher*

object

Publisher object, for more information, see the Publisher Object section.

keywords*

string

A comma separated list of keywords about the App, e.g "news, weather, sports". Only one of keywords or kwarray should be passed.

kwarray*

array of string

An array of keywords about the App, e.g ["news", "weather", "sports"]. Only one of keywords or kwarray should be passed.

ext*

object

Site extension object

Site Ext

Site Extension Object Properties

Value

Type

Description

amp

bool

Indicates if the site is AMP (Accelerated Mobile Pages) optimised, where 1 = Yes and 0 = No

inventorypartnerdomain

string

A pointer to the domain of the partner (of the site/app owner) with ownership of some portion of ad inventory on the site/app. The partner’s ads.txt or app-ads.txt file will be hosted here. This directive was added in the (app-)ads.txt v1.0.3 specification update.

Site Object Example

{
  "site":{
    "id":"abc35123",
    "name":"Site ABCD",
    "domain":"siteabcd.com",
    "cat":[
      "IAB2-1",
      "IAB2-2"
    ],
    "page":"http://siteabcd.com/page.htm",
    "ref":"http://referringsite.com/referringpage.htm",
    "privacypolicy":1,
    "ext":{
      "inventorypartnerdomain":"examplepartnerdomain.com",
      "amp": 0
    },
    "publisher":{
      "id":"abc2345",
      "name":"Publisher A"
    }
  }
}