Skip to end of metadata
Go to start of metadata

Site Service

A site (also called a placement group) provides a way of grouping placements for management purposes. Ad quality and inventory categorization can be set at the site level, so it doesn't have to be duplicated across placements. Each site belongs to a publisher, and each placement must belong to a site.

When you create a publisher, a site is automatically created. You can then modify that site however you wish or create more sites.

On This Page

REST API

Add a site:

Modify an existing site:

Delete a site:

View all sites for your publishers:

View all of the sites for one of your publishers:

View a specific site for one of your publishers:

View multiple sites by ID using a comma-separated list:

Note that publisher_code and code can be used interchangeably with publisher_id and id, respectively.

JSON Fields

Field

Type (Length)

Description

Default

Required On

id

int

Xandr ID assigned by the API to reference this site.

 

PUT, in query string

code

string (100)

Optional code for this site.

  

name

string (100)

Name associated with the site.

 

PUT, POST

state

enum

State of this site. Possible values: active or inactive.

active

 

url

string (255)

URL of this site.

  

publisher_id

int

ID of the publisher that this site belongs to.

 

POST/PUT, in query string

primary_content_category_id

int

Users can optionally specify a primary content category for a placement (see example below). This category can be used for targeting and will appear in reports. Content categories can be set either at the Site level or the Placement level, but not both.

  

last_modified

timestamp

The timestamp of last activity to this placement.

  

placements

array of objects

The IDs of placements associated with this site. See Placements below for more details.

  

content_categories

array

Users can optionally specify one or more content categories for a placement. These categories can be used for targeting, and can be set at both the Site and Placement level. At most 20 categories can be set on a site. See Content Categories below for more details.

  

intended_audience

enum

The intended audience of the site. Must not be null if 'audited' is true. Possible values: children, young_adult, general, or mature.

null

 

inventory_attributes

array

The sensitive attributes contained by the site; if set at the site level, inventory_attributes will also influence objects at the placement level. The mapping of IDs to attributes can be found below. The format of the array is also contained below. To learn more about the value of self-classifying inventory, see Inventory Self-Classification (Customer login required).

null

 

audited

boolean

Whether the site has been audited.

  

publisher_join

array

   

publisher_name

string (100)

Name of the publisher the site is under

  

supply_type

string

Specifies whether this is a site viewed on a desktop browser (web), a site viewed on a mobile browser (mobile_web), or an app run on a mobile device (mobile_app). This distinction allows the buyer to target campaigns to the particular supply type where they want to advertise, for example, an advertiser may upload creatives optimized for mobile browsers with mobile landing pages.

As of February 13th, 2018, the supply type configured in each auction is detected automatically by Xandr. As a result, the selection you make here will be overridden by the supply type detected. This selection will eventually be removed from the UI. For more information, please see Supply Type Detection FAQ.

The license could not be verified: License Certificate has expired!

web

 

creative_format_action

string

  • exclude: allow all creative formats to serve on this site except those specified in the creative_formats array
  • include: only all creatives to serve whose format is included in the list specified in creative_formats

Some mobile application supply sources do not support all creative formats available on Xandr.

exclude

 

creative_formats

array of strings

The creative formats to be excluded or included in this site.

text

 

allowed_click_actions

array of strings

Tells the buyer what types of click actions on creatives are supported. Mobile web and apps often allow additional click actions beyond click to a website, such as click-to-call, click-to-sms, click-to-email, and click-to-map.

click-to-web only

 
marketplace_mapobjectInforms the buyer which types of marketplaces are accessible (performance, RTB, deals). See Marketplace Map below for internal field definitions.  
mobile_app_instancemulti-objectThe Mobile App Instance associated with this site. This field can only be set when supply_type is mobile_app. See Mobile App Instance below for the internal field definitions. POST, for sites with a supply_type of mobile_app.
mobile_app_instance_idintThe ID of the mobile app instance associated with this site. This field is only associated with sites with a supply_type of mobile_app.  

Marketplace Map

ParameterTypeDescriptionDefault Value
an_audit_perf_only BooleanRead-only. Whether the site is only eligible for CPA/CPC demand based on our auditing. If true, then yes.false
rtbBoolean

Designates whether the inventory associated with the site (and all of its placements) is part of the RTB Marketplace (i.e., eligible for CPM demand).

  • If true, all inventory associated with this site's placements is to be resold within the RTB Marketplace.
  • The field cannot be set to true if any of the placements within the site support the expandable media type. See the Placement Service for more information about media types and subtypes fields.
  • If false, expandable placements within the site cannot be moved to a site where the field is true.
  • If set to false all inventory associated with this site's placements is only available to direct campaigns. No inventory associated with this placement group's placements will be resold.
true
performanceBooleanWhether the site is eligible for CPA/CPC demand using the updated performance marketplace. If true, then yes.false
deals_allowedBooleanSpecifies whether deals are allowed to serve on this site.true
rtb_suspendedBooleanRead-only. Indicates that all inventory associated with this site and its placements is blocked from participating in the RTB Marketplace.false
deals_suspendedBooleanRead-only. Indicates that all deals are suspended from serving on this site.false

Mobile App Instance

ParameterTypeDescription
idintThe unique ID of this app instance. This field is optional on POST; if sent, it will be used to look up the bundle_id and os_family_id. If this field is not set on a PUT or POST, you must pass in the bundle_id and os_family_id fields, and a new mobile app instance ID will be created.
bundle_idintIf no id field is passed on POST, this field is required. This field represents the bundle ID of the mobile app instance, and it's used to look up the mobile app instance ID. If there is no app instance ID associated with this bundle ID, a new one will be created.
os_family_idintIf no id field is passed in on PUT or POST, this field is required. This field represents the unique ID of the operating system family this app instance is associated with. If there is no app instance ID associated with this OS family ID, a new one will be created.

 

Placements

Parameter

Type

Description

id

int

The unique identifier of the placement. You can use the Placement Service to find placement IDs.

code

string

The internal code for the placement

Content Categories

Parameter

Type

Description

id

int

ID of the content category. You can use the Content Category Service to find category IDs. \

is_system

Boolean

Whether or not the content category is a system ("universal") category

name

string (100)

The name of the category

site

array

List of IDs which fall under this content category

primary

Boolean

Whether the category is the primary category for the site. Only one category can be primary

Inventory Attributes

Parameter

Type

Description

inventory_attribute_id

int

The ID of the inventory attribute.

name

string (50)

Read-only. The name of the inventory attribute.

Inventory Attributes

ID

Attribute Name

2

Political

4

Social Media

6

Photo & video sharing

8

Forums (moderated)

10

Forums (unmoderated)

12

Incentivized clicks

14

Non-English languages

16

Streaming Media

17

Toolbars, plugins, or extensions

The license could not be verified: License Certificate has expired!

Example

Adding content categories to a site
Viewing all sites for your publishers
Create a site with a mobile app supply type
Add a mobile app instance to a site

Related Topics