Skip to main content

Data Model Overview

Channels​

A channel is a container of sites, which can be targeted with placements. A channel is required for an ad to run. Channels support the following parameters:

  • Account ID: The channel's parent account ID
  • Channel ID: The channel's unique identifier
  • Title: The channel's name
  • Ad Types: Array of ad types that the channel supports rendering
  • CPM: Cost per thousand impressions
  • Status: Active/Archived

Sites​

A site is an individual domain that an account controls. These domains are used to make it easier to target the right ads to the right locations. Sites support the following parameters:

  • Channel ID: The associated parentChannel for the Site
  • Site ID: The site's unique identifier
  • Title: The site's name
  • URL: Link to the site (validated URL format)
  • Contact Name: Name of the site's contact person
  • Contact Email: Email of the site's contact person

Zones​

A zone is where an advertising creative is rendered on a page. There may be multiple zones set up on a single page of a website. A zone supports specific ad types and gives the ability to specifically target campaigns to a certain zone but not to other spots. Zones support the following parameters:

  • Site ID: The site's unique identifier
  • Channel ID: The associated parent Channel for the Site
  • Zone ID: the zone's unique identifier
  • Title: The zone's name
  • URL: Link to the zone (validated URL format)
  • Ad Types: Array of supported ad types (from available)
  • Width: Width of the zone in pixels
  • Height: Height of the zone in pixels
  • Comments: Any additional comments or notes about the zone

Ad Types​

Inventory keeps track of ad formats. The ad format ensures that the platform returns an ad that will fit in the ad slot. Ad sizes/types support the following parameters:

  • Size: Dimensions of the ad as a ratio (8:1, 19:9, etc)
  • Type: Type of the ad (banner, video, native, product card, product carousel)