Link Search Menu Expand Document

PDF

package object

Platform API


Allows you to group inventory that can be reused for different deals or pricing controls without having to be defined again.

The package object provides a series of endpoints as described in the following sections.


Listing Available Fields

Click to expand this section


GET /package/available_fields: Lists all the available fields to create or update packages.

Sample request

curl http://PUBLISHER-ui.openx.net/ox/4.0/package/available_fields?action=create

URL parameter

ParameterTypeDescriptionRequired?
actionstringList the available fields for a specific action. Valid values are create and update. Default is create.Optional

Sample response

Each field shown in the sample response is defined within the relevant endpoint on this page.

Expand sample response
{
   "uid": {
      "has_dependencies": false,
      "auto": true,
      "readonly": true,
      "required": false,
      "type": "uid"
   },
   "logo": {
      "has_dependencies": false,
      "maxlen": 2000,
      "readonly": false,
      "required": false,
      "type": "varchar"
   },
   "contact_name": {
      "has_dependencies": false,
      "maxlen": 255,
      "readonly": false,
      "required": false,
      "type": "varchar"
   },
   "id": {
      "has_dependencies": false,
      "auto": true,
      "readonly": true,
      "required": false,
      "type": "int"
   },
   "deal_id": {
      "has_dependencies": false,
      "readonly": false,
      "required": false,
      "type": "int"
   },
   "modified_date": {
      "has_dependencies": false,
      "auto": true,
      "readonly": true,
      "required": false,
      "type": "datetime"
   },
   "targeting": {
      "has_dependencies": false,
      "default": {},
      "readonly": false,
      "required": true,
      "type": "targeting"
   },
   "floorrule_id": {
      "has_dependencies": false,
      "readonly": false,
      "required": false,
      "type": "int"
   },
   "type": {
      "default": "package",
      "auto": true,
      "required": false,
      "value": "package",
      "has_dependencies": false,
      "maxlen": 255,
      "readonly": true,
      "type": "varchar"
   },
   "start_date": {
      "has_dependencies": false,
      "readonly": false,
      "required": false,
      "type": "datetime"
   },
   "status": {
      "maxlen": 255,
      "url": "/options/package_status_options",
      "required": true,
      "has_dependencies": false,
      "default": "Active",
      "readonly": false,
      "type": "varchar"
   },
   "account_id": {
      "has_dependencies": false,
      "auto": true,
      "readonly": true,
      "required": false,
      "type": "int"
   },
   "end_date": {
      "has_dependencies": false,
      "readonly": false,
      "required": false,
      "type": "datetime"
   },
   "deleted": {
      "default": "0",
      "auto": true,
      "required": false,
      "has_dependencies": false,
      "readonly": true,
      "type": "int"
   },
   "v": {
      "default": "3",
      "auto": true,
      "required": false,
      "has_dependencies": false,
      "readonly": true,
      "type": "int",
      "options": []
   },
   "contact_email": {
      "has_dependencies": false,
      "maxlen": 255,
      "readonly": false,
      "required": false,
      "type": "email"
   },
   "deal_uid": {
      "has_dependencies": false,
      "readonly": false,
      "required": false,
      "type": "uid"
   },
   "floorrule_uid": {
      "has_dependencies": false,
      "readonly": false,
      "required": false,
      "type": "uid"
   },
   "instance_uid": {
      "auto": true,
      "required": false,
      "has_dependencies": false,
      "maxlen": 255,
      "readonly": true,
      "type": "varchar"
   },
   "name": {
      "has_dependencies": false,
      "maxlen": 255,
      "readonly": false,
      "required": true,
      "type": "varchar"
   },
   "oxtl": {
      "has_dependencies": false,
      "auto": true,
      "readonly": true,
      "required": false,
      "type": "oxtl_field"
   },
   "notes": {
      "has_dependencies": false,
      "maxlen": 25000,
      "readonly": false,
      "required": false,
      "type": "varchar"
   },
   "rate_card_cpm": {
      "default": "0.0001",
      "required": false,
      "maximum": "10000.0000",
      "has_dependencies": false,
	  "readonly": false,
      "minimum": "0.0001",
      "type": "decimal(9,4)"
   },
   "urls": {
      "has_dependencies": false,
      "items": {
         "has_dependencies": false,
         "maxlen": 2000,
         "readonly": false,
         "required": false,
         "type": "varchar"
      },
      "readonly": false,
      "required": false,
      "type": "array"
   },
   "created_date": {
      "has_dependencies": false,
      "auto": true,
      "readonly": true,
      "required": false,
      "type": "datetime"
   },
   "domains": {
      "has_dependencies": false,
      "maxlen": 255,
      "readonly": false,
      "required": false,
      "type": "varchar"
   },
   "private_market": {
      "has_dependencies": false,
      "readonly": false,
      "required": false,
      "type": "object",
      "available_fields": {
         "participants": {
            "has_dependencies": false,
            "items": {
               "has_dependencies": false,
               "readonly": false,
               "required": false,
               "type": "object",
               "available_fields": {
                  "openx_buyer_ids": {
                     "url": "/options/options/buyer_options",
                     "items": {
                        "has_dependencies": false,
                        "maxlen": 255,
                        "readonly": false,
                        "required": false,
                        "type": "varchar"
                     },
                     "required": false,
                     "has_dependencies": false,
                     "readonly": false,
                     "type": "array"
                  },
                  "demand_partner": {
                     "url": "/options/targetable_demand_partner_options",
                     "required": true,
                     "has_dependencies": false,
                     "maxlen": 255,
                     "readonly": false,
                     "type": "varchar"
                  },
                  "rate_card_cpm": {
                     "required": false,
                     "maximum": "10000.0000",
                     "has_dependencies": false,
                     "readonly": false,
                     "minimum": "0.0001",
                     "type": "decimal(9,4)"
                  }
               }
            },
            "readonly": false,
            "required": false,
            "type": "array"
         },
         "discoverable": {
            "has_dependencies": false,
            "readonly": false,
            "required": true,
            "type": "int"
         },
         "default_discounted_cpm": {
            "required": false,
            "maximum": "10000.0000",
            "has_dependencies": false,
            "readonly": false,
            "minimum": "0.0001",
            "type": "decimal(9,4)"
         },
         "default_rate_card_cpm": {
            "default": "0.0001",
            "required": true,
            "maximum": "10000.0000",
            "has_dependencies": false,
            "readonly": false,
            "minimum": "0.0001",
            "type": "decimal(9,4)"
         }
      }
   },
   "external_id": {
      "has_dependencies": false,
      "maxlen": 255,
      "readonly": false,
      "required": false,
      "type": "varchar"
   },
   "account_uid": {
      "has_dependencies": false,
      "readonly": false,
      "required": true,
      "type": "account_uid"
   }
}

Creating a Package

Click to expand this section


POST /package: Creates a new package.

Sample request

curl -X POST http://PUBLISHER-ui.openx.net/ox/4.0/package --cookie "openx3_access_token=token_string"
--header "Content-Type:application/json" --data '{"logo":"http://www.test.com/awesome-sample-package.png","contact_name":"John Smith",
"start_date":null, "status":"Active", "end_date":null, "contact_email":"john.smith@openx.com", "name":"Awesome Sample Package",
"notes":"This is a super, duper, awesome sample package.", "urls":["http://scores.espn.com"], "domains":"espn.com",
"private_market":{"discoverable":"1", "default_rate_card_cpm":"13", "default_discounted_cpm":"7",
"participants":[{"demand_partner":"537146932", "openx_buyer_ids":null, "rate_card_cpm":"2"}]},
"account_uid":"00000148-accf-fff1-8123-467d57", "targeting":{"content":{"includes":{}, "excludes":{}},
"inter_dimension_operator":"AND", "viewability":{"viewability_score":{"val":"0.60", "op":">="}}}, "rate_card_cpm":"12",
"discounted_cpm":null}'

URL parameters

The parameters below can also be listed by calling GET /package/available_fields?action=create.

ParameterTypeDescriptionRequired?
account_uidaccount_uidOpenX identifier for the account.
For example, 600aa500-accf-fff1-8123-b0769b
Required
namestringName of the package. In the UI, the Package Name field.Required
statusstringStatus of package. Valid values:
   • Active
   • Paused
Required
targetingtargetingRules that define inventory to be bought and sold and how inventory is targeted for delivery to viewers. In the UI, the target values in the Targeting section.

Note: If no targeting is selected, the targeting of the package is set to MATCH ALL.
Required
domainsstringTop-level domains associated with the package. In the UI, the Domains field.
For example, elle.com, cnn.com
Optional

Required either when discoverable is set to 1, or demand_partner is identified. Both parameters are listed in Private Marketplace parameters table below.
contact_emailstringEmail of the person to contact if questions exist about the package. In the UI, the Contact Email field.Optional
contact_namestringName of the person to contact if questions exist about the package. In the UI, the Contact Name field.Optional
end_datedateEnd date for the package. In the UI, the Active Dates End Date field.Optional
logostringURL of the logo to represent the package. In the UI, the Package Logo (URL) field.
For example, http://www.site.com/package_logo.jpg
Optional
notesstringText description of an item. In the UI, the Description field.Optional
private_marketobjectPricing settings for a PMP deal which including: rate card price, discounted/list price, discoverability of deal, demand partners, and buyer names.
In the UI, all the Private Marketplace Package Rates values in the Discover, Participants & Pricing Rates section. Accepted values for this parameter are in the Private Marketplace parameters table below.
Optional
rate_card_cpmintegerList price for inventory sold directly by the publisher to an advertiser. In the UI, the Direct Package Rates Rate Card Price under the Discovery, Participants & Pricing Rates section.Optional
start_datedateStart date for a package. In the UI, the Active Dates Start Date field.Optional
urlsstring (array)Example URLs included in package. In the UI, this is the Sample URLs field. For example, ["http://sub1.site.com", "http://sub2.site.com", "http://sub3.site.com"]Optional

Private Marketplace parameters

ParameterTypeDescriptionRequired?
default_rate_card_cpmintegerList price for inventory sold to a limited set of buyers. In the UI, the Private Marketplace Package Rates Rate Card Price field under the Discovery, Participants & Pricing Rates section. The value is a decimal (9,4) type: a total of 9 digits are accepted, 4 of which are after the decimal point.Required
discoverablebooleanMake default_rate_card_cpm and default_discounted_cpm viewable to all buyers.
   • 0 = Not discoverable.
   • 1 = Discoverable.

Note: Buyers identified in demand_partner are exempt from the impact of the discoverable setting. The demand_partner parameter is listed in the Participants table below.
Required
default_discounted_cpmintegerWhen set, displays as price for inventory sold to a limited set of buyers.
In the UI, the Private Marketplace Package Rates Discounted / List Price field under the Discovery, Participants & Pricing Rates section. Rate Card Price appears red with strike-through in Package Summary. The value is a decimal (9,4) type: a total of 9 digital are accepted, 4 of which are after the decimal point.
Optional
participantsparticipantsDemand partners (demand_partner) and buyers (openx_buyer_ids) who can see the Private Marketplace Package Rates. Specific prices (rate_card_cpm) can be assigned to each demand partner or demand partner-buyer combination. Accepted values for this parameter are in the Participants parameters table below.Optional

Participants parameters

ParameterTypeDescriptionRequired?
demand_partnerstringSpecific demand partners eligible to buy inventory through the package. In the UI, this is the Demand Partner drop down. To list all valid demand partner values, call GET /options/targetable_demand_partner_options.Required
openx_buyer_idsstringSpecific buyers eligible to buy inventory through the package. In the UI, this is the Buyer Names field. To list all valid buyer values, call GET /options/options/buyer_options.Optional
rate_card_cpmintegerWhen set, displays as price for inventory sold to a specific demand partner or demand partner-buyer combination. In the UI, this is the Price field.
The value is a decimal (9,4) type: a total of 9 digits are accepted, 4 of which are after the decimal point.
Optional

Sample response

Expand sample response
[{
   "deal_id": null,
   "logo": "http://www.test.com/awesome-sample-package.png",
   "contact_name": "John Smith",
   "id": "536900407",
   "uid": "20007337-c0af-fff1-8123-467d57",
   "modified_date": "2017-04-20 03:59:02",
   "targeting": {
      "content": {
         "excludes": {},
         "includes": {}
      },
      "viewability": {
         "viewability_score": {
            "val": "0.60",
            "op": ">="
         }
      },
      "inter_dimension_operator": "AND"
   },
   "floorrule_id": null,
   "type": "package",
   "start_date": null,
   "revision": 1,
   "status": "Active",
   "account_id": "328",
   "end_date": null,
   "deleted": "0",
   "v": "3",
   "contact_email": "john.smith@openx.com",
   "deal_uid": null,
   "floorrule_uid": null,
   "instance_uid": "350541de08dc63f93bf2731324aa390842467d57",
   "name": "Awesome Sample Package",
   "oxtl": "ox.viewability.score >= \"0.60\"",
   "notes": "This is a super, duper, awesome sample package.",
   "rate_card_cpm": "12.0000",
   "urls": {
      "http://scores.espn.com/": true
   },
   "created_date": "2017-04-20 03:59:02",
   "domains": "espn.com",
   "private_market": {
      "participants": [{
         "demand_partner": "537146932",
         "openx_buyer_ids": null,
         "rate_card_cpm": "2.0000"
      }],
      "default_rate_card_cpm": "13.0000",
      "default_discounted_cpm": "7.0000",
      "discoverable": "1"
   },
   "external_id": null,
   "account_uid": "00000148-accf-fff1-8123-467d57"
}]

Package response data

ParameterDescription
account_idOpenX identifier for the account. For example, 537235117
account_uidOpenX identifier for the account. For example, 600aa500-accf-fff1-8123-b0769b
contact_emailEmail of the person to contact if questions exist about the package. In the UI, the Contact Email field.
contact_nameName of the person to contact if questions exist about the package. In the UI, the Contact Name field.
created_dateDate and time of creation. For example, 2019-10-15 20:58:39
deal_idOpenX identifier for a deal ID. For example, OX-qav-AfLYGL
deal_uidOpenX identifier for a deal ID. For example, 60146f8e-c0a9-fff1-8123-0c9a66
deletedFlag specifying whether the item has been deleted.
   • 0 = Not deleted.
   • 1 = Deleted.
domainsTop-level domains associated with the package. In the UI, the Domains field. For example, elle.com, cnn.com
end_dateEnd date for the package. In the UI, the Active Dates End Date field.
external_idFree-form reference identifier.
floorrule_idOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 1610612745
floorrule_uidOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 60000009-f100-fff1-8123-0c9a66
idOpenX identifier for the package. For example, 536900407
instance_uidPlatform_hash of session. For example, a505e730-0b7a-11e3-8ffd-0800200c9a66
logoURL of the logo to represent the package. In the UI, the Package Logo (URL) field. For example, http://www.site.com/package_logo.jpg
modified_dateTimestamp of when the last change was made. For example, 2019-10-15 21:09:36
oxtlOpenX Targeting Language use to summarize targeting rules. For example, "ox.viewability.score >= \"0.60\"
nameName of the package. In the UI, the Package Name field.
notesText description of an item. In the UI, the Description field.
private_marketPricing settings for a PMP deal which including: rate card price, discounted/list price, discoverability of deal, demand partners, and buyer names.
In the UI, all the Private Marketplace Package Rates values in the Discover, Participants & Pricing Rates section. Accepted values for this parameter are in the Private Marketplace parameters table below.
rate_card_cpmList price for inventory sold directly by the publisher to an advertiser. In the UI, the Direct Package Rates Rate Card Price under the Discovery, Participants & Pricing Rates section.
revisionRevision number of the object. For example, 4
start_dateStart date for a package.
In the UI, the Active Dates Start Date field.
statusStatus of package. Valid values:
   • Active
   • Paused
targetingRules that define inventory to be bought and sold and how inventory is targeted for delivery to viewers. In the UI, the target values in the Targeting section.

Note: If no targeting is selected, the targeting of the package is set to MATCH ALL.
typeType of object query. To list all valid type values, call GET /options/model_types.
uidOpenX identifier associated with the package. For example, 600038a3-c0af-fff1-8123-0c9a66
urlsExample URLs included in package. In the UI, this is the Sample URLs field. For example, ["http://sub1.site.com", "http://sub2.site.com", "http://sub3.site.com"]
vVersion of the API. For example, 3

Cloning a Package

Click to expand this section


POST /package/{package_UID}/clone: Creates a duplicate of an existing package.

As an example, use this method to duplicate a package that has performed well for a subset of clients as the foundation for another potentially successful package.

Sample request

curl http://PUBLISHER-ui.openx.net/ox/4.0/package/20007337-c0af-fff1-8123-467d57/clone --cookie "openx3_access_token=token_string"

URL parameter

ParameterTypeDescriptionRequired?
package_uidpackage_uidOpenX identifier for a package. For example, 20007337-c0af-fff1-8123-467d57.

Note: Use GET /package to retrieve a list of all package_uid values.
Required
deepbooleanClone descendant objects as well if true. Default is false.Optional

Sample response

Expand sample response
[{
   "deal_id": null,
   "logo": "http://www.test.com/awesome-sample-package.png",
   "contact_name": "John Smith",
   "id": "536900746",
   "uid": "2000748a-c0af-fff1-8123-467d57",
   "modified_date": "2017-04-23 21:11:41",
   "targeting": {
      "content": {
         "excludes": {},
         "includes": {}
      },
      "viewability": {
         "viewability_score": {
            "val": "0.60",
            "op": ">="
         }
      },
      "inter_dimension_operator": "AND"
   },
   "floorrule_id": null,
   "type": "package",
   "start_date": null,
   "revision": 1,
   "status": "Active",
   "account_id": "328",
   "end_date": null,
   "deleted": "0",
   "v": "3",
   "contact_email": "john.smith@openx.com",
   "deal_uid": null,
   "floorrule_uid": null,
   "instance_uid": "350541de08dc63f93bf2731324aa390842467d57",
   "name": "Copy 2017-04-23 21:11:41 of Awesome Sample Package",
   "oxtl": "ox.viewability.score >= \"0.60\"",
   "notes": "This is a super, duper, awesome sample package.",
   "rate_card_cpm": "12.0000",
   "urls": {
      "http://scores.espn.com/": true
   },
   "created_date": "2017-04-23 21:11:41",
   "domains": "espn.com",
   "private_market": {
      "participants": [{
         "demand_partner": "537146932",
         "openx_buyer_ids": null,
         "rate_card_cpm": "2.0000"
      }],
      "default_rate_card_cpm": "13.0000",
      "default_discounted_cpm": "7.0000",
      "discoverable": "1"
   },
   "external_id": null,
   "account_uid": "00000148-accf-fff1-8123-467d57"
}]

Response parameters

ParameterDescription
account_idOpenX identifier for the account. For example, 537235117
account_uidOpenX identifier for the account. For example, 600aa500-accf-fff1-8123-b0769b
contact_emailEmail of the person to contact if questions exist about the package. In the UI, the Contact Email field.
contact_nameName of the person to contact if questions exist about the package. In the UI, the Contact Name field.
created_dateDate and time of creation. For example, 2019-10-15 20:58:39
deal_idOpenX identifier for a deal ID. For example, OX-qav-AfLYGL
deal_uidOpenX identifier for a deal ID. For example, 60146f8e-c0a9-fff1-8123-0c9a66
deletedFlag specifying whether the item has been deleted.
   • 0 = Not deleted
   • 1 = Deleted
domainsTop-level domains associated with the package. In the UI, the Domains field. For example, elle.com, cnn.com
end_dateEnd date for the package. In the UI, the Active Dates End Date field.
external_idFree-form reference identifier.
floorrule_idOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 1610612745
floorrule_uidOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 60000009-f100-fff1-8123-0c9a66
idOpenX identifier for the package. For example, 536900407
instance_uidPlatform_hash of session. For example, a505e730-0b7a-11e3-8ffd-0800200c9a66
logoURL of the logo to represent the package. In the UI, the Package Logo (URL) field. For example, http://www.site.com/package_logo.jpg
modified_dateTimestamp of when the last change was made. For example, 2019-10-15 21:09:36
oxtlOpenX Targeting Language use to summarize targeting rules. For example, ox.viewability.score >= \"0.60\"
nameName of the package. In the UI, the Package Name field.
notesText description of an item. In the UI, the Description field.
private_marketPricing settings for a PMP deal which including: rate card price, discounted/list price, discoverability of deal, demand partners, and buyer names.
In the UI, all the Private Marketplace Package Rates values in the Discover, Participants & Pricing Rates section. Accepted values for this parameter are in the Private Marketplace parameters table below.
rate_card_cpmList price for inventory sold directly by the publisher to an advertiser. In the UI, the Direct Package Rates Rate Card Price under the Discovery, Participants & Pricing Rates section.
revisionRevision number of the object. For example, 4
start_dateStart date for a package. In the UI, the Active Dates Start Date field.
statusStatus of package. Valid values, Active and Paused.
targetingRules that define inventory to be bought and sold and how inventory is targeted for delivery to viewers. In the UI, the target values in the Targeting section.
Note: If no targeting is selected, the targeting of the package is set to MATCH ALL.
typeType of object query. To list all valid type values, call GET /options/model_types.
uidOpenX identifier associated with the package. For example, 600038a3-c0af-fff1-8123-0c9a66
urlsExample URLs included in package. In the UI, this is the Sample URLs field. For example, ["http://sub1.site.com", "http://sub2.site.com", "http://sub3.site.com"]
vVersion of the API. For example, 3

Listing All Packages

Click to expand this section


GET /package: Lists the entire package object for all packages.

Sample request

curl http://PUBLISHER-ui.openx.net/ox/4.0/package?status=Paused&overload=light --cookie "openx3_access_token=token_string"

URL parameters

The list of packages can be filtered or sorted by adding a URL parameter to the GET request.

ParameterTypeDescriptionRequired?
account_uidaccount_uidOpenX identifier for the account.
For example, 600aa500-accf-fff1-8123-b0769b
Optional
deal_uiddeal_uidOpenX identifier for a deal ID.
For example, 60146f8e-c0a9-fff1-8123-0c9a66
Optional
floorrule_uidfloorrule_uidOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression.
For example, 60000009-f100-fff1-8123-0c9a66.
Optional
limitintegerNumber of items to list in results. Default is 10.Optional
namestringName of the package. In the UI, the Package Name field.Optional
offsetaccount_uidBeginning item in results. Must be used with limit. In this instance, starting account_uid in results.Optional
overloadstring• If set to light, returns only the uid for all items in results.
• If set to medium returns full objects for all items in results.
Default is medium.
Optional
sortstringName of a field by which results are sorted.
Note: Appending a (-) to a field name reverses sorting order. For example, sort=-name.
Optional
statusstringStatus of package. Valid values:
   • Active
   • Paused
Optional
uidpackage_uidOpenX identifier for a package. For example, 20007337-c0af-fff1-8123-467d57

Note: Use GET /package to retrieve a list of all package_uid values.
Optional

Sample response

{
   "has_more": false,
   "limit": 10,
   "uids": [
      "60009ecc-c0af-fff1-8123-0c9a66",
      "60009ed5-c0af-fff1-8123-0c9a66",
      "60003580-c0af-fff1-8123-0c9a66"
   ],
   "offset": 0
}

Response data

ParameterDescription
has_moreIndicator of more results.
• If the total number of results is greater than the limit value, the has_more value is true.
• If total number of results is equal to or less than the limit value, the has_more value is false.
limitNumber of items to list in results. Default is 10.
offsetBeginning item in results. Must be used with limit.
uidsObject of OpenX package identifiers. For example, ["60009ecc-c0af-fff1-8123-0c9a66", "60009ed5-c0af-fff1-8123-0c9a66", "60003580-c0af-fff1-8123-0c9a66"]

Listing a Single Package

Click to expand this section


GET /package/{package_uid}: Lists the specified package object.

Sample request

curl http://PUBLISHER-ui.openx.net/ox/4.0/package/20007337-c0af-fff1-8123-467d57 --cookie "openx3_access_token=token_string"

URL parameter

ParameterTypeDescriptionRequired?
package_uidpackage_uidOpenX identifier for a package.
For example, 20007337-c0af-fff1-8123-467d57

Note: Use GET /package to retrieve a list of all package_uid values.
Required

Sample response

Expand sample response
{
   "has_more": false,
   "objects": [{
      "uid": "60009ecc-c0af-fff1-8123-0c9a66",
      "logo": null,
      "contact_name": null,
      "id": "1610653388",
      "deal_id": null,
      "modified_date": "2017-04-21 20:01:20",
      "targeting": {},
      "floorrule_id": null,
      "type": "package",
      "start_date": null,
      "revision": 14,
      "status": "Paused",
      "account_id": "537235117",
      "end_date": null,
      "deleted": "0",
      "v": "3",
      "contact_email": null,
      "deal_uid": null,
      "floorrule_uid": null,
      "private_market": null,
      "instance_uid": "a505e730-0b7a-11e3-8ffd-0800200c9a66",
      "name": "bo8",
      "oxtl": "",
      "notes": "",
      "rate_card_cpm": "0.0001",
      "urls": null,
      "created_date": "2014-10-02 05:32:46",
      "domains": "website.com",
      "external_id": null,
      "account_uid": "20058ead-accf-fff1-8123-0c9a66"
   }],
   "limit": 10,
   "offset": 0
}

Response data

ParameterDescription
account_idOpenX identifier for the account. For example, 537235117
account_uidOpenX identifier for the account. For example, 600aa500-accf-fff1-8123-b0769b
contact_emailEmail of the person to contact if questions exist about the package. In the UI, the Contact Email field.
contact_nameName of the person to contact if questions exist about the package. In the UI, the Contact Name field.
created_dateDate and time of creation. For example, 2019-10-15 20:58:39
deal_idOpenX identifier for a deal ID. For example, OX-qav-AfLYGL
deal_uidOpenX identifier for a deal ID. For example, 60146f8e-c0a9-fff1-8123-0c9a66
deletedFlag specifying whether the item has been deleted.
   • 0 = Not deleted
   • 1 = Deleted
domainsTop-level domains associated with the package. In the UI, the Domains field For example, elle.com, cnn.com
end_dateEnd date for the package. In the UI, the Active Dates End Date field.
external_idFree-form reference identifier.
floorrule_idOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 1610612745
floorrule_uidOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 60000009-f100-fff1-8123-0c9a66
has_moreIndicator of more results.
• If the total number of results is greater than the limit value, the has_more value is true.
• If total number of results is equal to or less than the limit value, the has_more value is false.
idOpenX identifier for the package. For example, 536900407
instance_uidPlatform_hash of session. For example, a505e730-0b7a-11e3-8ffd-0800200c9a66
limitNumber of items to list in results. Default is 10.
logoURL of the logo to represent the package. In the UI, the Package Logo (URL) field. For example, http://www.site.com/package_logo.jpg
modified_dateTimestamp of when the last change was made. For example, 2015-10-15 21:09:36
nameName of the package. In the UI, the Package Name field.
notesText description of an item. In the UI, the Description field.
offsetBeginning item in results. Must be used with limit.
oxtlOpenX Targeting Language use to summarize targeting rules. For example, ox.viewability.score >= \"0.60\"
private_marketPricing settings for a PMP deal which including: rate card price, discounted/list price, discoverability of deal, demand partners, and buyer names.
In the UI, all the Private Marketplace Package Rates values in the Discover, Participants & Pricing Rates section. Accepted values for this parameter are in the Private Marketplace parameters table below.
start_dateStart date for a package. In the UI, the Active Dates Start Date field.
rate_card_cpmList price for inventory sold directly by the publisher to an advertiser. In the UI, the Direct Package Rates Rate Card Price under the Discovery, Participants & Pricing Rates section.
revisionRevision number of the object. For example, 4
statusStatus of items in results. Valid values:
   • Active
   • Paused
   • Expired
targetingRules that define inventory to be bought and sold and how inventory is targeted for delivery to viewers. In the UI, the target values in the Targeting section.

Note: If no targeting is selected, the targeting of the package is set to MATCH ALL.
typeType of object query. To list all valid type values, call GET /options/model_types.
uidOpenX identifier associated with the package. For example, 600038a3-c0af-fff1-8123-0c9a66
urlsExample URLs included in package. In the UI, this is the Sample URLs field. For example, ["http://sub1.site.com", "http://sub2.site.com", "http://sub3.site.com"]
vVersion of the API. For example, 3

Listing Floor Rules

Click to expand this section


GET /package/{package_uid}/list_floorrules: Lists all the entire floor rule objects for a specific package.

Sample request

curl http://PUBLISHER-ui.openx.net/ox/4.0/package/600038a3-c0af-fff1-8123-0c9a66/list_floorrules?status=Expired&overload=light

URL parameters

The list of floor rules can be filtered or sorted by adding a URL parameter from the table below to the GET request.

ParameterTypeDescriptionRequired?
package_uidpackage_uidOpenX identifier for a package. For example, 20007337-c0af-fff1-8123-467d57.

Note: Use GET /package to retrieve a list of all package_uid values.
Required
limitintegerNumber of items to list in results. Default is 10.Optional
overloadstring• If set to light, returns only the uid for all items in results.
• If set to medium, returns full objects for all items in results.
Default is medium.
Optional
sortstringName of a field by which results are sorted.
Note: Appending a (-) to a field name reverses sorting order. For instance: sort=-name.
Optional
statusstringStatus of items in results. Valid values:
   • Active
   • Paused
   • Expired
Optional

Sample response

{
   "has_more": false,
   "limit": 10,
   "uids": [
      "60000009-f100-fff1-8123-0c9a66",
   ],
   "offset": 0
}

Response data

ParameterDescription
has_moreIndicator of more results.
• If the total number of results is greater than the limit value, the has_more value is true.
• If total number of results is equal to or less than the limit value, the has_more value is false.
limitNumber of items to list in results. Default is 10.
offsetBeginning item in results. Must be used with limit.
uidsObject of OpenX identifiers for the items. Appears when overload=light is added as a URL parameter. For example, ["60009ecc-c0af-fff1-8123-0c9a66", "60009ed5-c0af-fff1-8123-0c9a66", "60003580-c0af-fff1-8123-0c9a66"]

Listing Package Deals

Click to expand this section


GET /package/{package_uid}/list_deals: Lists all the deal objects for a specific package.

Sample request

curl http://PUBLISHER-ui.openx.net/ox/4.0/package/600038a3-c0af-fff1-8123-0c9a66/list_deals?overload=light

URL parameters

The list of deal objects can be filtered or sorted by adding a URL parameter from the table below to the GET request.

ParameterTypeDescriptionRequired?
package_uidpackage_uidOpenX identifier for a package. For example, 20007337-c0af-fff1-8123-467d57

Note: Use GET /package to retrieve a list of all package_uid values.
Required
account_uidstringOpenX identifier for the account. For example, 600aa500-accf-fff1-8123-b0769bOptional
limitintegerNumber of items to list in results. Default is 10.Optional
overloadstring• If set to light, returns only the uid for all items in results.
• If set to medium, returns full objects for all items in results.
Default is medium.
Optional
sortstringName of a field by which results are sorted.
Note: Appending a (-) to a field name reverses sorting order. For instance: sort=-name.
Default field is deal_priority.
Optional
statusstringStatus of items in results. Valid values:
   • Active
   • Paused
   • Expired
Optional
uidstringOpenX identifier for an item.Optional

Sample response

{
   "has_more": false,
   "limit": 7,
   "uids": [
      "6000e993-c0a9-fff1-8123-0c9a66",
      "6000e98e-c0a9-fff1-8123-0c9a66",
      "6000e990-c0a9-fff1-8123-0c9a66",
      "6000e994-c0a9-fff1-8123-0c9a66",
      "600124aa-c0a9-fff1-8123-0c9a66",
      "6000c199-c0a9-fff1-8123-0c9a66",
      "6000e98f-c0a9-fff1-8123-0c9a66"
   ],
   "offset": 0
}

Response data

ParameterDescription
has_moreIndicator of more results.
• If the total number of results is greater than the limit value, the has_more value is true.
• If total number of results is equal to or less than the limit value, the has_more value is false.
limitNumber of items to list in results. Default is 10.
offsetBeginning item in results. Must be used with limit.
uidsObject of OpenX identifiers for the items. Appears when overload=light is added as a URL parameter. For example, ["60009ecc-c0af-fff1-8123-0c9a66", "60009ed5-c0af-fff1-8123-0c9a66", "60003580-c0af-fff1-8123-0c9a66"]

Updating a Package

Click to expand this section


PUT /package/{package_UID}: Updates a specific package.

Use GET /package to retrieve a list of all package_uid values.

Sample request

curl -X PUT http://PUBLISHER-ui.openx.net/ox/4.0/package/20007337-c0af-fff1-8123-467d57 --cookie "openx3_access_token=token_string"
--header "Content-Type:application/json" --data '{"logo":"http://www.test.com/awesome-sample-package.png", "contact_name":"John Smith",
"start_date":null, "status":"Active","end_date":null, "contact_email":"john.smith@openx.com", "name":"Awesome Sample Package",
"notes":"This is a super, duper, awesome sample package.", "urls":["http://scores.espn.com"], "domains":"espn.com",
"private_market":{"discoverable":"1", "default_rate_card_cpm":"13", "default_discounted_cpm":"7",
"participants":[{"demand_partner":"537146932", "openx_buyer_ids":null, "rate_card_cpm":"2"}]},
"account_uid":"00000148-accf-fff1-8123-467d57", "targeting":{"content":{"includes":{}, "excludes":{}}, "inter_dimension_operator":"AND",
"viewability": {"viewability_score":{"val":"0.60", "op":">="}}}, "rate_card_cpm":"12", "discounted_cpm":null}'

URL parameters

These parameters can also be listed by calling GET /package/available_fields?action=update.

ParameterTypeDescriptionRequired?
namestringName of the package. In the UI, the Package Name field.Required
statusstringStatus of package. Valid values:
   • Active
   • Paused
Required
targetingtargetingRules that define inventory to be bought and sold and how inventory is targeted for delivery to viewers. In the UI, the target values in the Targeting section.

Note: If no targeting is selected, the targeting of the package is set to MATCH ALL.
Required
domainsstringTop-level domains associated with the package. In the UI, the Domains field.
For example, elle.com, cnn.com
Optional

Required either when discoverable is set to 1, or demand_partner is identified. Both parameters are listed in Private Marketplace parameters table below.
account_uidaccount_uidOpenX identifier for the account. For example, 600aa500-accf-fff1-8123-b0769bOptional
contact_emailstringEmail of the person to contact if questions exist about the package. In the UI, the Contact Email field.Optional
contact_namestringName of the person to contact if questions exist about the package. In the UI, the Contact Name field.Optional
deal_idintegerOpenX identifier for a deal ID. For example, OX-qav-AfLYGLOptional
deal_uiduidOpenX identifier for a deal ID. For example, “0146f8e-c0a9-fff1-8123-0c9a66Optional
end_datedateEnd date for the package. In the UI, the Active Dates End Date field.Optional
external_idstringFree-form reference identifier.Optional
floorrule_idintegerOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 1610612745Optional
floorrule_uiduidOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 60000009-f100-fff1-8123-0c9a66Optional
logostringURL of the logo to represent the package. In the UI, the Package Logo (URL) field. For example, http://www.site.com/package_logo.jpgOptional
notesstringText description of an item. In the UI, the Description field.Optional
private_marketobjectPricing settings for a PMP deal which including: rate card price, discounted/list price, discoverability of deal, demand partners, and buyer names. In the UI, all the Private Marketplace Package Rates values in the Discover, Participants & Pricing Rates section. Accepted values for this parameter are in the Private Marketplace parameters table below.Optional
rate_card_cpmintegerList price for inventory sold directly by the publisher to an advertiser. In the UI, the Direct Package Rates Rate Card Price under the Discovery, Participants & Pricing Rates section.Optional
start_datedateStart date for a package. In the UI, the Active Dates Start Date field.Optional
urlsstring (array)Example URLs included in package. In the UI, this is the Sample URLs field. For example, ["http://sub1.site.com", "http://sub2.site.com", "http://sub3.site.com"]Optional

Private Marketplace parameters

ParameterTypeDescriptionRequired?
default_rate_card_cpmintegerList price for inventory sold to a limited set of buyers. In the UI, the Private Marketplace Package Rates Rate Card Price field under the Discovery, Participants & Pricing Rates section. The value is a decimal (9,4) type: a total of 9 digits are accepted, 4 of which are after the decimal point.Required
discoverablebooleanMake default_rate_card_cpm and default_discounted_cpm viewable to all buyers.
   • 0 = Not discoverable.
   • 1 = Discoverable.

Note: Buyers identified in demand_partner are exempt from the impact of the discoverable setting. The demand_partner parameter is listed in the Participants table below.
Required
default_discounted_cpmintegerWhen set, displays as price for inventory sold to a limited set of buyers. In the UI, the Private Marketplace Package Rates Discounted / List Price field under the Discovery, Participants & Pricing Rates section. Rate Card Price appears red with strike-through in Package Summary. The value is a decimal (9,4) type: a total of 9 digital are accepted, 4 of which are after the decimal point.Optional
participantsparticipantsDemand partners (demand_partner) and buyers (openx_buyer_ids) who can see the Private Marketplace Package Rates. Specific prices (rate_card_cpm) can be assigned to each demand partner or demand partner-buyer combination. Accepted values for this parameter are in the Participants parameters table below.Optional

Participants parameters

ParameterTypeDescriptionRequired?
demand_partnerstringSpecific demand partners eligible to buy inventory through the package. In the UI, this is the Demand Partner drop down. To list all valid demand partner values, call GET /options/targetable_demand_partner_options.Required
openx_buyer_idsstringSpecific buyers eligible to buy inventory through the package. In the UI, this is the Buyer Names field. To list all valid buyer values, call GET /options/options/buyer_options.Optional
rate_card_cpmintegerWhen set, displays as price for inventory sold to a specific demand partner or demand partner-buyer combination. In the UI, this is the Price field. The value is a decimal (9,4) type: a total of 9 digits are accepted, 4 of which are after the decimal point.Optional

Sample response

Expand sample response
[{
   "deal_id": null,
   "logo": "http://www.test.com/awesome-sample-package.png",
   "contact_name": "John Smith",
   "id": "536900407",
   "uid": "20007337-c0af-fff1-8123-467d57",
   "modified_date": "2017-04-20 03:59:02",
   "targeting": {
      "content": {
         "excludes": {},
         "includes": {}
      },
      "viewability": {
         "viewability_score": {
            "val": "0.60",
            "op": ">="
         }
      },
      "inter_dimension_operator": "AND"
   },
   "floorrule_id": null,
   "type": "package",
   "start_date": null,
   "revision": 1,
   "status": "Active",
   "account_id": "328",
   "end_date": null,
   "deleted": "0",
   "v": "3",
   "contact_email": "john.smith@openx.com",
   "deal_uid": null,
   "floorrule_uid": null,
   "instance_uid": "350541de08dc63f93bf2731324aa390842467d57",
   "name": "Awesome Sample Package",
   "oxtl": "ox.viewability.score >= \"0.60\"",
   "notes": "This is a super, duper, awesome sample package.",
   "rate_card_cpm": "12.0000",
   "urls": {
      "http://scores.espn.com/": true
   },
   "created_date": "2017-04-20 03:59:02",
   "domains": "espn.com",
   "private_market": {
      "participants": [{
         "demand_partner": "537146932",
         "openx_buyer_ids": null,
         "rate_card_cpm": "2.0000"
      }],
      "default_rate_card_cpm": "13.0000",
      "default_discounted_cpm": "7.0000",
      "discoverable": "1"
   },
   "external_id": null,
   "account_uid": "00000148-accf-fff1-8123-467d57"
}]

Response data

ParameterDescription
account_idOpenX identifier for the account. For example, 537235117
account_uidOpenX identifier for the account. For example, 600aa500-accf-fff1-8123-b0769b
contact_emailEmail of the person to contact if questions exist about the package. In the UI, the Contact Email field.
contact_nameName of the person to contact if questions exist about the package. In the UI, the Contact Name field.
created_dateDate and time of creation. For example, 2019-10-15 20:58:39
deal_idOpenX identifier for a deal ID. For example, OX-qav-AfLYGL
deal_uidOpenX identifier for a deal ID. For example, 60146f8e-c0a9-fff1-8123-0c9a66
deletedFlag specifying whether the item has been deleted.
   • 0 = Not deleted.
   • 1 = Deleted.
domainsTop-level domains associated with the package. In the UI, the Domains field. For example, elle.com, cnn.com
end_dateEnd date for the package. In the UI, the Active Dates End Date field.
external_idFree-form reference identifier.
floorrule_idOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 1610612745
floorrule_uidOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 60000009-f100-fff1-8123-0c9a66
idOpenX identifier for the package. For example, 536900407
instance_uidPlatform_hash of session. For example, a505e730-0b7a-11e3-8ffd-0800200c9a66
logoURL of the logo to represent the package. In the UI, the Package Logo (URL) field. For example, http://www.site.com/package_logo.jpg
modified_dateTimestamp of when the last change was made. For example, 2019-10-15 21:09:36
oxtlOpenX Targeting Language use to summarize targeting rules. For example, ox.viewability.score >= \"0.60\"
nameName of the package. In the UI, the Package Name field.
notesText description of an item. In the UI, the Description field.
private_marketPricing settings for a PMP deal which including: rate card price, discounted/list price, discoverability of deal, demand partners, and buyer names.
In the UI, all the Private Marketplace Package Rates values in the Discover, Participants & Pricing Rates section. Accepted values for this parameter are in the Private Marketplace parameters table below.
rate_card_cpmList price for inventory sold directly by the publisher to an advertiser. In the UI, the Direct Package Rates Rate Card Price under the Discovery, Participants & Pricing Rates section.
revisionRevision number of the object. For example, 4
start_dateStart date for a package. In the UI, the Active Dates Start Date field.
statusStatus of package. Valid values: Active, Paused
targetingRules that define inventory to be bought and sold and how inventory is targeted for delivery to viewers. In the UI, the target values in the Targeting section.

Note: If no targeting is selected, the targeting of the package is set to MATCH ALL.
typeType of object query. To list all valid type values, call GET /options/model_types.
uidOpenX identifier associated with the package. For example, 600038a3-c0af-fff1-8123-0c9a66
urlsExample URLs included in package. In the UI, this is the Sample URLs field. For example, ["http://sub1.site.com", "http://sub2.site.com", "http://sub3.site.com"]
vVersion of the API. For example, 3

Updating Multiple Packages

Click to expand this section


PUT /package: Updates multiple packages.

Use GET /package to retrieve a list of all package_uid values.

Sample request

The request below updates the status of two packages.

curl -X PUT http://PUBLISHER-ui.openx.net/ox/4.0/package --cookie "openx3_access_token=token_string"
--header "Content-Type:application/json" --data-binary '[{"uid":"60146fc1-c0af-fff1-8123-0c9a66","status":"Paused"},
{"uid":"6000cb82-c0af-fff1-8123-0c9a66","status":"Paused"}]'

URL parameters

These parameters can also be listed by calling GET /package/available_fields?action=update.

ParameterTypeDescriptionRequired?
namestringName of the package. In the UI, the Package Name field.Required
statusstringStatus of package. Valid values:
   • Active
   • Paused
Required
targetingtargetingRules that define inventory to be bought and sold and how inventory is targeted for delivery to viewers. In the UI, the target values in the Targeting section.

Note: If no targeting is selected, the targeting of the package is set to MATCH ALL.
Required
domainsstringTop-level domains associated with the package. In the UI, the Domains field.
For example, elle.com, cnn.com
Optional

Required either when discoverable is set to 1, or demand_partner is identified. Both parameters are listed in Private Marketplace parameters table below.
account_uidaccount_uidOpenX identifier for the account. For example, 600aa500-accf-fff1-8123-b0769bOptional
contact_emailstringEmail of the person to contact if questions exist about the package.
In the UI, the Contact Email field.
Optional
contact_namestringName of the person to contact if questions exist about the package.
In the UI, the Contact Name field.
Optional
deal_idintegerOpenX identifier for a deal ID. For example, OX-qav-AfLYGLOptional
deal_uiduidOpenX identifier for a deal ID. For example, “0146f8e-c0a9-fff1-8123-0c9a66Optional
end_datedateEnd date for the package. In the UI, the Active Dates End Date field.Optional
external_idstringFree-form reference identifier.Optional
floorrule_idintegerOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression.
For example, 1610612745
Optional
floorrule_uiduidOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression.
For example, 60000009-f100-fff1-8123-0c9a66
Optional
logostringURL of the logo to represent the package. In the UI, the Package Logo (URL) field. For example, http://www.site.com/package_logo.jpgOptional
notesstringText description of an item. In the UI, the Description field.Optional
private_marketobjectPricing settings for a PMP deal which including: rate card price, discounted/list price, discoverability of deal, demand partners, and buyer names.
In the UI, all the Private Marketplace Package Rates values in the Discover, Participants & Pricing Rates section. Accepted values for this parameter are in the Private Marketplace parameters table below.
Optional
rate_card_cpmintegerList price for inventory sold directly by the publisher to an advertiser. In the UI, the Direct Package Rates Rate Card Price under the Discovery, Participants & Pricing Rates section.Optional
start_datedateStart date for a package. In the UI, the Active Dates Start Date field.Optional
urlsstring (array)Example URLs included in package. In the UI, this is the Sample URLs field. For example, ["http://sub1.site.com", "http://sub2.site.com", "http://sub3.site.com"]Optional

Private Marketplace parameters

ParameterTypeDescriptionRequired?
default_rate_card_cpmintegerList price for inventory sold to a limited set of buyers. In the UI, the Private Marketplace Package Rates Rate Card Price field under the Discovery, Participants & Pricing Rates section. The value is a decimal (9,4) type: a total of 9 digits are accepted, 4 of which are after the decimal point.Required
discoverablebooleanMake default_rate_card_cpm and default_discounted_cpm viewable to all buyers.
   • 0 = Not discoverable.
   • 1 = Discoverable.

Note: Buyers identified in demand_partner are exempt from the impact of the discoverable setting. The demand_partner parameter is listed in the Participants table below.
Required
default_discounted_cpmintegerWhen set, displays as price for inventory sold to a limited set of buyers.
In the UI, the Private Marketplace Package Rates Discounted / List Price field under the Discovery, Participants & Pricing Rates section. Rate Card Price appears red with strike-through in Package Summary. The value is a decimal (9,4) type: a total of 9 digital are accepted, 4 of which are after the decimal point.
Optional
participantsparticipantsDemand partners (demand_partner) and buyers (openx_buyer_ids) who can see the Private Marketplace Package Rates. Specific prices (rate_card_cpm) can be assigned to each demand partner or demand partner-buyer combination. Accepted values for this parameter are in the Participants parameters table below.Optional

Participants parameters

ParameterTypeDescriptionRequired?
demand_partnerstringSpecific demand partners eligible to buy inventory through the package. In the UI, this is the Demand Partner drop down. To list all valid demand partner values, call GET /options/targetable_demand_partner_options.Required
openx_buyer_idsstringSpecific buyers eligible to buy inventory through the package. In the UI, this is the Buyer Names field. To list all valid buyer values, call GET /options/options/buyer_options.Optional
rate_card_cpmintegerWhen set, displays as price for inventory sold to a specific demand partner or demand partner-buyer combination. In the UI, this is the Price field. The value is a decimal (9,4) type: a total of 9 digits are accepted, 4 of which are after the decimal point.Optional

Sample response

Expand sample response

In the example below, the fields account_id and deleted were updated by the sample request above.

[{
   "uid": "60146fc1-c0af-fff1-8123-0c9a66",
   "logo": null,
   "contact_name": null,
   "id": "1611952065",
   "deal_id": null,
   "modified_date": "2017-05-04 21:22:33",
   "targeting": {
      "content": {
         "excludes": {},
         "includes": {
            "site": "1610612824"
         }
      },
      "inter_dimension_operator": "AND"
   },
   "floorrule_id": null,
   "type": "package",
   "start_date": null,
   "revision": 2,
   "status": "Paused",
   "account_id": "537235117",
   "end_date": null,
   "deleted": "0",
   "v": "3",
   "contact_email": null,
   "deal_uid": null,
   "floorrule_uid": null,
   "private_market": null,
   "instance_uid": "a505e730-0b7a-11e3-8ffd-0800200c9a66",
   "name": "Copy 2017-05-04 21:22:23 of Test Package Kevin",
   "oxtl": "ox.inventory.site_id intersects \"1610612824\"",
   "notes": "",
   "rate_card_cpm": "0.0001",
   "urls": {},
   "created_date": "2017-05-04 21:22:23",
   "domains": "website.com",
   "external_id": null,
   "account_uid": "20058ead-accf-fff1-8123-0c9a66"
}, {
   "uid": "6000cb82-c0af-fff1-8123-0c9a66",
   "logo": null,
   "contact_name": null,
   "id": "1610664834",
   "deal_id": null,
   "modified_date": "2017-05-04 21:22:33",
   "targeting": {
      "content": {
         "excludes": {},
         "includes": {
            "account": "1610750622"
         }
      },
      "inter_dimension_operator": "AND"
   },
   "floorrule_id": null,
   "type": "package",
   "start_date": null,
   "revision": 7,
   "status": "Paused",
   "account_id": "537235117",
   "end_date": null,
   "deleted": "0",
   "v": "3",
   "contact_email": null,
   "deal_uid": null,
   "floorrule_uid": null,
   "private_market": null,
   "instance_uid": "a505e730-0b7a-11e3-8ffd-0800200c9a66",
   "name": "Kevin Wong Test Package",
   "oxtl": "ox.inventory.publisher_id intersects \"1610750622\"",
   "notes": "",
   "rate_card_cpm": "100.0000",
   "urls": {},
   "created_date": "2014-11-14 19:34:20",
   "domains": "abc.com",
   "external_id": null,
   "account_uid": "20058ead-accf-fff1-8123-0c9a66"
}]

Response data

ParameterDescription
account_idOpenX identifier for the account. For example, 537235117
account_uidOpenX identifier for the account. For example, 600aa500-accf-fff1-8123-b0769b
contact_emailEmail of the person to contact if questions exist about the package. In the UI, the Contact Email field.
contact_nameName of the person to contact if questions exist about the package. In the UI, the Contact Name field.
created_dateDate and time of creation. For example, 2019-10-15 20:58:39
deal_idOpenX identifier for a deal ID. For example, OX-qav-AfLYGL
deal_uidOpenX identifier for a deal ID. For example, 60146f8e-c0a9-fff1-8123-0c9a66
deletedFlag specifying whether the item has been deleted.
   • 0 = Not deleted.
   • 1 = Deleted.
domainsTop-level domains associated with the package. In the UI, the Domains field. For example, elle.com, cnn.com
end_dateEnd date for the package. In the UI, the Active Dates End Date field.
external_idFree-form reference identifier.
floorrule_idOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 1610612745
floorrule_uidOpenX identifier for a floor rule, the minimum price a publisher is willing to accept for a given impression. For example, 60000009-f100-fff1-8123-0c9a66
idOpenX identifier for the package. For example, 536900407
instance_uidPlatform_hash of session. For example, a505e730-0b7a-11e3-8ffd-0800200c9a66
logoURL of the logo to represent the package. In the UI, the Package Logo (URL) field. For example, http://www.site.com/package_logo.jpg
modified_dateTimestamp of when the last change was made. For example, 2019-10-15 21:09:36
oxtlOpenX Targeting Language use to summarize targeting rules. For example, ox.viewability.score >= \"0.60\"
nameName of the package. In the UI, the Package Name field.
notesText description of an item. In the UI, the Description field.
private_marketPricing settings for a PMP deal which including: rate card price, discounted/list price, discoverability of deal, demand partners, and buyer names.
In the UI, all the Private Marketplace Package Rates values in the Discover, Participants & Pricing Rates section. Accepted values for this parameter are in the Private Marketplace parameters table below.
rate_card_cpmList price for inventory sold directly by the publisher to an advertiser. In the UI, the Direct Package Rates Rate Card Price under the Discovery, Participants & Pricing Rates section.
revisionRevision number of the object. For example, 4
start_dateStart date for a package. In the UI, the Active Dates Start Date field.
statusStatus of package. Valid values: Active, Paused
targetingRules that define inventory to be bought and sold and how inventory is targeted for delivery to viewers. In the UI, the target values in the Targeting section.

Note: If no targeting is selected, the targeting of the package is set to MATCH ALL.
typeType of object query. To list all valid type values, call GET /options/model_types.
uidOpenX identifier associated with the package. For example, 600038a3-c0af-fff1-8123-0c9a66
urlsExample URLs included in package. In the UI, this is the Sample URLs field. For example, ["http://sub1.site.com", "http://sub2.site.com", "http://sub3.site.com"]
vVersion of the API. For example, 3.

Deleting a Package

Click to expand this section


DELETE /package/package_UID: Deletes a single package.

Sample request

curl -X DELETE http://PUBLISHER-ui.openx.net/ox/4.0/package/20007337-c0af-fff1-8123-467d57 --cookie "openx3_access_token=token_string"

URL parameter

ParameterTypeDescriptionRequired?
package_uidpackage_uidOpenX identifier for a package.
For example, 20007337-c0af-fff1-8123-467d57
Use GET /package to retrieve a list of all package_uid values.

Note: Use GET /package to retrieve a list of all package_uid values.
Required

Sample response

{"2000748a-c0af-fff1-8123-467d57": true}

Response data

ParameterDescription
(package_uid)The unique OpenX identifier for a package. The value is true if the deletion was successful. If the package was not deleted, the value is false.

Deleting Multiple Packages

Click to expand this section


DELETE /package: Deletes multiple packages.

To delete multiple packages, the package_uid for each package must be passed as an array in the DELETE request. Use GET /package to retrieve a list of all package_uid values.

Sample request

curl -X DELETE http://PUBLISHER-ui.openx.net/ox/4.0/package --cookie "openx3_access_token=token_string"
--header "Content-Type:application/json" --data-binary '["6008c33a-c0af-fff1-8123-0c9a66", "6008c339-c0af-fff1-8123-0c9a66"]'

Sample response

{"6008c33a-c0af-fff1-8123-0c9a66": true, "6008c339-c0af-fff1-8123-0c9a66": true}

Response data

ParameterDescription
(package_uid)The value for the package_uid is true if the deletion was successful. If a package was not deleted, the value is false for that package_uid.