| name |
string |
|
|
| siteid |
int |
Parent website id from /api/v1/sites. |
|
| description |
string |
|
[optional] |
| ratingid |
int |
|
[optional] [default to 0] |
| main_catid |
int |
|
[optional] [default to 0] |
| catid |
int |
|
[optional] [default to 0] |
| locationid |
int |
|
[optional] [default to 0] |
| adsizeid |
int |
Banner size id (banner-flavored types only). Also accepted as banner_settings.sizeid. |
[optional] [default to 0] |
| autoapprove |
bool |
|
[optional] [default to false] |
| isvisible |
bool |
|
[optional] [default to true] |
| sendmails |
bool |
|
[optional] [default to false] |
| useownbanners |
bool |
|
[optional] [default to false] |
| usealtbanner |
bool |
|
[optional] [default to false] |
| usecpmbuys |
bool |
|
[optional] [default to true] |
| allow_iframes |
bool |
|
[optional] [default to true] |
| allow_animation |
bool |
|
[optional] [default to true] |
| skip_ron_if_cpm |
bool |
|
[optional] [default to false] |
| no_promotion |
bool |
|
[optional] [default to false] |
| run_rtb_after_smartzone |
bool |
|
[optional] [default to false] |
| use_pixel_log |
bool |
|
[optional] [default to false] |
| show_about |
bool |
|
[optional] [default to false] |
| hidecopy |
bool |
Hide the "Ads by" copy. Stored as json_settings.hideadsby; `hideadsby` is accepted as an alias and wins when both are sent. |
[optional] [default to false] |
| hideadsby |
bool |
Alias of hidecopy (the stored name). |
[optional] |
| useflatbuys |
bool |
Accept flat bookings on this zone. |
[optional] [default to true] |
| parentid |
int |
Parent ad zone (another live zone of yours) — in-video sub-zones hang under their player zone. 0 = top level. |
[optional] [default to 0] |
| display_type |
int |
Banner zones: 0 = inline, 1 = floater (send floater_settings). Forced to 1 for types 17, 19, 20, 22. |
[optional] [default to self::DISPLAY_TYPE_NUMBER_0] |
| new_zoneid |
int |
Banner zones: forward unfilled traffic to this ad zone id. 0 = off. |
[optional] [default to 0] |
| only_wl_campaigns |
bool |
Serve only the whitelisted campaigns. Ad Manager tenants only — dropped elsewhere. |
[optional] [default to false] |
| only_tagged_campaigns |
bool |
Serve only campaigns in the zone's campaign groups (`tags`). Only where campaign-group targeting is enabled — dropped elsewhere. |
[optional] [default to false] |
| force_wl_targeting |
bool |
Apply the whitelisted campaigns' own targeting. Also written by PUT /wl-campaigns. |
[optional] [default to false] |
| skip_rtb_when_wl |
bool |
Skip RTB when a whitelisted campaign can fill. Stored in json_settings.options. |
[optional] [default to false] |
| use_fixed_payouts |
bool |
Fixed payout instead of revenue share (alias `fixed_payouts`). Only where modules.publisher.adzones.options.use_fixed_payouts is on and the tenant is Ad Manager; dropped silently otherwise. |
[optional] [default to false] |
| fixed_payouts |
bool |
Alias of use_fixed_payouts (the name the panel sends). |
[optional] |
| fixed_payout_data |
array<string,mixed> |
{type: cpc |
cpm, amount (currency units), enddate, amounts: per-country overrides}. Only with use_fixed_payouts. |
| rtb_name |
string |
Name the zone is reported under to RTB partners. |
[optional] |
| tags |
int[] |
Campaign-group ids (campaign_groups). Empty = inherit the site's groups. |
[optional] |
| excl_catids |
string |
Comma-separated category ids to exclude. |
[optional] |
| exclproperties |
string |
|
[optional] |
| use_subid_list |
bool |
|
[optional] [default to false] |
| subid_list |
string |
Comma-separated subid allowlist (use_subid_list=true required). |
[optional] |
| use_domain_list |
bool |
|
[optional] [default to false] |
| domain_list |
string[] |
|
[optional] |
| use_costs |
bool |
|
[optional] [default to false] |
| costs_data |
array<string,mixed> |
|
[optional] |
| use_dynamic_costs |
bool |
|
[optional] [default to false] |
| use_fallback_campaign |
bool |
|
[optional] [default to false] |
| fallback_campaignid |
int |
|
[optional] [default to 0] |
| quality_rank |
int |
|
[optional] [default to 0] |
| banner_settings |
\GoAdServerApi\Model\AdspaceCreateBannerSettings |
|
[optional] |
| native_settings |
array<string,mixed> |
Native-flavored zones (nativeads, interstitial_native, creator_widget, search_ads, bot_ads — search_ads and bot_ads read only `orientation`). nativeads also takes the infinite content feed: `infinite` (boolean; switches GET /api/v1/adspaces/{id}/code to goCtrl's feed plugin), `feed_rss` (your RSS feed: http(s) URL or a path such as /feed/; anything else 422 `native_settings.feed_rss`), `feed_ad_every` (organic cards before each ad, 0-10, default 2), `feed_max_pages` (1-30, default 10), `feed_title`, `feed_label` (plain text). Ad impressions in the feed are counted when the card is at least half on screen. Full field list: GET /api/v1/adspaces/nativeads/_schema. |
[optional] |
| search_settings |
\GoAdServerApi\Model\AdspaceCreateSearchSettings |
|
[optional] |
| email_settings |
\GoAdServerApi\Model\AdspaceCreateEmailSettings |
|
[optional] |
| bot_settings |
\GoAdServerApi\Model\AdspaceCreateBotSettings |
|
[optional] |
| screen_settings |
\GoAdServerApi\Model\AdspaceCreateScreenSettings |
|
[optional] |
| player_settings |
array<string,mixed> |
Video zones (videoads, interstitial_video, videoslider). videoads also takes rewarded web ads: `rewarded` (boolean; GET /api/v1/adspaces/{id}/code then returns goCtrl's rewarded plugin plus an example button), `reward_min_seconds` (5-120, default 10), `reward_callback` (your server's http(s) URL, GET with {uid} {sid} {campaignid} {ts} {token}; anything else 422 `player_settings.reward_callback`), `reward_secret` (64 hex, generated when rewarded is switched on; the reward token is `<base64url(payload)>.<hex HMAC-SHA256(reward_secret, payload)>`, payload `<sid>.<campaignid>.<uid>.<unix time>`). CTV / streaming (videoads and audioads): `pod_size` (1-6, ads per VAST answer as an ad pod, never the same campaign or advertiser twice; a player can also send &pod=N), `pod_max_seconds` (0-600, 0 = no limit), `midroll_offsets` (up to 20 seconds into the stream, array or "600, 1200"; out of range 422), `vmap_no_preroll`, `vmap_postroll`, `pause_zone_id` (0 or one of your own banner zones, else 422 `player_settings.pause_zone_id`), `ssai` (allow server-side ad insertion). The player URLs are in the code answer's `ctv` block. Full field list: GET /api/v1/adspaces/videoads/_schema. |
[optional] |
| pop_settings |
array<string,mixed> |
Pop zones (popads). `fpa_zoneid` is the full-page-ad zone served instead of the pop to visitors whose browser is in `bl_browsers`: 0 = none, otherwise one of YOUR OWN full-page zones (`fullpageads`, type 12) — another publisher's zone, a deleted zone or another type is refused with 422 (`pop_settings.fpa_zoneid`). Full field list: GET /api/v1/adspaces/popads/_schema. |
[optional] |
| fpa_settings |
array<string,mixed> |
Full-page ad zones (fullpageads). Shown when the visitor clicks a link, before the link opens. `link_scope`: empty = any link, `internal` = vignette (only links to the same site; anything else is refused with 422 `fpa_settings.link_scope`). `start_at` / `repeat_at` count link clicks, `refreshtime` caps it to once per N seconds. Full field list: GET /api/v1/adspaces/fullpageads/_schema. |
[optional] |
| redirect_settings |
array<string,mixed> |
Direct-URL zones: redirects (10), legacy types 14/15 and hard links 1-5 (35-39). |
[optional] |
| im_settings |
array<string,mixed> |
In-message popup zones (impopup). |
[optional] |
| fixim_banner_settings |
array<string,mixed> |
Fixed-position banner zones (fixim_banner). |
[optional] |
| native_bar_settings |
array<string,mixed> |
Native bar zones (native_bar). position: top_left |
top_right |
| native_webpush_settings |
array<string,mixed> |
Native webpush zones (native_webpush). position: top_left |
top_right |
| text_settings |
array<string,mixed> |
Text-list zones (textads). |
[optional] |
| floater_settings |
array<string,mixed> |
Floater wrapper for interstitial-flavored zones (interstitialads, interstitial_banner, interstitial_native, interstitial_video). `trigger`: empty = as usual, `exit` = exit intent (desktop: the mouse leaves the page towards the tab bar; touch: a fast scroll back up after reading at least a screen; never in the first 5 seconds) — banner and native interstitials (17, 20, 21); anything else is refused with 422 `floater_settings.trigger`. Floating banners (bannerads with display_type 1, interstitialads) also take `anchor` (full-width bottom/top strip with a collapse tab), `refresh_seconds` (0, or 30-600 seconds on screen), `min_width` / `max_width` (screen-width range in px, 0 = no limit; e.g. side rails = left-middle / right-middle with min_width 1200) — out-of-range values are refused with 422. Full field list: GET /api/v1/adspaces/interstitial_banner/_schema. |
[optional] |
| videoslider_settings |
array<string,mixed> |
Video-slider zones (videoslider). |
[optional] |
| invideo_settings |
array<string,mixed> |
In-video plugin zones (invideo_plugin, type 16): roll slots, the zone each serves, pop-on-close/play. See `_schema`. |
[optional] |
| dyn_adsettings |
array<string,mixed> |
Dynamic iframe zones (dyn_iframes). |
[optional] |
| inpage_videosettings |
array<string,mixed> |
In-page video zones (inpage_video). |
[optional] |
| carousel_videosettings |
array<string,mixed> |
Video carousel zones (video_carousel). |
[optional] |