Campaign-form fields for ron / cpm / rtb campaigns, writable on POST /api/v1/campaigns/{type} and PATCH /api/v1/campaigns/{type}/{id} and returned by list / show (option fields when stored). Which of them a campaign takes depends on its type, the network's modules, its ad type and its pay type — GET /api/v1/campaigns/{type}/_schema lists exactly the ones available to you (?ad_type= narrows it), with ad_types / selling_types restrictions. Sending one that is not available is a 422 naming the field (for example \"orientation applies only to ad type(s) 3, 22.\"), not a silent drop. Object fields merge on PATCH: keys you omit keep their stored value. Money is in main currency units (not cents).
| Name | Type | Description | Notes |
|---|---|---|---|
| groupid | str | Campaign tags / groups: comma-separated group ids ("0" = none). A JSON array is accepted. | [optional] |
| display_options | str | Display options for the ad type (e.g. video roll position), comma-separated ids. | [optional] |
| min_rank | int | Minimum ad zone quality rank (flat campaigns on networks that rank ad zones). Not the same as `priority`. | [optional] |
| fx_rating | int | Fixed rating flag (advanced). | [optional] |
| mail_campaign_budget | bool | ron/cpm: email the account when `total_budget` is reached. Where the network offers lifetime budgets. | [optional] |
| use_dynamic_costs | bool | ron CPC/CPM (`selling_type` 0/1): let the bid rise automatically by up to `dynamic_costs_increase` percent. | [optional] |
| dynamic_costs_increase | int | Maximum dynamic-cost increase in percent. | [optional] |
| conversion_capping | CampaignPanelFieldsConversionCapping | [optional] | |
| fix_cpa | float | ron/cpm CPA goal in main currency. After create only your account manager changes it, except on AdManager networks (a PATCH with a different value is a 422; the same value is a no-op). | [optional] |
| fix_cpa_conv_types | str | Conversion type ids the CPA goal counts (empty = all). A JSON array is accepted. | [optional] |
| booster | bool | ron CPA (`selling_type` 2): AdBooster, where the network licenses it. | [optional] |
| booster_settings | CampaignPanelFieldsBoosterSettings | [optional] | |
| default_bid_type | int | ron: smart bidding on (1) / off (0), for CPC or CPM where the network lets users switch it on. | [optional] |
| sort_type | int | ron: ad sorting — 0 = eCPM, 1 = random, 2 = weighted. Any pay type (CPC/CPM: random or weighted skips smart-bid repricing). Not for offers. | [optional] |
| as_failover | bool | ron (AdManager networks, not flat): serve only as failover. | [optional] |
| day_parting | CampaignPanelFieldsDayParting | [optional] | |
| screens | CampaignPanelFieldsScreens | [optional] | |
| display_times | str | Legacy daily time windows (pipe-separated; overlaps merged). Superseded by `day_parting`. | [optional] |
| display_days | str | Legacy weekday list ("0" = every day). Superseded by `day_parting`. | [optional] |
| site_languages | str | Website language codes ("0" = all). A JSON array is accepted. | [optional] |
| connection_types | str | Connection type ids ("0" = all). A JSON array is accepted. | [optional] |
| carrier_ids | str | ron: mobile carrier ids ("0" = all); meaningful with `connection_types` = "2" and no IP pool. | [optional] |
| rating_id | int | Content rating id, where the network uses ratings. | [optional] |
| orientation | str | ron/cpm ad types 3 and 22. | [optional] |
| site_mode | int | ron: 0 = RON (all sites), 1 = Premium sites (display only; may need a minimum balance). Read back with the admin-set `sites_locked`. | [optional] |
| only_tagged_zones | bool | ron/cpm on AdManager networks: only run on ad zones sharing one of the campaign's groups. | [optional] |
| skip_low_quality | int | ron/cpm (not flat): low-quality traffic 0 = accept, 1 = block, 2 = target only. | [optional] |
| ip_whitelist | str | IP allow list, one entry per line (IPv4/IPv6, CIDR or `a | b` ranges); each line is validated. A JSON array is accepted. |
| ip_blacklist | str | IP deny list, same syntax. An IP on both lists is blocked. | [optional] |
| av_check | CampaignPanelFieldsAvCheck | [optional] | |
| email_type | int | ron/rtb email ads (ad type 15): 0 = accept all, 1 = email only, 2 = non-email only. | [optional] |
| use_subscription_age | bool | ron push ads (ad type 7). | [optional] |
| subscription_age | int | [optional] | |
| instant_impression | bool | ron video (ad type 4) on AdManager networks. | [optional] |
| subid_list | str | ron/cpm (not flat): SubIDs to filter on, one per line or comma-separated (empty clears). Stored as the campaign's SubID filter. | [optional] |
| subid_list_mode | str | [optional] | |
| source_optimizer_ids | str | ron: your own active source optimizers, at most one per filter type; ids that are not yours are dropped. "0" detaches all. | [optional] |
| wl_zone_ids | str | cpm: ad zone ids the campaign is pinned to (empty = all). | [optional] |
| feed_id | int | ron ad types 3 / 22: one of your XML feeds (0 = none). | [optional] |
| feed_settings | CampaignPanelFieldsFeedSettings | [optional] | |
| priority | CampaignPanelFieldsPriority | [optional] | |
| suggestions | CampaignPanelFieldsSuggestions | [optional] | |
| hide_referrer | bool | ron/rtb on AdManager networks (options): JS redirect so the landing page sees the ad server as referrer. | [optional] |
| log_conv_as_paid | bool | ron on AdManager networks where you own an SSP campaign (options): book spend as Traffic Cost and conversions as Paid. Defaults to true on new campaigns there. | [optional] |
| about_settings | CampaignPanelFieldsAboutSettings | [optional] | |
| use_live_feed | bool | ron video (ad type 4): live HLS feed, where the network offers it (not on AdNetwork networks). | [optional] |
| live_feed_parent_id | int | One of your master-feed video campaigns (0 = this campaign is a master feed). | [optional] |
| live_feed_settings | Dict[str, object] | {hls_provider, campaign, gender, resize_to, bid, desturl_macro, desturl_type, use_logo}. hls_provider: chaturbate, bongacams or camsoda; campaign: the provider's affiliate/campaign id (CamSoda: your affiliate id); gender: f, m, t or c; desturl_type (chat_room_url or chat_room_url_revshare) is Chaturbate only; desturl_macro fills the link's tracking slot (CamSoda: appended to the link as query text, e.g. sub_id={clickid}). | [optional] |
| offer_type_id | int | ron offers (ad type 21). | [optional] |
| description | str | ron offers (ad type 21): the offer description (stored on the offer's ad). | [optional] |
| destination_url | str | ron offers (ad type 21): http(s) destination URL (include `{tracking}` for CPA offers). | [optional] |
| preview_url | str | ron offers (ad type 21): http(s) preview URL. | [optional] |
| rtb_network_id | int | rtb: an active RTB network of this tenant. Ignored when your account is locked to one network. | [optional] |
| rtb_type | str | rtb protocol; json / xml only for ad types 7, 11, 15. | [optional] |
| use_type | int | rtb: 0 = one `request_url`; 1 = a URL per zone in `zone_urls` (then `request_url` is optional). | [optional] |
| zone_urls | List[object] | rtb URLs per zone (use_type 1). | [optional] |
| bid_action | int | rtb OpenRTB auction: 1 = first price, 2 = second price. | [optional] |
| use_qps | bool | [optional] | |
| qps | int | [optional] | |
| rtb_categories | str | rtb OpenRTB content categories. A JSON array is accepted. | [optional] |
| use_api | bool | rtb: pull the partner's stats through its reporting API. | [optional] |
| api_data | Dict[str, object] | rtb per-network stats-API credentials. | [optional] |
| log_skipped | bool | rtb: log no-bid responses in the stats. | [optional] |
| domain_mask | CampaignPanelFieldsDomainMask | [optional] | |
| rtb_xml_markup | bool | rtb banner (ad type 2), stored as options.rtb.xml_markup: ask the bidder for XML ad markup. | [optional] |
from goadserver.models.campaign_panel_fields import CampaignPanelFields
# TODO update the JSON string below
json = "{}"
# create an instance of CampaignPanelFields from a JSON string
campaign_panel_fields_instance = CampaignPanelFields.from_json(json)
# print the JSON string representation of the object
print(CampaignPanelFields.to_json())
# convert the object into a dict
campaign_panel_fields_dict = campaign_panel_fields_instance.to_dict()
# create an instance of CampaignPanelFields from a dict
campaign_panel_fields_from_dict = CampaignPanelFields.from_dict(campaign_panel_fields_dict)