• com/iabtechlab/adcom/adcom.proto

• com/iabtechlab/adcom/enums/enums.proto

  • Creative

  • APIFramework

  • AuditStatusCode

  • CategoryTaxonomy

  • ClickType

  • CompanionType

  • ConnectionType

  • ContentContext

  • Creative.Attribute

  • Creative.AudioType

  • Creative.DisplayType

  • Creative.VideoType

  • DOOHVenueType

  • DeliveryMethod

  • DeviceType

  • DisplayContextType

  • DisplayPlacementType

  • EventTrackingMethod

  • EventType

  • ExpandableDirection

  • FeedType

  • LinearityMode

  • LocationService

  • LocationType

  • MediaRating

  • NativeDataAssetType

  • NativeImageAssetType

  • OperatingSystem

  • PlacementPosition

  • PlaybackCessationMode

  • PlaybackMethod

  • ProductionQuality

  • SizeUnit

  • VideoPlacementSubtype

  • VolumeNormalizationMode

• com/iabtechlab/adcom/context/context.proto

  • Content
  • Data
  • Device
  • DistributionChannel
  • DistributionChannel.App
  • DistributionChannel.DOOH
  • DistributionChannel.Site
  • Geo
  • Producer
  • Publisher
  • Regs
  • Segment
  • User

• com/iabtechlab/adcom/media/media.proto

  • Ad
  • Ad.Audio
  • Ad.Audit
  • Ad.Display
  • Ad.Display.Banner
  • Ad.Display.Event
  • Ad.Display.Event.CdataEntry
  • Ad.Display.Native
  • Ad.Display.Native.Asset
  • Ad.Display.Native.Asset.DataAsset
  • Ad.Display.Native.Asset.ImageAsset
  • Ad.Display.Native.Asset.LinkAsset
  • Ad.Display.Native.Asset.TitleAsset
  • Ad.Display.Native.Asset.VideoAsset
  • Ad.Video

• com/iabtechlab/adcom/placement/placement.proto

  • Placement
  • Placement.AudioPlacement
  • Placement.Companion
  • Placement.DisplayPlacement
  • Placement.DisplayPlacement.DisplayFormat
  • Placement.DisplayPlacement.EventSpec
  • Placement.DisplayPlacement.NativeFormat
  • Placement.DisplayPlacement.NativeFormat.AssetFormat
  • Placement.DisplayPlacement.NativeFormat.AssetFormat.DataAssetFormat
  • Placement.DisplayPlacement.NativeFormat.AssetFormat.ImageAssetFormat
  • Placement.DisplayPlacement.NativeFormat.AssetFormat.TitleAssetFormat
  • Placement.VideoPlacement

• Scalar Value Types

Top

Make it easy to include adcom by providing a single point of entry.

Top

The following enumerations are referenced by attributes in AdCOM objects.

The following enum is a list of API frameworks either supported by a placement or required by an ad.

The following enum lists the codes used in "Audit" objects to reflect status or workflow state.

This enum identiifes the taxonomy in effect when content categories are listed. http://www.iab.com/guidelines/taxonomy

The following enum defines the types of creative action (i.e., click) behavior types.

The following enum defines the options to indicate markup types allowed for companion ads that apply to video and audio ads. This enum is derived from VAST 2.0+ and DAAST 1.0+ specifications.

The following enum defines the options for the type of device connectivity.

The following enum defines the various options for indicating the type of content being used or consumed by the user in which ads may appear. This enum has values derived from the TAG Inventory Quality Guidelines (IQG).

The following enum defines a standard list of creative attributes that can describe an actual ad or restrictions relative to a given placement.

The following enum defines the various subtypes of audio ad creatives.

The following enum defines the various subtypes of display ad creatives.

The following enum defines the various subtypes of video ad creatives.

This enum presents the digital out-of-home venue types and is derived from the DPAA Programmatic Standards.

The following enum defines the various options for the delivery of video or audio content.

The following enum defines the types of devies. This enum has values derived from the TAG Inventory Quality Guidelines (IQG).

The following enum defines the types of context in which a native ad may appear (i.e., the type of content surrounding the ad on the page). This is intended to denote primary content although other content may also appear on the page. Note that there are two levels of detail grouped by 10s (i.e., 12 is a refined case of 100).

The following enum defines the general types of display placements; the locations where a native ad may be shown in relationship to the surrounding content.

In the atomic unit of the content (e.g., in the article page or single image page). | | OUTSIDE_CONTENT | 3 | Outside the core content (.e.g, in the ads section on the right rail, as a banner | | RECOMMENDATION | 4 | style placement near the content, etc.).

Recommendation widget; most commonly presented below article content. |

This enum lists the available methods of tracking of ad events. Vendor specific codes may include custom measurement companies (e.g., Moat, Doubleverify, IAS, etc.).

The following enum defines the types of ad events available for tracking. These types refer to the actual event, timing, etc.; not the method of firing. Scripts that are performing measurement should be deployed at impression time.

The following enum defines the directions in which an expandable ad may expand, given the positioning of the ad unit on the page and constraints imposed by the content.

The following enum defines the types of feeds for audio.

The following enum indicates the options for media linearity, typically for video.

The following enum defines the services and/or vendors used for resolving IP addresses to geolocations.

The following enum defines the options to indicate how the geographic information was determined.

The following enum defines the media ratings used in describing content based on the TAG Inventory Quality Guidelines (IQG) v2.1 categorization. Refer to www.iab.com/guidelines/digital-video-suite for more information.

The following enum defines the common data asset types. This list is non-exhaustive and is intended to be expanded over time. Size recommendations are noted as "maximum length of at least", which means the publisher or supply platform should support a maximum length of at least this value and the buying platform knows that a string of this size should be accepted.

The following enum defines the set of common image asset types. This list is non-exhaustive and is intended to be expanded over time. Size recommendations are noted as "maximum height or width of at least", which means the publisher or supply platform should support a maximum height or width of at least this value and the buying platform knows that an image of this size should be accepted.

The following enum defines the options for device operating system.

The following enum defines the placement positions as a relative measure of visibility or prominence. This enum has values derived from the TAG Inventory Quality Guidelines (IQG).

The following enum defines the various modes for when media playback terminates.

The following table lists the various media playback methods.

The following enum defines the options for content quality. These values are defined by the IAB; refer to www.iab.com/wp-content/uploads/2015/03/long-form-video-final.pdf for more information.

The following enum lists the units of height and width used by creatives, assets, and placement specifications where noted.

The following enum lists the various types of video placements derived largely from the IAB Digital Video Guidelines.

The following enum defines the types of volume normalization modes, typically for audio.

Top

This group of objects represent concepts that are interacting, presenting, enclosing, or are otherwise relating to the world in which impressions live. These include the user, their device, their location, the channel (e.g., site, app, digital out-of-home) with which they are interacting, the channel's publisher, its content, and any regulations that are in effect (e.g., COPPA, GDPR).

This object describes the content in which an impression can appear, which may be syndicated or non-syndicated content. This object may be useful when syndicated content contains impressions and does not necessarily match the publisher's general content. An exchange may or may not have knowledge of the page where the content is running as a result of the syndication method (e.g., a video impression embedded in an iframe on an unknown web property or device).

The data and segment objects together allow additional data about the related object (e.g., user, content) to be specified. This data may be from multiple sources whether from the exchange itself or third parties as specified by the "id" attribute. When in use, vendor-specific IDs should be communicated a priori among the parties.

This object provides information pertaining to the device through which the user is interacting. Device information includes its hardware, platform, location, and carrier data. The device can refer to a mobile handset, a desktop computer, set top box, or other digital device.

A distribution channel is an abstraction of the various types of entities or channels through which ads are distributed. Examples include websites, mobile apps, and digital out-of-home (DOOH) systems. This generalized class contains those attributes and relationships that are common to all distribution channels and as such, all of its attributes and relationships are inherited by each of its derived classes.

This object is used to define an ad supported non-browser application, in contrast to a typical website.

This object is used to define an ad supported digital out-of-home (DOOH) experience such as a public kiosk or digital billboard.

This object is used to define an ad supported website, in contrast to a non-browser application, for example.

This object encapsulates various methods for specifying a geographic location. When subordinate to a "Device" object, it indicates the location of the device which can also be interpreted as the user's current location. When subordinate to a "User" object, it indicates the location of the user's home base (i.e., not necessarily their current location).

The "lat" and "lon" attributes should only be passed if they conform to the accuracy depicted in the "type" attribute. For example, the centroid of a large region (e.g., postal code) should not be passed.

This object defines the producer of the content in which ad will be displayed. This is particularly useful when the content is syndicated and may be distributed through different publishers and thus when the producer and publisher are not necessarily the same entity.

This object describes the publisher of the media in which ads will be displayed.

This object contains any known legal, governmental, or industry regulations that are in effect.

Segment objects are essentially key-value pairs that convey specific units of data. The parent "Data" object is a collection of such values from a given data provider. When in use, vendor- specific IDs should be communicated a priori among the parties.

This object contains information known or derived about the human user of the device (i.e., the audience for advertising). The user ID is a vendor-specific artifact and may be subject to rotation or other privacy policies. However, this user ID must be stable long enough to serve reasonably as the basis for frequency capping and retargeting.

Top

The Media group of objects defines an actual ad including reference to its creative and metadata to enable proper rendering, restrictions compliance, event tracking, and quality auditing. The following figure presents the objects and interrelationships in this group. The objects are defined in the subsections thereafter.

This object is the root of a structure that defines in instance of advertising media. It includes metadata about the ad overall and sub-objects that provide additional detail specific to the type of media comprising the creative.

This object provides additional detail about an ad specifically for audio ads.

This objects represents the outcome of some form of review of the ad. This is typical, for example, when scanning for malware or otherwise performing ad quality reviews.

This object provides additional detail about an ad specifically for display ads. There are multiple attributes for specifying creative details: "banner" for simple banner images "native" for native ads, "ad" for including general markup, and "curl" for referencing general markup via URL. In any given "Display" object, only one of these attributes should be used to avoid confusion. To the extent feasible, structured objects should be favored over general markup for quality and safety issues.

This object describes a basic banner creative. It is intended for display scenarios that require a simple, structured image/link pair and is more secure than allowing arbitrary HTML or JavaScript code.

This object specifies a type of event that the advertiser or buying platform wants to track along with the information required to do so.

This object is the root of a structure that defines a native display ad.

This object is the container for each asset comprising a native ad. Each asset is of a specific type and to reflect this, one and only one of the subtype objects (i.e., "title", "img", "video", "data") must be present; all others should be omitted.

This object identifies the native asset as a data asset. A data asset is used for all miscellaneous elements such as brand name, ratings, stars, review count, downloads, price, counts, etc. It is purposefully generic to support native elements not currently contemplated by this specification.

This object identifies the native asset as a image asset. Image assets are use for such elements as the actual creative images and icons.

This object identifies the native asset as a link asset and is used to define navigation for call-to-action or other activations (i.e., clicks). A link asset can be independent or associated with the overall native ad (i.e., a default for all assets).

This object identifies the native asset as a title asset, which is essentially just a plain text string with specified length.

This object identifies the native asset as a video asset. Video markup (e.g., VAST) must be either included or referenced.

This object provides additional detail about an ad specifically for video ads.

Top

The Placement group includes objects that define the set of allowed ads for a given impression. This can include mechanical information (e.g., sizes, supported mime types and other rendering options), placement details and positioning, various restrictions lists (e.g., advertiser domains, content categories), and more.

This object represents the properties of a placement and the characteristics of ads permitted to be rendering within them. Placements of all types begin with this object as their root. It contains one or more subtype objects (i.e., "display", "video", "audio") that define the kinds of media permitted as well as media specific placement behaviors.

The other attributes in this object apply to all aspects and substructures of the placement (i.e., the same block lists, language, secure status, etc. apply to all media types and native assets as applicable).

This object signals that the placement may be an audio placement and provides additional detail about permitted audio ads (e.g., DAAST).

This object is used in video and audio placements to specify an associated or so-called companion display ad. Video and audio placements can specify an array of companion ads.

This object signals that the placement may be a display placement. It provides additional detail about permitted display ads including simple banners, AMPHTML (i.e., Accelerated Mobile Pages), and native.

This object represents an allowed set of parameters for a banner display ad and often appears as an array when multiple sizes are permitted.

This object specifies a type of ad tracking event and which methods of tracking are available for it. This object may appear as an array for a given placement indicating various types of available tracking events.

This object refines a display placement to be specifically a native display placement. It serves as the root of a structure that includes the specifications for each of the assets that comprise the native placement.

This object represents the permitted specifications of a single asset of a native ad. Along with its own attributes, exactly one of the asset subtype objects must be included. All others must be omitted.

This object is used to provide native asset format specifications for a data element. A data asset is used for all miscellaneous elements such as brand name, ratings, stars, review count, downloads, prices, etc. It is purposefully generic to support native elements not currently contemplated by this specification.

This object is used to provide native asset format specifications for an image element. Image elements are typically used for actual creative image and icons.

This object is used to provide native asset format specifications for a title element. Title elements are simple strings.

This object signals that the placement may be a video placement and provides additional detail about permitted video ads (e.g., VAST).