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.
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:
code can be used interchangeably with
Xandr ID assigned by the API to reference this site.
PUT, in query string
Optional code for this site.
Name associated with the site.
State of this site. Possible values:
URL of this site.
ID of the publisher that this site belongs to.
POST/PUT, in query string
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.
The timestamp of last activity to this placement.
array of objects
The IDs of placements associated with this site. See Placements below for more details.
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.
The intended audience of the site. Must not be null if 'audited' is true. Possible values:
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).
Whether the site has been audited.
Name of the publisher the site is under
Specifies whether this is a site viewed on a desktop browser (
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.
Some mobile application supply sources do not support all creative formats available on Xandr.
array of strings
The creative formats to be excluded or included in this site.
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.
|object||Informs the buyer which types of marketplaces are accessible (performance, RTB, deals). See Marketplace Map below for internal field definitions.|
|multi-object||The Mobile App Instance associated with this site. This field can only be set when |
|int||The ID of the mobile app instance associated with this site. This field is only associated with sites with a |
|Boolean||Read-only. Whether the site is only eligible for CPA/CPC demand based on our auditing. If |
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).
|Boolean||Whether the site is eligible for CPA/CPC demand using the updated performance marketplace. If true, then yes.|
|Boolean||Specifies whether deals are allowed to serve on this site.|
|Boolean||Read-only. Indicates that all inventory associated with this site and its placements is blocked from participating in the RTB Marketplace.|
|Boolean||Read-only. Indicates that all deals are suspended from serving on this site.|
Mobile App Instance
|int||The unique ID of this app instance. This field is optional on |
|int||If no |
|int||If no |
The unique identifier of the placement. You can use the Placement Service to find placement IDs.
The internal code for the placement
ID of the content category. You can use the Content Category Service to find category IDs. \
Whether or not the content category is a system ("universal") category
The name of the category
List of IDs which fall under this content category
Whether the category is the primary category for the site. Only one category can be primary
The ID of the inventory attribute.
Read-only. The name of the inventory attribute.
Photo & video sharing
Toolbars, plugins, or extensions
Adding content categories to a site
Viewing all sites for your publishers
Create a site with a mobile app supply type
In this example we create a site designed for mobile app supply ? we'll use it in our next example as well:
Add a mobile app instance to a site
In this example, we have a pre-existing site with the required mobile app supply type. We make a
PUT call to associate our site with an existing mobile app instance, and we can see that it worked by viewing the updated object in the response. For more details on mobile app instances, see the Mobile App Instance Service.