Open API Documentation

Overview

This document describes the Open API endpoints for inventory management. All API endpoints require authentication via Bearer token in the Authorization header.

Authentication

All API requests must include a valid authorization token in the request header:

Authorization: Bearer <your_auth_token>

App Management

Create App

Creates a new app.

Endpoint: POST https://ofp.adx.opera.com/openapi/inventory/v1/app/create

Request Body:

Field	Type	Required	Description
name	string	Yes	App name
deviceType	int	Yes	Device type (see Device Types)
osType	int	Yes	Operating system type (see OS Types)
trafficType	int	Yes	Traffic type (see Traffic Types)
pkgName	string	Conditional	Package name (required when trafficType = 0 for App)
domainName	string	Conditional	Domain name (required when trafficType = 1 for Web)
url	string	Yes	App store URL or website URL
appAdsTxtLink	string	Yes	App-ads.txt URL
category	string	Yes	App category
coppaCompliant	boolean	No	COPPA compliance flag (default: false)

Example Request:

json

{
  "name": "My App",
  "deviceType": 1,
  "osType": 2,
  "trafficType": 0,
  "pkgName": "com.example.myapp",
  "url": "https://play.google.com/store/apps/details?id=com.example.myapp",
  "appAdsTxtLink": "https://example.com/app-ads.txt",
  "category": "Games",
  "coppaCompliant": false
}

Response:

json

{
  "publisherId": "pub213660626112",
  "appId": "app14463798688768",
  "displayId": "app14463798688768",
  "name": "My App",
  "deviceType": 1,
  "osType": 2,
  "trafficType": 0,
  "pkgName": "com.example.myapp",
  "domainName": "",
  "url": "https://play.google.com/store/apps/details?id=com.example.myapp",
  "appAdsTxtLink": "https://example.com/app-ads.txt",
  "category": "Games",
  "coppaCompliant": false,
  "status": 2,
  "createTime": "2026-01-13T08:54:15Z",
  "updateTime": "2026-01-13T08:54:15Z"
}

Update App

Updates an existing app. This API supports incremental updates — only the fields included in the request body will be updated, and omitted fields will retain their current values.

Endpoint: POST https://ofp.adx.opera.com/openapi/inventory/v1/app/update

Request Body:

Field	Type	Required	Description
appId	string	Yes	App ID to update
status	int	No	Status (see Status Values)
name	string	No	App name
deviceType	int	No	Device type
osType	int	No	Operating system type
trafficType	int	No	Traffic type
pkgName	string	No	Package name
domainName	string	No	Domain name
url	string	No	App store URL or website URL
appAdsTxtLink	string	No	App-ads.txt URL
category	string	No	App category
coppaCompliant	boolean	No	COPPA compliance flag

Example Request:

json

{
  "appId": "app_67890",
  "name": "My Updated App",
  "status": 1
}

Response:

Same structure as Create App response.

List Apps

Retrieves a list of apps.

Endpoint: POST https://ofp.adx.opera.com/openapi/inventory/v1/app/list

Request Body:

Field	Type	Required	Description
deviceType	int	No	Filter by device type
osType	int	No	Filter by OS type
trafficType	int	No	Filter by traffic type
category	string	No	Filter by category
status	int[]	No	Filter by status list

Example Request:

json

{
  "deviceType": 1,
  "osType": 2,
  "status": [0, 1]
}

Response:

json

{
  "list": [
    {
      "publisherId": "pub213660626112",
      "appId": "app14463798688768",
      "displayId": "app14463798688768",
      "name": "My Updated App",
      "deviceType": 1,
      "osType": 2,
      "trafficType": 0,
      "pkgName": "com.example.myapp",
      "domainName": "",
      "url": "https://play.google.com/store/apps/details?id=com.example.myapp",
      "appAdsTxtLink": "https://example.com/app-ads.txt",
      "category": "Games",
      "coppaCompliant": false,
      "status": 1,
      "createTime": "2026-01-13T08:54:15Z",
      "updateTime": "2026-01-13T08:55:08Z"
    }
  ],
  "totalCount": 1
}

Placement Management

Create Placement

Creates a new ad placement.

Endpoint: POST https://ofp.adx.opera.com/openapi/inventory/v1/placement/create

Request Body:

Field	Type	Required	Description
appId	string	Yes	App ID to create placement for
name	string	Yes	Placement name
floorPrice	number	No	Floor price in USD (e.g., 0.5 = $0.50)
countryFloorPrice	array	No	Country-specific floor prices (see below)
sdkAdFormat	int	Yes	SDK ad format (see SDK Ad Formats)
sdkAdTypes	int[]	Conditional	SDK ad types (required if sdkAdFormat is 1,3 or 5; see SDK Ad Types)
sdkAdSize	int	Conditional	SDK ad size (required if sdkAdFormat is 2; see SDK Ad Sizes)
sdkAutoRefresh	boolean	No	Enable auto refresh
sdkAutoRefreshInterval	int	Conditional	Auto refresh interval in seconds, between 15 and 150
rewardedName	string	No	Reward name (for rewarded ads, max 50 characters)
rewardedQuantity	int	No	Reward quantity (1-1000)
rewardedDeliverySetting	int	No	Reward delivery setting (0=No callback, 1=Server callback)
callbackUrl	string	No	Server-to-server callback URL (required if rewardedDeliverySetting=1)
securityKey	string	No	Security key

Country Floor Price Object:

Field	Type	Description
countryCodes	string	Comma-separated country codes (e.g., "US,CA") or "*" for all
floorPrice	number	Floor price in USD

Example Request:

json

{
  "appId": "app14463798688768",
  "name": "Banner Bottom",
  "floorPrice": 0.5,
  "countryFloorPrice": [
    { "countryCodes": "US,CA", "floorPrice": 0.8 },
    { "countryCodes": "CN", "floorPrice": 0.3 }
  ],
  "sdkAdFormat": 2,
  "sdkAdSize": 1,
  "sdkAutoRefresh": true,
  "sdkAutoRefreshInterval": 30
}

Response:

json

{
  "sid": "s14463823852672",
  "appId": "app14463798688768",
  "name": "Banner Bottom",
  "status": 2,
  "floorPrice": 0.5,
  "countryFloorPrice": [
    {
      "countryCodes": "US,CA",
      "floorPrice": 0.8
    },
    {
      "countryCodes": "CN",
      "floorPrice": 0.3
    }
  ],
  "sdkAdFormat": 2,
  "sdkAdTypes": [],
  "sdkAdSize": 1,
  "sdkAutoRefreshInterval": 30,
  "sdkAutoRefresh": true,
  "orientation": 0,
  "rewardedName": "",
  "rewardedQuantity": 0,
  "rewardedDeliverySetting": 0,
  "callbackUrl": "",
  "securityKey": "",
  "createTime": "2026-01-13T09:00:48Z",
  "updateTime": "2026-01-13T09:00:48Z"
}

Update Placement

Updates an existing placement. This API supports incremental updates — only the fields included in the request body will be updated, and omitted fields will retain their current values.

Endpoint: POST https://ofp.adx.opera.com/openapi/inventory/v1/placement/update

Request Body:

Field	Type	Required	Description
sid	string	Yes	Placement ID to update
status	int	No	Status (see Status Values)
name	string	No	Placement name
floorPrice	number	No	Floor price in USD
countryFloorPrice	array	No	Country-specific floor prices
sdkAdFormat	int	No	SDK ad format
sdkAdTypes	int[]	Conditional	SDK ad types (required if sdkAdFormat is 1,3 or 5; see SDK Ad Types)
sdkAdSize	int	Conditional	SDK ad size (required if sdkAdFormat is 2; see SDK Ad Sizes)
sdkAutoRefresh	boolean	No	Enable auto refresh
sdkAutoRefreshInterval	int	Conditional	Auto refresh interval in seconds, between 15 and 150
orientation	int	No	Ad orientation
rewardedName	string	No	Reward name (max 50 characters)
rewardedQuantity	int	No	Reward quantity (1-1000)
rewardedDeliverySetting	int	No	Reward delivery setting (0=No callback, 1=Server callback)
callbackUrl	string	No	Callback URL (required if rewardedDeliverySetting=1)
securityKey	string	No	Security key

Example Request:

json

{
  "sid": "s14463823852672",
  "name": "Banner Top",
  "floorPrice": 0.6,
  "status": 1
}

Response:

Same structure as Create Placement response.

List Placements

Retrieves a list of placements.

Endpoint: POST https://ofp.adx.opera.com/openapi/inventory/v1/placement/list

Request Body:

Field	Type	Required	Description
appId	string	No	Filter by app ID
appType	int	No	Filter by app type
sdkAdFormat	int	No	Filter by SDK ad format
category	string	No	Filter by category
status	int	No	Filter by status

Example Request:

json

{
  "appId": "app_67890",
  "status": 1
}

Response:

json

{
  "list": [
    {
      "sid": "s14463823852672",
      "appId": "app14463798688768",
      "name": "Banner Top",
      "status": 1,
      "floorPrice": 0.6,
      "countryFloorPrice": [
        {
          "countryCodes": "US,CA",
          "floorPrice": 0.8
        },
        {
          "countryCodes": "CN",
          "floorPrice": 0.3
        }
      ],
      "sdkAdFormat": 2,
      "sdkAdTypes": [],
      "sdkAdSize": 1,
      "sdkAutoRefreshInterval": 30,
      "sdkAutoRefresh": true,
      "orientation": 0,
      "rewardedName": "",
      "rewardedQuantity": 0,
      "rewardedDeliverySetting": 0,
      "callbackUrl": "",
      "securityKey": "",
      "createTime": "2026-01-13T09:00:48Z",
      "updateTime": "2026-01-13T09:01:45Z"
    }
  ],
  "totalCount": 1
}

Enumerations

Device Types

Value	Description
0	Unknown
1	Phone
2	Tablet
3	Desktop
4	Connected Device
5	Set Top Box
6	Others

OS Types

Value	Description
0	Unknown
1	iOS
2	Android
3	Roku
4	Windows
5	Tizen
6	Other
7	Fire
8	Web
9	Linux
10	Mac
11	Feature Phone

Traffic Types

Value	Description
0	App
1	Web

Status Values

Value	Description
0	Inactive
1	Active

SDK Ad Formats

Value	Description
1	App Open
2	Banner
3	Interstitial
4	MREC
5	Native
6	Rewarded
7	Rewarded Interstitial

SDK Ad Types

Value	Description
1	Image
2	Video

SDK Ad Sizes

Value	Description
1	320*50
2	300*250

Error Handling

All API responses follow a consistent format:

Success Response:

json

{
  "code": 0,
  "msg": "ok",
  "data": { ... }
}

Error Response:

json

{
  "code": <error_code>,
  "msg": "<error_message>"
}

Common Error Codes

Code	Description
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing token
403	Forbidden - Insufficient scope
500	Internal Server Error

Rate Limiting

API requests are subject to rate limiting. If you exceed the rate limit, you will receive a 429 Too Many Requests response. Please implement appropriate retry logic with exponential backoff.

OpenRTB

Extensions

DSP

User Sync

SSP

User Sync

Events Integration

Pixel

MMP

Self Service

Marketplace

App

OperaAds SDK

Android SDK

iOS SDK

Web

Header Bidding

OFP

Open API Documentation

Overview

Authentication

App Management

Create App

Update App

List Apps

Placement Management

Create Placement

Update Placement

List Placements

Enumerations

Device Types

OS Types

Traffic Types

Status Values

SDK Ad Formats

SDK Ad Types

SDK Ad Sizes

Error Handling

Common Error Codes

Rate Limiting

Extensions

User Sync

User Sync

Pixel

MMP

Marketplace

OperaAds SDK

Android SDK

iOS SDK

Header Bidding

Open API Documentation ​

Overview ​

Authentication ​

App Management ​

Create App ​

Update App ​

List Apps ​

Placement Management ​

Create Placement ​

Update Placement ​

List Placements ​

Enumerations ​

Device Types ​

OS Types ​

Traffic Types ​

Status Values ​

SDK Ad Formats ​

SDK Ad Types ​

SDK Ad Sizes ​

Error Handling ​

Common Error Codes ​

Rate Limiting ​

Open API Documentation

Overview

Authentication

App Management

Create App

Update App

List Apps

Placement Management

Create Placement

Update Placement

List Placements

Enumerations

Device Types

OS Types

Traffic Types

Status Values

SDK Ad Formats

SDK Ad Types

SDK Ad Sizes

Error Handling

Common Error Codes

Rate Limiting