Retrieve a group

Updated:

GET/ads/{connection_id}/group/{id}

Retrieves a single AdsGroup by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Group

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe ad group's name
parent_idstringNo
campaign_idstringNoThe ID of the campaign the ad group belongs to (an AdsCampaign ID)
organization_idstringNo
insertionorder_idstringNo
statusenumNoValues: UNSPECIFIED, ACTIVE, PAUSED, ARCHIVED, DRAFT, SCHEDULED_FOR_DELETION, PROCESSING, PROCESSING_FAILED
effective_statusenumNoValues: UNSPECIFIED, SERVING, LIMITED, LEARNING, PAUSED, PENDING, ENDED, MISCONFIGURED, NOT_ELIGIBLE, ARCHIVED, REMOVED
targetingobjectNo
targeting.geographicAdsGroup_targeting_geographicNo
targeting.geographic.countriesTargetRef[]No
targeting.geographic.countries[].idstringNo
targeting.geographic.countries[].namestringNo
targeting.geographic.regionsTargetRef[]No
targeting.geographic.regions[].idstringNo
targeting.geographic.regions[].namestringNo
targeting.geographic.citiesCityTarget[]No
targeting.geographic.cities[].idstringYes
targeting.geographic.cities[].namestringNo
targeting.geographic.cities[].radiusnumberNo
targeting.geographic.cities[].radius_unitenumNoValues: MILES, KILOMETERS
targeting.geographic.postal_codesTargetRef[]No
targeting.geographic.postal_codes[].idstringNo
targeting.geographic.postal_codes[].namestringNo
targeting.geographic.us_dmasTargetRef[]No
targeting.geographic.us_dmas[].idstringNo
targeting.geographic.us_dmas[].namestringNo
targeting.geographic.excluded_countriesTargetRef[]No
targeting.geographic.excluded_countries[].idstringNo
targeting.geographic.excluded_countries[].namestringNo
targeting.geographic.excluded_regionsTargetRef[]No
targeting.geographic.excluded_regions[].idstringNo
targeting.geographic.excluded_regions[].namestringNo
targeting.geographic.excluded_citiesCityTarget[]No
targeting.geographic.excluded_cities[].idstringYes
targeting.geographic.excluded_cities[].namestringNo
targeting.geographic.excluded_cities[].radiusnumberNo
targeting.geographic.excluded_cities[].radius_unitenumNoValues: MILES, KILOMETERS
targeting.geographic.excluded_postal_codesTargetRef[]No
targeting.geographic.excluded_postal_codes[].idstringNo
targeting.geographic.excluded_postal_codes[].namestringNo
targeting.geographic.excluded_us_dmasTargetRef[]No
targeting.geographic.excluded_us_dmas[].idstringNo
targeting.geographic.excluded_us_dmas[].namestringNo
targeting.geographic.location_typesenum[]NoValues: HOME, RECENT, TRAVEL
targeting.geographic.presence_typeenumNoValues: PRESENCE, PRESENCE_OR_INTEREST
targeting.demographicAdsGroup_targeting_demographicNoDemographic targeting (Meta: age_min, age_max, genders)
targeting.demographic.age_minnumberNo
targeting.demographic.age_maxnumberNo
targeting.demographic.malebooleanNo
targeting.demographic.femalebooleanNo
targeting.audienceAdsGroup_targeting_audienceNo
targeting.audience.custom_audiencesTargetRef[]No
targeting.audience.custom_audiences[].idstringNo
targeting.audience.custom_audiences[].namestringNo
targeting.audience.excluded_custom_audiencesTargetRef[]No
targeting.audience.excluded_custom_audiences[].idstringNo
targeting.audience.excluded_custom_audiences[].namestringNo
targeting.audience.lookalike_audiencesLookalikeAudience[]No
targeting.audience.lookalike_audiences[].idstringYes
targeting.audience.lookalike_audiences[].namestringNo
targeting.audience.lookalike_audiences[].similaritynumberNo
targeting.audience.lookalike_audiences[].source_audience_idstringNo
targeting.audience.interestsTargetRef[]No
targeting.audience.interests[].idstringNo
targeting.audience.interests[].namestringNo
targeting.audience.excluded_interestsTargetRef[]No
targeting.audience.excluded_interests[].idstringNo
targeting.audience.excluded_interests[].namestringNo
targeting.audience.behaviorsTargetRef[]No
targeting.audience.behaviors[].idstringNo
targeting.audience.behaviors[].namestringNo
targeting.audience.excluded_behaviorsTargetRef[]No
targeting.audience.excluded_behaviors[].idstringNo
targeting.audience.excluded_behaviors[].namestringNo
targeting.audience.combination_specAudienceCombination[]No
targeting.audience.combination_spec[].interestsTargetRef[]No
targeting.audience.combination_spec[].interests[].idstringNo
targeting.audience.combination_spec[].interests[].namestringNo
targeting.audience.combination_spec[].behaviorsTargetRef[]No
targeting.audience.combination_spec[].behaviors[].idstringNo
targeting.audience.combination_spec[].behaviors[].namestringNo
targeting.audience.combination_spec[].referencesTargetRef[]No
targeting.audience.combination_spec[].references[].idstringNo
targeting.audience.combination_spec[].references[].namestringNo
targeting.audience.combination_spec[].life_eventsTargetRef[]No
targeting.audience.combination_spec[].life_events[].idstringNo
targeting.audience.combination_spec[].life_events[].namestringNo
targeting.placementAdsGroup_targeting_placementNo
targeting.placement.platformsstring[]No
targeting.placement.facebook_positionsstring[]No
targeting.placement.instagram_positionsstring[]No
targeting.placement.messenger_positionsstring[]No
targeting.placement.audience_network_positionsstring[]No
targeting.deviceAdsGroup_targeting_deviceNo
targeting.device.typesTargetRef[]No
targeting.device.types[].idstringNo
targeting.device.types[].namestringNo
targeting.device.user_deviceTargetRef[]No
targeting.device.user_device[].idstringNo
targeting.device.user_device[].namestringNo
targeting.device.user_osTargetRef[]No
targeting.device.user_os[].idstringNo
targeting.device.user_os[].namestringNo
targeting.device.carriersTargetRef[]No
targeting.device.carriers[].idstringNo
targeting.device.carriers[].namestringNo
targeting.languageTargetRef[]No
targeting.language[].idstringNo
targeting.language[].namestringNo
targeting.contentAdsGroup_targeting_contentNo
targeting.content.keywordsAdsKeyword[]No
targeting.content.keywords[].textstringYes
targeting.content.keywords[].match_typeenumNoValues: BROAD, PHRASE, EXACT
targeting.content.excluded_keywordsAdsKeyword[]No
targeting.content.excluded_keywords[].textstringYes
targeting.content.excluded_keywords[].match_typeenumNoValues: BROAD, PHRASE, EXACT
targeting.content.topicsTargetRef[]No
targeting.content.topics[].idstringNo
targeting.content.topics[].namestringNo
targeting.content.excluded_topicsTargetRef[]No
targeting.content.excluded_topics[].idstringNo
targeting.content.excluded_topics[].namestringNo
targeting.content.urlsstring[]No
targeting.content.excluded_urlsstring[]No
targeting.content.videoAdsGroup_targeting_content_videoNo
targeting.content.video.youtube_videosstring[]No
targeting.content.video.excluded_youtube_videosstring[]No
targeting.content.video.youtube_channelsstring[]No
targeting.content.video.excluded_youtube_channelsstring[]No
targeting.content.video.positionsenum[]NoValues: PREROLL, MIDROLL, POSTROLL, INSTREAM, OUTSTREAM
targeting.content.video.player_sizesenum[]NoValues: SMALL, LARGE, HD
targeting.content.video.durationsenum[]NoValues: SHORT, MEDIUM, LONG
targeting.brand_safetyAdsGroup_targeting_brand_safetyNoBrand safety (Meta: excluded_publisher_categories, etc.; Google
targeting.brand_safety.excluded_publisher_categoriesstring[]No
targeting.brand_safety.excluded_content_labelsstring[]NoGoogle Ads ContentLabelType
targeting.brand_safety.brand_safety_content_filter_levelsstring[]No
targeting.brand_safety.publisher_visibility_categoriesenum[]NoValues: limited, standard, expanded
targeting.brand_safety.block_list_idsstring[]No
targeting.scheduleAdSchedule[]No
targeting.schedule[].day_of_weekenumYesValues: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
targeting.schedule[].start_hournumberYes0-23
targeting.schedule[].start_minutenumberNo0, 15, 30, 45
targeting.schedule[].end_hournumberYes0-24 (24 = end of day)
targeting.schedule[].end_minutenumberNo0, 15, 30, 45
targeting.schedule[].bid_modifiernumberNo0.1-10.0
targeting.optimizationAdsGroup_targeting_optimizationNoOptimization (Meta: targeting_automation; Google: observation vs targeting mode)
targeting.optimization.modeenumNoGoogle: bid_only falsetrue Values: TARGETING, OBSERVATION
targeting.optimization.advantage_audiencebooleanNo
targeting.optimization.advantage_placementsbooleanNo
targeting.optimization.targeting_optimization_expansion_allbooleanNo
targeting.inventoryAdsGroup_targeting_inventoryNoPublisher inventory (ad units, placements) to include / exclude
targeting.inventory.inventory_idsstring[]No
targeting.inventory.excluded_inventory_idsstring[]No
targeting.customCustomTargeting[]NoKey-value targeting; clauses are ANDed
targeting.custom[].keystringYes
targeting.custom[].valuesstring[]Yes
targeting.custom[].is_excludedbooleanNo
targeting.supplyAdsGroup_targeting_supplyNoBuy-side inventory: exchanges, deals, deal groups and seller authorization (DSPs)
targeting.supply.exchangesTargetRef[]NoPublic exchanges to buy on (ads_target type EXCHANGE)
targeting.supply.exchanges[].idstringNo
targeting.supply.exchanges[].namestringNo
targeting.supply.dealsTargetRef[]NoDeals / inventory packages (ads_target type DEAL)
targeting.supply.deals[].idstringNo
targeting.supply.deals[].namestringNo
targeting.supply.deal_groupsTargetRef[]NoGroups of deals (ads_target type DEAL_GROUP)
targeting.supply.deal_groups[].idstringNo
targeting.supply.deal_groups[].namestringNo
targeting.supply.authorized_seller_statusenumNoads.txt seller authorization to buy from Values: AUTHORIZED_DIRECT_ONLY, AUTHORIZED_DIRECT_AND_RESELLERS, AUTHORIZED_AND_NON_PARTICIPATING
bid_amountnumberNo
bid_strategyobjectNoYOUTUBE_AND_PARTNERS
bid_strategy.typeenumYesValues: FIXED_BID, MAXIMIZE_SPEND, PERFORMANCE_GOAL, YOUTUBE_AND_PARTNERS
bid_strategy.fixed_bid_amountnumberNo
bid_strategy.performance_goal_typeenumNoValues: UNSPECIFIED, CPA, CPC, VIEWABLE_CPM, CUSTOM_ALGO, CIVA, IVO_TEN, AV_VIEWED, REACH
bid_strategy.performance_goal_amountnumberNo
bid_strategy.max_average_cpm_bid_amountnumberNo
bid_strategy.custom_bidding_algorithm_idstringNo
bid_strategy.raise_bid_for_dealsbooleanNo
bid_strategy.youtube_and_partners_typeenumNoValues: 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_valuestringNo
bid_strategy.target_roasnumberNoTarget ROAS e.g. 2.5 = 250% (Google)
budget_amountnumberNo
budget_periodenumNoValues: DAILY, MONTHLY, TOTAL, LIFETIME
budget_allocation_typeenumNoValues: UNSPECIFIED, AUTOMATIC, FIXED, UNLIMITED
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
budget_unitenumNoValues: UNSPECIFIED, CURRENCY, IMPRESSIONS
budget_max_amountnumberNo
typeenumNoValues: TEXT, IMAGE, VIDEO, RESPONSIVE, SHOPPING, APP, CALL, CAROUSEL, SOCIAL, DISPLAY, SEARCH, AUDIO, YOUTUBE, NATIVE, CTV, DOOH, PERFORMANCE_MAX
has_eu_political_adsbooleanNo
pacingobjectNo
pacing.periodenumNoValues: UNSPECIFIED, DAILY, FLIGHT
pacing.typestringNo
pacing.daily_max_amountnumberNo
pacing.daily_max_impressionsnumberNo
frequency_capobjectNo
frequency_cap.is_unlimitedbooleanNo
frequency_cap.time_unitenumNoValues: UNSPECIFIED, LIFETIME, MONTHS, WEEKS, DAYS, HOURS, MINUTES
frequency_cap.time_unit_countnumberNo
frequency_cap.max_impressionsnumberNo
frequency_cap.max_viewsnumberNo
creative_idsstring[]No
optimization_goalenumNoOptimization 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_eventenumNoBilling 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
currencystringNo
promotedAdsPromoted[]No
promoted[].idstringYes
promoted[].namestringNo
promoted[].typeenumYesPromoted 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[].metadataAdsMetadata[]No
promoted[].metadata[].idstringNo
promoted[].metadata[].slugstringNo
promoted[].metadata[].valueobjectNo
promoted[].metadata[].namespacestringNo
promoted[].metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
promoted[].metadata[].extra_dataobjectNo
language_localestringNoLanguage + region, ISO 639-1 with region (e.g. en-US); LinkedIn locale
creative_selectionenumNoCreative rotation strategy (LinkedIn creativeSelection) Values: OPTIMIZED, ROUND_ROBIN, WEIGHTED, SEQUENTIAL
metadataAdsMetadata[]No
metadata[].idstringNo
metadata[].slugstringNo
metadata[].valueobjectNo
metadata[].namespacestringNo
metadata[].formatenumNoValues: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
delivery_typeenumNoAd 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
prioritynumberNoAd server delivery priority, lower serves first (Google Ad Manager priority, Kevel priority)
cost_typeenumNoHow the line item is priced (Google Ad Manager costType) Values: CPM, VIEWABLE_CPM, CPC, CPD, CPA, CPCV, OTHER
delivery_goalobjectNoBooked delivery goal (Google Ad Manager goal)
delivery_goal.periodenumNoValues: DAILY, MONTHLY, TOTAL, LIFETIME
delivery_goal.unitenumNoValues: IMPRESSIONS, VIEWABLE_IMPRESSIONS, CLICKS, CONVERSIONS, COMPLETED_VIEWS
delivery_goal.quantitynumberNo
creative_sizesAdsSize[]NoExpected creative sizes (Google Ad Manager creativePlaceholders)
creative_sizes[].widthnumberYes
creative_sizes[].heightnumberYes
conversion_trackingAdsConversionTracking[]NoConversion trackers counted for this group (DV360 Floodlight activities, Pinterest conversion tag)
conversion_tracking[].identifierstringYesIntegration's conversion tracker ID (Floodlight activity ID, conversion tag ID)
conversion_tracking[].typeenumNoValues: FLOODLIGHT_ACTIVITY, CONVERSION_TAG, PIXEL, OTHER
conversion_tracking[].post_click_window_daysnumberNoDays after a click in which a conversion is counted
conversion_tracking[].post_view_window_daysnumberNoDays after a view in which a conversion is counted

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/ads/5de520f96e439b002043d8dc/group/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?