Link
Search
Menu
Expand
Document
Publishers
Welcome Publishers
Integrations
OpenX UI Overview
Accounts and Users
Prebid.js Adapters
Prebid.js Setup for Web
Prebid.js Setup for Video
OpenRTB S2S Integrations
Integration Process
Auction Details
User Synchronization
Reporting to OpenX
Bid Requests
Bid Responses
JavaScript Ad Tags
Implementing Ad Tags
Avoiding Namespace Collisions
Asynchronous JS Ad Tags
Synchronous JS Ad Tags
Passing Mobile Parameters
OX Instance Methods
OX Static Methods
Ad Request API Calls
Ad Request Parameters
OpenRTB Ad Request Parameters
Custom Variables
Ad Request and Response Examples
OpenX VAST Tags
ironSource VAST Tags
MoPub VAST Tags
Fyber VAST Tags
Mobile App VAST Tags
CTV Inventory VAST Tags
Web VAST Tags
Opt-in Video
Iframe Ad Tags
Getting Started
Access & UI Environment
Inventory
Sites
Ad Units
Ad Tags
Ad Unit Groups
Packages
Publishers Tab
Selling Rules
Pricing Controls
Managing Floors
Ad Quality
Setting Ad Quality Filters
Traffic Quality
Ads.txt
App-ads.txt
SupplyChain Object Integration
Private Marketplaces
Creating Packages for PMP
Managing Packages
Deals
Creating Deals
Managing Deals
Troubleshooting Deals
Deal Details
Targeting
Inventory and Content Targeting
Geographic Targeting
Technology and Devices Targeting
Custom Variable Targeting
Audience Targeting
Category Targeting
Screen Type Targeting
Viewability Targeting
Video Targeting
Domain Targeting
Reporting for Publishers
Reporting Interface
Analyze Dashboard
Creating a Workspace
Managing Metrics
Managing Dimensions
Managing Pivot Charts
Managing Plot Charts
Creating Reports
Scheduling Reports
Reports History
Creating Alerts
Sharing Workspaces
Metrics and Dimensions Reference
How Reporting Works
Demand Partners
Welcome Demand Partners
Getting Started for Demand
Integrating with Ad Exchange
Win Notifications
Passing Buyer and Creative IDs
Passing Macros in Bid Responses
Meeting Ad Quality Requirements
Synchronizing User Data
Testing and Launching your Integration
Tool Set
Traffic Shaper
Logging In
Setting and Managing RTB Endpoints
Managing Business Units
Creating Traffic Sets
Ad Sizes
Managing Traffic Sets
Blocklisting Categories & Domains
About Smart Throttling
OpenRTB API
OpenRTB HTTP Headers
BidRequest Object
BidResponse Object
Examples
Platform API
Inventory Formats & Screens
Targeting Mobile App Inventory
Targeting Video Inventory
Targeting Opt-in Video
Targeting CTV Inventory
Bidding Optimizations
Compressing Bid Requests
Receiving Loss Notifications
Working with Multi-size Bid Requests
Programmatic Direct Deals
Reporting for Demand
Reporting Interface
Analyze Dashboard
Creating a Workspace
Managing Metrics
Managing Dimensions
Managing Pivot Charts
Managing Plot Charts
Creating Reports
Scheduling Reports
Reports History
Creating Alerts
Sharing Workspaces
Metrics and Dimensions Reference
How Reporting Works
Adopting Ads.txt
iOS14 and SKAdNetwork Support
Marketers
Welcome Marketers
BIDS
Efficiently Query your Bids Data
BIDS Available Fields
Apollo
Prebid Analytics
Setting Up Alerts
Prebid Analytics Data Schema
OpenAudience
OpenAudience™
OpenAudience™ UI
Creating an Audience
Creating a Deal
Uploading Segments
Managing Audiences
Audience Details
Managing Deals
Managing Segments
Managing Users
Direct Audiences
Match Synch
Taxonomy
Platform API
Platform API
Authenticating Users
API Client Libraries
Third-party Libraries
Conventions
Requests and Responses
Response Codes and Error Handling
Data Service API
Use Cases
Working with Accounts
Working with Inventory
Working with Demand Objects
Working with Comments
Working with Targeting
Targeting Dimension Reference
Working with History
Platform API Reference
account object
ad object
adunit object
adunitgroup object
audittrail service
comment object
creative object
deal object
floorrule object
geo service
lineitem object
market service
optimization object
options service
order object
package object
paymenthistory object
session service
site object
sitesection object
subtypes service
user object
Authentication Reference
Before You Begin
About OAuth
About Signing Requests
Methods of Authentication
Browser-Based Authentication
Programmatic Authentication
Programmatic Authentication Sample
Resources
Release Notes
Privacy and Regulatory
Regulations
How OpenX Tracks User Activity
How the Cookie-based Opt-out Mechanism Works
How the DNT Header-based Opt-out Mechanism Works
Image Tag
HTTP Redirect Request
JSON Request
JavaScript Tag
Checking Opt-out Status
GDPR Integration Support
CCPA Integration Support
Copyright & Legal Notices
Glossary
Support
PDF
Use Cases
Platform API
This section describes common tasks using the Platform API.
contents
Working with Accounts
Working with Inventory
Working with Demand Objects
Working with Comments
Working with Targeting
Targeting Dimension Reference
Working with History