Skip to content

AdGroups Object

Properties

idstring
required·

The unique identifier for the ad_group.

account_idstring

The unique identifier for the account.

attribution_specstring

The attribution spec for the ad_group.

bidobject

The bid for the ad_group.

adjustmentsobject

The bid adjustments for the ad_group.

amountstring

The bid amount for the ad_group.

constraintsobject

The bid constraints for the ad_group.

objective_valuesobject

The bid values for different objectives of the ad_group.

strategyobject

The bid strategy for the ad_group.

2 properties
idstring

The unique identifier for the bid strategy.

namestring

The name of the bid strategy.

billing_eventstring

The billing event for the ad_group.

Possible values:
app_installsclicksimpressionslink_clicksnoneoffer_claimspage_likespost_engagementvideo_views
budgetobject

The budget for the ad_group.

daily_maxstring

The daily max budget for the ad_group.

daily_minstring

The daily min budget for the ad_group.

lifetime_maxstring

The max budget for the ad_group.

campaign_idstring

The unique identifier for the campaign.

created_atstring · date-time

The date and time the ad_group was created.

destinationobject

The destination type for the ad_group.

idstring

The unique identifier for the destination type.

namestring

The name of the destination type.

Possible values:
undefinedappmessengerwebsiteinstagram_directon_adon_poston_videoon_pageon_event
impressionsobject

The impressions for the ad_group.

daily_minstring

The daily min impressions for the ad_group.

lifetime_maxstring

The max impressions for the ad_group.

issuesobject[]

The issues for the ad_group that prevented ads from being delivered.

codestring

The code for the issue.

descriptionstring

The error summary for the issue.

levelstring

The level for the issue.

messagestring

The error message for the issue.

typestring

The type for the issue.

labelsobject[]

The labels for the ad_group.

idstring

The unique identifier for the label.

namestring

The name of the label.

namestring

The name of the ad_group.

optimization_goalstring

The optimization goal for the ad_group.

Possible values:
noneapp_installsad_recall_liftclicksengaged_usersevent_responsesimpressionslead_generationquality_leadlink_clicksoffsite_conversionspage_likes+ 10 more
promoted_objectobject

The promoted object for the ad_group.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

scheduleobject

The schedule for the ad_group.

daysstring[]

The days for the ad_group.

Possible values:
sundaymondaytuesdaywednesdaythursdayfridaysaturday
end_timestring · date-time

The end time for the ad_group.

start_timestring · date-time

The start time for the ad_group.

spendobject

The spend for the ad_group.

cap_enabledboolean

Whether the cap is enabled for the ad_group.

daily_max_capstring

The max cap spend for the ad_group.

daily_min_capstring

The min cap spend for the ad_group.

lifetime_maxstring

The max spend for the ad_group.

start_timestring · date-time

The start time for the ad_group.

statusstring

The status of the campaign.

Possible values:
activeinactivedraftpauseddeletedarchivedin_processwith_issuescompletedcanceledpending_deletion
stop_timestring · date-time

The stop time for the ad_group.

targetingobject

The targeting for the ad_group.

targeting_optimization_typesobject[]
keystring

The key for the targeting optimization type.

valuestring

The value for the targeting optimization type.

updated_atstring · date-time

The date and time the ad_group was last updated.