adunit object
The specific areas on your site 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 unit. |
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_fields?type_full=adunit.type | List the available_fields to create or update an ad unit object of the specified type (such as adunit.web). See adunit object example. |
GET /adunit/list_ad_tags | List ad tags and basic information for the specified adunit UIDs.• 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. |
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.• 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. |
Example
Expand example
{
"account_id": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int"
},
"account_uid": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "account_uid"
},
"alt_sizes": {
"has_dependencies": false,
"maxlen": 255,
"readonly": false,
"required": false,
"type": "varchar",
"url": "/options/web_size_options"
},
"autorefresh_settings": {
"acl": "adunit.auto_refresh",
"has_dependencies": false,
"items": {
"available_fields": {
"country": {
"has_dependencies": false,
"maxlen": 255,
"readonly": false,
"required": false,
"type": "varchar",
"url": "/options/country_options"
},
"delay": {
"has_dependencies": false,
"readonly": false,
"required": true,
"type": "int"
},
"max": {
"has_dependencies": false,
"readonly": false,
"required": true,
"type": "int"
}
},
"has_dependencies": false,
"readonly": false,
"required": false,
"type": "object"
},
"readonly": false,
"required": false,
"type": "array"
},
"content_topics": {
"acl": "adunit.content_settings",
"has_dependencies": false,
"items": {
"has_dependencies": false,
"readonly": false,
"required": false,
"type": "int",
"url": "/options/content_topic_options"
},
"readonly": false,
"required": false,
"type": "array"
},
"content_type": {
"acl": "adunit.content_settings",
"has_dependencies": false,
"maxlen": 255,
"readonly": false,
"required": false,
"type": "varchar",
"url": "/options/content_type_options"
},
"content_type_id": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int"
},
"created_date": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "datetime"
},
"deleted": {
"auto": true,
"default": "0",
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int"
},
"delivery_medium_id": {
"auto": true,
"default": "2",
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int",
"value": "2"
},
"external_id": {
"acl": "adunit.ext_id",
"has_dependencies": false,
"maxlen": 255,
"readonly": false,
"required": false,
"type": "varchar"
},
"fallback_ad_tag": {
"acl": [ "adunit.ad_tag", "instance.market_active" ],
"has_dependencies": false,
"maxlen": 131072,
"readonly": false,
"required": false,
"type": "varchar"
},
"id": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int"
},
"instance_uid": {
"auto": true,
"has_dependencies": false,
"maxlen": 255,
"readonly": true,
"required": false,
"type": "varchar"
},
"location": {
"acl": "adunit.screen_location",
"has_dependencies": false,
"maxlen": 255,
"readonly": false,
"required": false,
"type": "varchar",
"url": "/options/web_location_options"
},
"location_id": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int"
},
"modified_date": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "datetime"
},
"name": {
"has_dependencies": false,
"maxlen": 255,
"readonly": false,
"required": true,
"type": "varchar"
},
"primary_size": {
"has_dependencies": false,
"maxlen": 30,
"readonly": false,
"required": false,
"type": "varchar",
"url": "/options/web_size_options"
},
"real_time_bid_floor": {
"acl": [ "instance.market_active", "instance.features.selling_rules_ui" ],
"has_dependencies": false,
"maximum": "1000000.00",
"readonly": false,
"required": false,
"type": "decimal(8,2)"
},
"revshare": {
"acl": [ "instance.rev_share", "adunit.revshare" ],
"available_fields": {
"cost_model": {
"default": "variable",
"has_dependencies": false,
"maxlen": 255,
"options": [ "variable", "fixed" ],
"readonly": false,
"required": true,
"type": "varchar"
},
"deal_type": {
"default": "FIXED_WITH_FILL",
"has_dependencies": false,
"maxlen": 255,
"readonly": false,
"required": true,
"type": "varchar",
"url": "/options/deal_type_options"
},
"deal_type_id": {
"auto": true,
"default": "1",
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int"
},
"guaranteed_cpm": {
"default": "0.0000",
"has_dependencies": false,
"maximum": "10000.0000",
"readonly": false,
"required": true,
"type": "decimal(9,4)"
},
"house_fallback": {
"default": "0",
"has_dependencies": false,
"readonly": false,
"required": true,
"type": "int"
},
"house_payable": {
"default": "0",
"has_dependencies": false,
"readonly": false,
"required": true,
"type": "int"
},
"rev_split": {
"default": "100.00",
"has_dependencies": false,
"maximum": "100.00",
"readonly": false,
"required": true,
"type": "decimal(5,2)"
}
},
"has_dependencies": false,
"readonly": false,
"required": false,
"type": "object"
},
"site_id": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int"
},
"site_uid": {
"has_dependencies": false,
"readonly": false,
"required": true,
"type": "uid"
},
"sitesection_id": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int"
},
"sitesection_uid": {
"acl": "adunit.section",
"has_dependencies": false,
"readonly": false,
"required": false,
"type": "uid"
},
"status": {
"has_dependencies": false,
"maxlen": 12,
"readonly": false,
"required": true,
"type": "varchar",
"url": "/options/status_options_common"
},
"tag_type": {
"default": "js.async",
"has_dependencies": false,
"maxlen": 255,
"readonly": false,
"required": true,
"type": "varchar",
"url": "/options/web_adunit_tag_type_options"
},
"tag_type_id": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "int"
},
"type": {
"auto": true,
"has_dependencies": false,
"maxlen": 255,
"readonly": true,
"required": false,
"type": "varchar",
"url": "/options/model_types"
},
"type_full": {
"has_dependencies": false,
"maxlen": 64,
"readonly": false,
"required": true,
"type": "varchar",
"value": "adunit.web"
},
"uid": {
"auto": true,
"has_dependencies": false,
"readonly": true,
"required": false,
"type": "uid"
},
"v": {
"auto": true,
"default": "3",
"has_dependencies": false,
"options": [],
"readonly": true,
"required": false,
"type": "int"
},
"vast_tag": {
"acl": "adunit.vast_tag",
"has_dependencies": false,
"maxlen": 2000,
"readonly": false,
"required": false,
"type": "varchar"
}
}