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

adunitgroup object

Collections of ad units used for inventoryAd space available on a website or app. The basic unit of inventory for OpenX is an ad unit. to be filled with companion ads or to map items in a CMS to inventory items

The adunitgroup object has the following calls:

Call Description
DELETE /adunitgroup Delete the specified ad unitThe smallest inventory component that represents the space on a site where ads display. groups.
DELETE /adunitgroup/ad_unit_group_UID Delete the specified ad unit groupA collection of ad units where related ads display together at the same time..
GET /adunitgroup List all ad unit groups.
GET /adunitgroup/ad_unit_group_UID Read the specified ad unit group.
GET /adunitgroup/ad_unit_group_UID/generate_tag Generate the HTML tag for the specified ad unit group.
GET /adunitgroup/ad_unit_group_UID/list_ad_units List ad units for the specified account UID.
GET /adunitgroup/available_fields List the available fields to create or update an ad unit group.
GET /adunitgroup/performance/ad_unit_group_UID Get the performance metrics for the specified ad unit group 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 /adunitgroup Create one or more ad unit groups.
POST /adunitgroup/ad_unit_group_UID/clone Clone the specified ad unit group.
PUT /adunitgroup Update the specified ad unit groups.
PUT /adunitgroup/ad_unit_group_UID Update the specified ad unit group.

See also

Ad unit groups in the OpenX UI help.

Feedback form