You are here: Developers > OpenX Platform API > Platform API reference > adunit object

adunit object

Specific areas on your siteAn OpenX component that represents top-level domains or sub-domains and is used to organize ad units. Sites enable you to target and report on inventory performance. where you want to display ads

The adunit object has the following calls:

Call Description
DELETE /adunit Delete the specified ad units.
DELETE /adunit/ad_unit_UID Delete the specified ad unitThe smallest inventory component that represents the space on a site where ads display..
GET /adunit List all ad units.
GET /adunit/ad_unit_UID Read the specified ad unit.
GET /adunit/ad_unit_UID/generate_tag Generate the HTML tag for the specified ad unit.
GET /adunit/ad_unit_UID/list_adunitgroups List ad unit groups for the specified ad unit UID.
GET /adunit/available_fieldstype_full=adunit.type List the available fields to create or update an ad unit object of the specified type (such as adunit.web). Open adunit object example 1
GET /adunit/list_ad_tags List ad tags and basic information for the specified adunit UIDs.
ParameterDescription
adunit_uids (Required)A comma-separated string of ad unit UIDs, such as adunit_uids=278-e0ad-ff1-8123-0c9a,288-e0ad-ff1-8123-0c9a
format (Optional)Use format=txt to download ad tags in a text file.
GET /adunit/performance/ad_unit_UID Get the performance metrics for the specified ad unit within the (optional) date range.

Parameters

  • start_date

    • A specific date in yyyy-mm-dd HH:MM:SS format

      OR

    • An integer for the days backward from today. For example, 7 means "seven days ago" and 0 means "starting today" (inclusive).

  • end_date

    • A specific date in yyyy-mm-dd HH:MM:SS format

      OR

    • A negative integer for the days from now. For example, -7 means "until seven days from now" and 0 means "before today" (exclusive).

POST /adunit Create one or more ad units.
POST /adunit/ad_unit_UID/clone Clone the specified ad unit.
POST /adunit/list_ad_tags List ad tags and basic information for the specified adunit UIDs.
ParameterDescription
adunit_uids (Required)A comma-separated string of ad unit UIDs, such as adunit_uids=278-e0ad-ff1-8123-0c9a,288-e0ad-ff1-8123-0c9a
format (Optional)Use format=txt to download ad tags in a text file.
PUT /adunit Update the specified ad units.
PUT /adunit/ad_unit_UID Update the specified ad unit.

See also

Creating an ad unit.

Feedback form