List ad groups
GET {{baseUrl}}/ad_accounts/:ad_account_id/ad_groups?campaign_ids=978&ad_group_ids=9&entity_statuses=ACTIVE&entity_statuses=PAUSED&page_size=25&order=DESCENDING&bookmark=<string>&translate_interests_to_names=false
List ad groups based on provided campaign IDs or ad group IDs.(campaignids or adgroupids).
Note:
Provide only campaignid or adgroupid. Do not provide both.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
campaign_ids | number | List of Campaign Ids to use to filter the results. | |
ad_group_ids | number | List of Ad group Ids to use to filter the results. | |
entity_statuses | string | Entity status | |
entity_statuses | string | Entity status | |
page_size | number | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information. | |
order | string | The order in which to sort the items returned: “ASCENDING” or “DESCENDING” | |
by ID. Note that higher-value IDs are associated with more-recently added | |||
items. | |||
bookmark | string | Cursor used to fetch the next page of items | |
translate_interests_to_names | boolean | Return interests as text names (if value is true) rather than topic IDs. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"name":"\u003cstring\u003e","status":"ARCHIVED","budget_in_micro_currency":"\u003cinteger\u003e","bid_in_micro_currency":"\u003cinteger\u003e","optimization_goal_metadata":{"conversion_tag_v3_goal_metadata":{"attribution_windows":{"click_window_days":"\u003cinteger\u003e","engagement_window_days":"\u003cinteger\u003e","view_window_days":"\u003cinteger\u003e"},"conversion_event":"CHECKOUT","conversion_tag_id":"567","cpa_goal_value_in_micro_currency":"346","is_roas_optimized":"\u003cboolean\u003e","learning_mode_type":"ACTIVE"},"frequency_goal_metadata":{"frequency":"\u003cinteger\u003e","timerange":"DAY"},"scrollup_goal_metadata":{"scrollup_goal_value_in_micro_currency":"9090"}},"budget_type":"CBO_ADGROUP","start_time":"\u003cinteger\u003e","end_time":"\u003cinteger\u003e","targeting_spec":{"AGE_BUCKET":["35-44","65+"],"APPTYPE":["web_mobile","android_mobile"],"AUDIENCE_EXCLUDE":["77","5272"],"AUDIENCE_INCLUDE'":["86767","8514537"],"GENDER":["female","female"],"GEO":["\u003cstring\u003e","\u003cstring\u003e"],"INTEREST":["\u003cstring\u003e","\u003cstring\u003e"],"LOCALE":["\u003cstring\u003e","\u003cstring\u003e"],"LOCATION":["\u003cstring\u003e","\u003cstring\u003e"],"SHOPPING_RETARGETING":[{"lookback_window":"\u003cinteger\u003e","tag_types":["\u003cinteger\u003e","\u003cinteger\u003e"],"exclusion_window":"\u003cinteger\u003e"},{"lookback_window":"\u003cinteger\u003e","tag_types":["\u003cinteger\u003e","\u003cinteger\u003e"],"exclusion_window":"\u003cinteger\u003e"}],"TARGETING_STRATEGY":["FIND_NEW_CUSTOMERS","FIND_NEW_CUSTOMERS"]},"lifetime_frequency_cap":"\u003cinteger\u003e","tracking_urls":{"impression":["\u003cstring\u003e","\u003cstring\u003e"],"click":["\u003cstring\u003e","\u003cstring\u003e"],"engagement":["\u003cstring\u003e","\u003cstring\u003e"],"buyable_button":["\u003cstring\u003e","\u003cstring\u003e"],"audience_verification":["\u003cstring\u003e","\u003cstring\u003e"]},"auto_targeting_enabled":"\u003cboolean\u003e","placement_group":"BROWSE","pacing_delivery_type":"STANDARD","campaign_id":"C468","billable_event":"VIDEO_V_50_MRC","bid_strategy_type":"MAX_BID","id":"37516","ad_account_id":"553246","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e","type":"adgroup","conversion_learning_mode_type":null,"summary_status":"ARCHIVED","feed_profile_id":"\u003cstring\u003e","dca_assets":{"description":"[DCA] The Dynamic creative assets to use for DCA. Dynamic Creative Assembly (DCA) accepts basic creative assets of an ad (image, video, title, call to action, logo etc). Then it automatically generates optimized ad combinations based on these assets."}},{"name":"\u003cstring\u003e","status":"PAUSED","budget_in_micro_currency":"\u003cinteger\u003e","bid_in_micro_currency":"\u003cinteger\u003e","optimization_goal_metadata":{"conversion_tag_v3_goal_metadata":{"attribution_windows":{"click_window_days":"\u003cinteger\u003e","engagement_window_days":"\u003cinteger\u003e","view_window_days":"\u003cinteger\u003e"},"conversion_event":"ADD_TO_CART","conversion_tag_id":"55286","cpa_goal_value_in_micro_currency":"58828303683","is_roas_optimized":"\u003cboolean\u003e","learning_mode_type":"NOT_ACTIVE"},"frequency_goal_metadata":{"frequency":"\u003cinteger\u003e","timerange":"TEN_MINUTE"},"scrollup_goal_metadata":{"scrollup_goal_value_in_micro_currency":"33144"}},"budget_type":"CBO_ADGROUP","start_time":"\u003cinteger\u003e","end_time":"\u003cinteger\u003e","targeting_spec":{"AGE_BUCKET":["21+","65+"],"APPTYPE":["web_mobile","android_mobile"],"AUDIENCE_EXCLUDE":["1784550564","221053"],"AUDIENCE_INCLUDE'":["62915020253","35594814"],"GENDER":["unknown","unknown"],"GEO":["\u003cstring\u003e","\u003cstring\u003e"],"INTEREST":["\u003cstring\u003e","\u003cstring\u003e"],"LOCALE":["\u003cstring\u003e","\u003cstring\u003e"],"LOCATION":["\u003cstring\u003e","\u003cstring\u003e"],"SHOPPING_RETARGETING":[{"lookback_window":"\u003cinteger\u003e","tag_types":["\u003cinteger\u003e","\u003cinteger\u003e"],"exclusion_window":"\u003cinteger\u003e"},{"lookback_window":"\u003cinteger\u003e","tag_types":["\u003cinteger\u003e","\u003cinteger\u003e"],"exclusion_window":"\u003cinteger\u003e"}],"TARGETING_STRATEGY":["CHOOSE_YOUR_OWN","RECONNECT_WITH_USERS"]},"lifetime_frequency_cap":"\u003cinteger\u003e","tracking_urls":{"impression":["\u003cstring\u003e","\u003cstring\u003e"],"click":["\u003cstring\u003e","\u003cstring\u003e"],"engagement":["\u003cstring\u003e","\u003cstring\u003e"],"buyable_button":["\u003cstring\u003e","\u003cstring\u003e"],"audience_verification":["\u003cstring\u003e","\u003cstring\u003e"]},"auto_targeting_enabled":"\u003cboolean\u003e","placement_group":"SEARCH","pacing_delivery_type":"STANDARD","campaign_id":"76849166795","billable_event":"CLICKTHROUGH","bid_strategy_type":null,"id":"171381762","ad_account_id":"0656","created_time":"\u003cinteger\u003e","updated_time":"\u003cinteger\u003e","type":"adgroup","conversion_learning_mode_type":"ACTIVE","summary_status":"ARCHIVED","feed_profile_id":"\u003cstring\u003e","dca_assets":{"description":"[DCA] The Dynamic creative assets to use for DCA. Dynamic Creative Assembly (DCA) accepts basic creative assets of an ad (image, video, title, call to action, logo etc). Then it automatically generates optimized ad combinations based on these assets."}}],"bookmark":"\u003cstring\u003e"}