Group data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | |
created_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The ad group's name |
parent_id | string | No | |
campaign_id | string | No | The ID of the campaign the ad group belongs to (an AdsCampaign ID) |
organization_id | string | No | |
insertionorder_id | string | No | |
status | enum | No | Values: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED |
effective_status | enum | No | Values: UNSPECIFIED, SERVING, LIMITED, LEARNING, PAUSED, PENDING, ENDED, MISCONFIGURED, NOT_ELIGIBLE, ARCHIVED, REMOVED |
targeting | object | No | |
targeting.geographic | AdsGroup_targeting_geographic | No | |
targeting.geographic.countries | TargetRef[] | No | |
targeting.geographic.countries[].id | string | No | |
targeting.geographic.countries[].name | string | No | |
targeting.geographic.regions | TargetRef[] | No | |
targeting.geographic.regions[].id | string | No | |
targeting.geographic.regions[].name | string | No | |
targeting.geographic.cities | CityTarget[] | No | |
targeting.geographic.cities[].id | string | Yes | |
targeting.geographic.cities[].name | string | No | |
targeting.geographic.cities[].radius | number | No | |
targeting.geographic.cities[].radius_unit | enum | No | Values: MILES, KILOMETERS |
targeting.geographic.postal_codes | TargetRef[] | No | |
targeting.geographic.postal_codes[].id | string | No | |
targeting.geographic.postal_codes[].name | string | No | |
targeting.geographic.us_dmas | TargetRef[] | No | |
targeting.geographic.us_dmas[].id | string | No | |
targeting.geographic.us_dmas[].name | string | No | |
targeting.geographic.excluded_countries | TargetRef[] | No | |
targeting.geographic.excluded_countries[].id | string | No | |
targeting.geographic.excluded_countries[].name | string | No | |
targeting.geographic.excluded_regions | TargetRef[] | No | |
targeting.geographic.excluded_regions[].id | string | No | |
targeting.geographic.excluded_regions[].name | string | No | |
targeting.geographic.excluded_cities | CityTarget[] | No | |
targeting.geographic.excluded_cities[].id | string | Yes | |
targeting.geographic.excluded_cities[].name | string | No | |
targeting.geographic.excluded_cities[].radius | number | No | |
targeting.geographic.excluded_cities[].radius_unit | enum | No | Values: MILES, KILOMETERS |
targeting.geographic.excluded_postal_codes | TargetRef[] | No | |
targeting.geographic.excluded_postal_codes[].id | string | No | |
targeting.geographic.excluded_postal_codes[].name | string | No | |
targeting.geographic.excluded_us_dmas | TargetRef[] | No | |
targeting.geographic.excluded_us_dmas[].id | string | No | |
targeting.geographic.excluded_us_dmas[].name | string | No | |
targeting.geographic.location_types | enum[] | No | Values: HOME, RECENT, TRAVEL |
targeting.geographic.presence_type | enum | No | Values: PRESENCE, PRESENCE_OR_INTEREST |
targeting.demographic | AdsGroup_targeting_demographic | No | Demographic targeting (Meta: age_min, age_max, genders) |
targeting.demographic.age_min | number | No | |
targeting.demographic.age_max | number | No | |
targeting.demographic.male | boolean | No | |
targeting.demographic.female | boolean | No | |
targeting.audience | AdsGroup_targeting_audience | No | |
targeting.audience.custom_audiences | TargetRef[] | No | |
targeting.audience.custom_audiences[].id | string | No | |
targeting.audience.custom_audiences[].name | string | No | |
targeting.audience.excluded_custom_audiences | TargetRef[] | No | |
targeting.audience.excluded_custom_audiences[].id | string | No | |
targeting.audience.excluded_custom_audiences[].name | string | No | |
targeting.audience.lookalike_audiences | LookalikeAudience[] | No | |
targeting.audience.lookalike_audiences[].id | string | Yes | |
targeting.audience.lookalike_audiences[].name | string | No | |
targeting.audience.lookalike_audiences[].similarity | number | No | |
targeting.audience.lookalike_audiences[].source_audience_id | string | No | |
targeting.audience.interests | TargetRef[] | No | |
targeting.audience.interests[].id | string | No | |
targeting.audience.interests[].name | string | No | |
targeting.audience.excluded_interests | TargetRef[] | No | |
targeting.audience.excluded_interests[].id | string | No | |
targeting.audience.excluded_interests[].name | string | No | |
targeting.audience.behaviors | TargetRef[] | No | |
targeting.audience.behaviors[].id | string | No | |
targeting.audience.behaviors[].name | string | No | |
targeting.audience.excluded_behaviors | TargetRef[] | No | |
targeting.audience.excluded_behaviors[].id | string | No | |
targeting.audience.excluded_behaviors[].name | string | No | |
targeting.audience.combination_spec | AudienceCombination[] | No | |
targeting.audience.combination_spec[].interests | TargetRef[] | No | |
targeting.audience.combination_spec[].interests[].id | string | No | |
targeting.audience.combination_spec[].interests[].name | string | No | |
targeting.audience.combination_spec[].behaviors | TargetRef[] | No | |
targeting.audience.combination_spec[].behaviors[].id | string | No | |
targeting.audience.combination_spec[].behaviors[].name | string | No | |
targeting.audience.combination_spec[].references | TargetRef[] | No | |
targeting.audience.combination_spec[].references[].id | string | No | |
targeting.audience.combination_spec[].references[].name | string | No | |
targeting.audience.combination_spec[].life_events | TargetRef[] | No | |
targeting.audience.combination_spec[].life_events[].id | string | No | |
targeting.audience.combination_spec[].life_events[].name | string | No | |
targeting.placement | AdsGroup_targeting_placement | No | |
targeting.placement.platforms | string[] | No | |
targeting.placement.facebook_positions | string[] | No | |
targeting.placement.instagram_positions | string[] | No | |
targeting.placement.messenger_positions | string[] | No | |
targeting.placement.audience_network_positions | string[] | No | |
targeting.device | AdsGroup_targeting_device | No | |
targeting.device.types | TargetRef[] | No | |
targeting.device.types[].id | string | No | |
targeting.device.types[].name | string | No | |
targeting.device.user_device | TargetRef[] | No | |
targeting.device.user_device[].id | string | No | |
targeting.device.user_device[].name | string | No | |
targeting.device.user_os | TargetRef[] | No | |
targeting.device.user_os[].id | string | No | |
targeting.device.user_os[].name | string | No | |
targeting.device.carriers | TargetRef[] | No | |
targeting.device.carriers[].id | string | No | |
targeting.device.carriers[].name | string | No | |
targeting.language | TargetRef[] | No | |
targeting.language[].id | string | No | |
targeting.language[].name | string | No | |
targeting.content | AdsGroup_targeting_content | No | |
targeting.content.keywords | AdsKeyword[] | No | |
targeting.content.keywords[].text | string | Yes | |
targeting.content.keywords[].match_type | enum | No | Values: BROAD, PHRASE, EXACT |
targeting.content.excluded_keywords | AdsKeyword[] | No | |
targeting.content.excluded_keywords[].text | string | Yes | |
targeting.content.excluded_keywords[].match_type | enum | No | Values: BROAD, PHRASE, EXACT |
targeting.content.topics | TargetRef[] | No | |
targeting.content.topics[].id | string | No | |
targeting.content.topics[].name | string | No | |
targeting.content.excluded_topics | TargetRef[] | No | |
targeting.content.excluded_topics[].id | string | No | |
targeting.content.excluded_topics[].name | string | No | |
targeting.content.urls | string[] | No | |
targeting.content.excluded_urls | string[] | No | |
targeting.content.video | AdsGroup_targeting_content_video | No | |
targeting.content.video.youtube_videos | string[] | No | |
targeting.content.video.excluded_youtube_videos | string[] | No | |
targeting.content.video.youtube_channels | string[] | No | |
targeting.content.video.excluded_youtube_channels | string[] | No | |
targeting.content.video.positions | enum[] | No | Values: PREROLL, MIDROLL, POSTROLL, INSTREAM, OUTSTREAM |
targeting.content.video.player_sizes | enum[] | No | Values: SMALL, LARGE, HD |
targeting.content.video.durations | enum[] | No | Values: SHORT, MEDIUM, LONG |
targeting.brand_safety | AdsGroup_targeting_brand_safety | No | Brand safety (Meta: excluded_publisher_categories, etc.; Google |
targeting.brand_safety.excluded_publisher_categories | string[] | No | |
targeting.brand_safety.excluded_content_labels | string[] | No | Google Ads ContentLabelType |
targeting.brand_safety.brand_safety_content_filter_levels | string[] | No | |
targeting.brand_safety.publisher_visibility_categories | enum[] | No | Values: limited, standard, expanded |
targeting.brand_safety.block_list_ids | string[] | No | |
targeting.schedule | AdSchedule[] | No | |
targeting.schedule[].day_of_week | enum | Yes | Values: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY |
targeting.schedule[].start_hour | number | Yes | 0-23 |
targeting.schedule[].start_minute | number | No | 0, 15, 30, 45 |
targeting.schedule[].end_hour | number | Yes | 0-24 (24 = end of day) |
targeting.schedule[].end_minute | number | No | 0, 15, 30, 45 |
targeting.schedule[].bid_modifier | number | No | 0.1-10.0 |
targeting.optimization | AdsGroup_targeting_optimization | No | Optimization (Meta: targeting_automation; Google: observation vs targeting mode) |
targeting.optimization.mode | enum | No | Google: bid_only falsetrue Values: TARGETING, OBSERVATION |
targeting.optimization.advantage_audience | boolean | No | |
targeting.optimization.advantage_placements | boolean | No | |
targeting.optimization.targeting_optimization_expansion_all | boolean | No | |
targeting.inventory | AdsGroup_targeting_inventory | No | Publisher inventory (ad units, placements) to include / exclude |
targeting.inventory.inventory_ids | string[] | No | |
targeting.inventory.excluded_inventory_ids | string[] | No | |
targeting.custom | CustomTargeting[] | No | Key-value targeting; clauses are ANDed |
targeting.custom[].key | string | Yes | |
targeting.custom[].values | string[] | Yes | |
targeting.custom[].is_excluded | boolean | No | |
targeting.supply | AdsGroup_targeting_supply | No | Buy-side inventory: exchanges, deals, deal groups and seller authorization (DSPs) |
targeting.supply.exchanges | TargetRef[] | No | Public exchanges to buy on (ads_target type EXCHANGE) |
targeting.supply.exchanges[].id | string | No | |
targeting.supply.exchanges[].name | string | No | |
targeting.supply.deals | TargetRef[] | No | Deals / inventory packages (ads_target type DEAL) |
targeting.supply.deals[].id | string | No | |
targeting.supply.deals[].name | string | No | |
targeting.supply.deal_groups | TargetRef[] | No | Groups of deals (ads_target type DEAL_GROUP) |
targeting.supply.deal_groups[].id | string | No | |
targeting.supply.deal_groups[].name | string | No | |
targeting.supply.authorized_seller_status | enum | No | ads.txt seller authorization to buy from Values: AUTHORIZED_DIRECT_ONLY, AUTHORIZED_DIRECT_AND_RESELLERS, AUTHORIZED_AND_NON_PARTICIPATING |
bid_amount | number | No | |
bid_strategy | object | No | YOUTUBE_AND_PARTNERS |
bid_strategy.type | enum | Yes | Values: FIXED_BID, MAXIMIZE_SPEND, PERFORMANCE_GOAL, YOUTUBE_AND_PARTNERS |
bid_strategy.fixed_bid_amount | number | No | |
bid_strategy.performance_goal_type | enum | No | Values: UNSPECIFIED, CPA, CPC, VIEWABLE_CPM, CUSTOM_ALGO, CIVA, IVO_TEN, AV_VIEWED, REACH |
bid_strategy.performance_goal_amount | number | No | |
bid_strategy.max_average_cpm_bid_amount | number | No | |
bid_strategy.custom_bidding_algorithm_id | string | No | |
bid_strategy.raise_bid_for_deals | boolean | No | |
bid_strategy.youtube_and_partners_type | enum | No | Values: UNSPECIFIED, MANUAL_CPV, MANUAL_CPM, TARGET_CPA, TARGET_CPM, RESERVE_CPM, MAXIMIZE_LIFT, MAXIMIZE_CONVERSIONS, TARGET_CPV, TARGET_ROAS, MAXIMIZE_CONVERSION_VALUE |
bid_strategy.youtube_and_partners_value | string | No | |
bid_strategy.target_roas | number | No | Target ROAS e.g. 2.5 = 250% (Google) |
budget_amount | number | No | |
budget_period | enum | No | Values: DAILY, MONTHLY, TOTAL, LIFETIME |
budget_allocation_type | enum | No | Values: UNSPECIFIED, AUTOMATIC, FIXED, UNLIMITED |
start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
budget_unit | enum | No | Values: UNSPECIFIED, CURRENCY, IMPRESSIONS |
budget_max_amount | number | No | |
type | enum | No | Values: TEXT, IMAGE, VIDEO, RESPONSIVE, SHOPPING, APP, CALL, CAROUSEL, SOCIAL, DISPLAY, SEARCH, AUDIO, YOUTUBE, NATIVE, CTV, DOOH, PERFORMANCE_MAX |
has_eu_political_ads | boolean | No | |
pacing | object | No | |
pacing.period | enum | No | Values: UNSPECIFIED, DAILY, FLIGHT |
pacing.type | string | No | |
pacing.daily_max_amount | number | No | |
pacing.daily_max_impressions | number | No | |
frequency_cap | object | No | |
frequency_cap.is_unlimited | boolean | No | |
frequency_cap.time_unit | enum | No | Values: UNSPECIFIED, LIFETIME, MONTHS, WEEKS, DAYS, HOURS, MINUTES |
frequency_cap.time_unit_count | number | No | |
frequency_cap.max_impressions | number | No | |
frequency_cap.max_views | number | No | |
creative_ids | string[] | No | |
optimization_goal | enum | No | Optimization goals for ads_group (cross-platform; platform-specific values allowed as pass-through) Values: REACH, IMPRESSIONS, LINK_CLICKS, LANDING_PAGE_VIEWS, CONVERSIONS, LEAD_GENERATION, APP_INSTALLS, APP_ENGAGEMENT, VIDEO_VIEWS, ENGAGEMENT, PAGE_LIKES, MESSAGES |
billing_event | enum | No | Billing events for ads_group (what you pay for; cross-platform; platform-specific values allowed as pass-through) Values: IMPRESSIONS, LINK_CLICKS, VIDEO_VIEWS, APP_INSTALLS, ENGAGEMENT, PAGE_LIKES, MESSAGES, POST_ENGAGEMENT, PURCHASE, NONE |
currency | string | No | |
promoted | AdsPromoted[] | No | |
promoted[].id | string | Yes | |
promoted[].name | string | No | |
promoted[].type | enum | Yes | Promoted entity types for ads_promoted list endpoint Values: PAGE_ID, APP_ID, STORE_URL, PIXEL_ID, CUSTOM_CONVERSION_ID, CATALOG_ID, PRODUCT_SET_ID, PRIORITIZED_SET_ID, EVENT_ID, OFFER_ID, LEAD_FORM_ID, MESSAGING_CHANNEL_ID, PRODUCT_ID, TWEET_ID, AD_GROUP_TYPE |
promoted[].metadata | AdsMetadata[] | No | |
promoted[].metadata[].id | string | No | |
promoted[].metadata[].slug | string | No | |
promoted[].metadata[].value | object | No | |
promoted[].metadata[].namespace | string | No | |
promoted[].metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
promoted[].metadata[].extra_data | object | No | |
language_locale | string | No | Language + region, ISO 639-1 with region (e.g. en-US); LinkedIn locale |
creative_selection | enum | No | Creative rotation strategy (LinkedIn creativeSelection) Values: OPTIMIZED, ROUND_ROBIN, WEIGHTED, SEQUENTIAL |
metadata | AdsMetadata[] | No | |
metadata[].id | string | No | |
metadata[].slug | string | No | |
metadata[].value | object | No | |
metadata[].namespace | string | No | |
metadata[].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL |
metadata[].extra_data | object | No | |
delivery_type | enum | No | Ad server line item type / delivery class (Google Ad Manager lineItemType) Values: STANDARD, SPONSORSHIP, NETWORK, BULK, PRICE_PRIORITY, HOUSE, PREFERRED_DEAL, AD_EXCHANGE, CLICK_TRACKING, OTHER |
priority | number | No | Ad server delivery priority, lower serves first (Google Ad Manager priority, Kevel priority) |
cost_type | enum | No | How the line item is priced (Google Ad Manager costType) Values: CPM, VIEWABLE_CPM, CPC, CPD, CPA, CPCV, OTHER |
delivery_goal | object | No | Booked delivery goal (Google Ad Manager goal) |
delivery_goal.period | enum | No | Values: DAILY, MONTHLY, TOTAL, LIFETIME |
delivery_goal.unit | enum | No | Values: IMPRESSIONS, VIEWABLE_IMPRESSIONS, CLICKS, CONVERSIONS, COMPLETED_VIEWS |
delivery_goal.quantity | number | No | |
creative_sizes | AdsSize[] | No | Expected creative sizes (Google Ad Manager creativePlaceholders) |
creative_sizes[].width | number | Yes | |
creative_sizes[].height | number | Yes | |
conversion_tracking | AdsConversionTracking[] | No | Conversion trackers counted for this group (DV360 Floodlight activities, Pinterest conversion tag) |
conversion_tracking[].identifier | string | Yes | Integration's conversion tracker ID (Floodlight activity ID, conversion tag ID) |
conversion_tracking[].type | enum | No | Values: FLOODLIGHT_ACTIVITY, CONVERSION_TAG, PIXEL, OTHER |
conversion_tracking[].post_click_window_days | number | No | Days after a click in which a conversion is counted |
conversion_tracking[].post_view_window_days | number | No | Days after a view in which a conversion is counted |
Are we missing anything? Let us know
Was this page helpful?