Ad groups
An ad group belongs to one campaign. It contains a click bid, contextual
hints, and one or more ads. Send billing_event_type: "click"; no other
billing event type is accepted.
The ad-group object
Section titled “The ad-group object”{ "id": "adgrp_67f480455c61f3e66f163c23", "campaign_id": "cmpn_67f480125c61f3e66f163c22", "name": "Productivity shoppers", "description": "People exploring productivity tools.", "status": "active", "bidding_config": { "billing_event_type": "click", "max_bid_micros": 250000 }, "context_hints": ["productivity", "team collaboration"], "created_at": 1744070469, "updated_at": 1744070469}id- Ad-group ID, prefixed with
adgrp_. campaign_id- Parent campaign ID.
name- Internal ad-group name.
description- Optional ad-group description.
statusactive,paused, orarchived.bidding_config.max_bid_micros- Maximum bid for one click, in USD micros.
context_hints- Descriptions of contexts in which the ads are relevant.
created_at- Creation time as a Unix timestamp in seconds.
updated_at- Last update time as a Unix timestamp in seconds.
Create an ad group
Section titled “Create an ad group”POST /ad_groups
campaign_idRequired- Parent campaign ID in the current ad account.
nameRequired- From 3 to 1,000 characters with at least one non-space character.
bidding_configRequired- The complete bidding object.
bidding_config.billing_event_typeRequired- Elo recognizes
clickandimpression, but rejects values other thanclick. bidding_config.max_bid_microsRequired- From
1to100000000. description- Ad-group description.
context_hints- Up to 25 hints, each from 1 to 100 characters.
statusRequiredactiveorpaused.
max_bid_micros is the maximum bid for one click. For example, 250000
represents $0.25.
curl -X POST "https://api.elo.ad/v1/adm/ad_groups" \ -H "Authorization: Bearer $ELO_ADS_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "campaign_id": "cmpn_67f480125c61f3e66f163c22", "name": "Productivity shoppers", "description": "People exploring productivity tools.", "status": "paused", "context_hints": ["productivity", "team collaboration"], "bidding_config": { "billing_event_type": "click", "max_bid_micros": 250000 } }'List ad groups
Section titled “List ad groups”GET /ad_groups
The endpoint supports the shared limit, after, before, and order
pagination parameters. campaign_id is required.
curl "https://api.elo.ad/v1/adm/ad_groups?campaign_id=cmpn_67f480125c61f3e66f163c22&limit=20" \ -H "Authorization: Bearer $ELO_ADS_API_KEY"Retrieve an ad group
Section titled “Retrieve an ad group”GET /ad_groups/{ad_group_id}
curl "https://api.elo.ad/v1/adm/ad_groups/adgrp_67f480455c61f3e66f163c23" \ -H "Authorization: Bearer $ELO_ADS_API_KEY"Update an ad group
Section titled “Update an ad group”POST /ad_groups/{ad_group_id}
You can update name, description, bidding_config, context_hints, and status.
Send the complete bidding_config object when changing the bid. Set
description to null to clear it. status accepts active, paused, or
archived.
The parent campaign cannot be changed.
curl -X POST "https://api.elo.ad/v1/adm/ad_groups/adgrp_67f480455c61f3e66f163c23" \ -H "Authorization: Bearer $ELO_ADS_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "context_hints": ["productivity", "workflow automation"], "bidding_config": { "billing_event_type": "click", "max_bid_micros": 300000 } }'Change ad-group state
Section titled “Change ad-group state”Each endpoint returns the updated ad-group object.
POST /ad_groups/{ad_group_id}/activatePOST /ad_groups/{ad_group_id}/pausePOST /ad_groups/{ad_group_id}/archive
curl -X POST "https://api.elo.ad/v1/adm/ad_groups/adgrp_67f480455c61f3e66f163c23/activate" \ -H "Authorization: Bearer $ELO_ADS_API_KEY"Archiving is permanent. Repeating the archive action succeeds, but other
updates and state changes on an archived ad group return 422.