AdGroup

A resource for creating/modifying an ad group.
The available fields, targeting options, and other ad group settings are described in the package object within which the campaign is created.

Used in resources: AdGroups

Field name	Type	Conditions	Description
id	uint32	readable default_field	Group identifier
created	datetime	readable	Creation time
updated	datetime	readable	Last update time
name	string	readable required writable default_field	Group name
status	string	readable writable choices = active - Active deleted - Deleted blocked - Blocked	Group status. The deleted status may also be returned for deleted groups. In a group with status deleted, only the status itself can be changed.
ad_plan_id	uint32	readable writable default_field min_value=1 max_value=2147483647	Identifier of the campaign
package_id	integer	readable required writable default_field min_value=-2147483647 max_value=2147483647	Identifier of the package
age_restrictions	string	readable writable	Age restrictions. Validated by the pattern ^[1-9]?[0-9]\\+$
audit_pixels	list of AuditPixel	readable writable	List of audit pixels
autobidding_mode	string	readable writable choices = max_goals - Goal maximization (features: no bid; a total budget and campaign period or a daily budget must be set)	Auction strategy
banner_uniq_shows_limit	integer	readable writable max_value=2147483647	Number of unique impressions for banners
banners	list of Banner	writable create_only	Banners
budget_limit	decimal	readable writable	Total group budget
budget_limit_day	decimal	readable writable	Daily group budget
date_end	date	readable writable	Group end date
date_start	date	readable writable	Group start date
delivery	string	readable choices = pending delivering not_delivering	Group delivery status
dynamic_banners_use_storelink	boolean	readable writable	Whether to show a deeplink in mobile dynamic remarketing
dynamic_without_remarketing	boolean	readable writable	Ability to show dynamic remarketing banners without dynamic remarketing events
enable_offline_goals	boolean	readable writable	Count offline conversions for the group
enable_utm	boolean	readable writable	Whether to add UTM tags to ad URLs
issues	list of object	readable	Description of reasons why the group’s ads are not being shown (template variables are shown in curly braces): ACCOUNT_INACTIVE - Account is inactive. AD_PLAN_ARCHIVED - The ad plan is removed. AD_PLAN_OUT_OF_DATE_END - Current date does not satisfy ad_plan settings: end date is {date_end}. AD_PLAN_OUT_OF_DATE_START - Current date does not satisfy ad_plan settings: start date is {date_start}. AD_PLAN_STOPPED - The ad plan is stopped. ARCHIVED - The campaign is removed. BALANCE_OUT_OF_DAILY_LIMIT - The account has reached the daily limit of {limit_value} BALANCE_OUT_OF_FULL_LIMIT - The account has reached the balance limit {limit_value} BALANCE_OUT_OF_MONTHLY_A_LIMIT - The account has reached the monthly limit of {limit_value} BALANCE_OUT_OF_MONTHLY_LIMIT - The account has reached the monthly limit of {limit_value} BANNER_FORMAT_DELETED - Ad format is obsolete and not supported anymore. You can not change campaign settings or add new ads into it. CHECK_STOPPED - Please check your campaign settings and resume. COUNTER_DELETED - Counter {counter} was deleted and campaign was stopped. DOOH_NO_MONEY - Not enough balance for amount {amount} DOOH_PAD_DELETED - Not enough surfaces GOAL_DELETED - Goal with string {goal} of {counter} was deleted and campaign was stopped. LAL_ARCHIVED - Look-alike {lookalike_id} was archived and campaign was stopped. LAL_FAILED - Look-alike {lookalike_id} was failed and campaign was stopped. NO_ALLOWED_BANNERS - The campaign has no banners, approved by moderation. NO_BANNERS_WITH_ACTIVE_STATUS - The campaign has no active banners. NO_MONEY - The account has no enough money. OFFER_GROUP_NOT_LOADED - Pricelist offer group is not loaded. OUT_OF_DATE_END - Current date does not satisfy campaign settings: end date is {date_end}. OUT_OF_DATE_START - Current date does not satisfy campaign settings: start date is {date_start}. OUT_OF_DAY_LIMIT - The campaign has reached the daily budget limit {day_limit} {currency}. OUT_OF_FULL_LIMIT - The campaign has reached the full budget limit {full_limit} {currency}. OUT_OF_TIME_TARGETING - The campaign is out of time targeting. Delivery will start at {time_start}. PACKAGE_DELETED - Ad format is obsolete and not supported anymore. You can not change campaign settings or add new ads into it. PACKAGE_UNAVAILABLE - Ad format is not available for this account PARENT_ACCOUNT_INACTIVE - Parent account is inactive. PRICELIST_DELETED - Pricelist {pricelist} was deleted and campaign was stopped. PRICELIST_OFFER_GROUP_DELETED - Offer group {offer_group} for pricelist {pricelist} was deleted and campaign was stopped. REMARKETING_AUDIENCE_CHANGED - Audience {audience} was changed and campaign was stopped. SEGMENT_CHANGED - Segment {segment} was changed and campaign was stopped. SEGMENT_DELETED - Segment {segment} was deleted and campaign was stopped. SK_AD_CAMPAIGN_ID_WITHDRAWN - iOS ads id for campaign was withdrawn STOPPED - The campaign is stopped.
language	string	readable writable choices = ru en	Language of creatives in the group
marketplace_app_client_id	string	readable writable	ID of the application that will manage the group
max_price	decimal	readable writable max_value=21474836	Upper bound for automatic price adjustment
objective	string	readable writable	Ad group objective; must match one of the objectives defined in package.objective
package_priced_event_type	integer	readable	Identifier of the event the group delivery is optimized for. See Package
price	decimal	readable writable	Price per event. The event type is determined by the group’s package.
priced_goal	PricedGoal	readable writable	Payment by TOP goals / in-app events
pricelist_id	integer	readable writable min_value=-2147483647 max_value=2147483647	Identifier of the remarketing price list
sk_ad_campaign_id	integer or null	readable min_value=1 max_value=100	Identifier of the SkAd Network group. Assigned when using iOS 14.5+ targeting. See MobileApps, SkAdNetworkIdentityShare, and SkAdNetworkIdentityWithdraw.
targetings	Targetings	readable writable	Targeting structure
uniq_shows_limit	integer	readable writable max_value=2147483647	Number of unique impressions
uniq_shows_period	string	readable writable choices = day - Day week - Week month - Month eternity - Always	Impression periods
utm	text	readable writable	UTM tags to be added to ad URLs. If not specified and enable_utm=true, the tags will be generated automatically. If enable_utm=false, tags will not be added to ad URLs even if specified.
not_ad	boolean	readable writable	Whether the group’s banners are non-advertising content