Skip to content
AdCrunch
Esc
↑↓navigate↵open⌘Jpreview
On this page

list_ad_groups

List the ad groups of your ad accounts — Meta ad sets, TikTok ad groups and Google Ads ad groups — as AdCrunch stores them.

Ask for the ad groups of a campaign or of an ad account. Each provider has its own word for this level: an ad set on Meta, and an ad group on TikTok and on Google Ads. The agent reads all three with this tool.

Show the ad sets of the Spring sale campaign.

The agent lists the ad sets of that campaign. You see the name, the status and the budget of each ad set. When the campaign carries the budget, each ad set shows no budget of its own. Read your accounts shows the full job.

Reference

Available on: Meta TikTok Google Ads

List the ad groups of your ad accounts: Meta ad sets, TikTok ad groups and Google Ads ad groups. Each row keeps the word of its provider in type: adset, adgroup or ad_group. Send campaignId to list the ad groups of one campaign. budget is in whole units of currency (50 is 50.00): the unit of spend in query_insights, and the unit that meta_update_budget takes. An ad group whose campaign carries the budget has a null budget and a budgetLevel of campaign: read the campaign with list_campaigns for the amount. Each Google Ads ad group is of this kind. A Performance Max campaign has no ad groups: use list_asset_groups for it. It reads what AdCrunch stored at the last ingestion, not what the provider holds now. To ask the provider now, use meta_list_adsets, tiktok_list_adgroups or gads_list_ad_groups. Without advertiserId, it lists the ad groups of each ad account of your organization. Use list_advertisers to find the ids of your ad accounts. The row that AdCrunch stored last comes first. The answer holds at most limit rows (default 100, maximum 500). When it carries nextCursor, more rows exist: call this tool again with the same arguments and cursor set to that value. When it carries no nextCursor, you have every row.

Input

Argument Type Required Description
advertiserId string no List one ad account, prefixed acc_. Omit it to list every ad account of your organization. An ad account that your organization does not own gives an empty list. list_advertisers gives the ids.
ids array of string no List only these ids. An id is the bare id that the provider gives, the id of a row.
provider one of meta, tiktok, snapchat, gads, dv360, x, openai no List the ad accounts of one provider. Omit it to list every provider.
status one of ACTIVE, PAUSED, DELETED, ARCHIVED no List one status, the same for each provider. TikTok ENABLE and DISABLE are ACTIVE and PAUSED here.
cursor string, at least 1 character no The nextCursor of the previous page. Omit it to get the first page. Send it with no change, and with the same filters as the request that answered it: a cursor from a different query gets a 400 invalid_cursor. Do not build or change a cursor.
limit integer, 1 to 500 no The greatest number of rows on the page, from 1 to 500. The default is 100. A greater value gets a 400, with error of invalid_request. Default: 100.
campaignId string no List only what this campaign holds. Send the bare id that the provider gives: the id of a row of list_campaigns, and the campaignId of each row here.

Output

A successful call returns this object in structuredContent.

Field Type Always present Description
adGroups array of object yes The ad groups that match, as AdCrunch stored them. An empty array means that no ad group matches, or that your organization does not own the advertiser.
adGroups[].advertiserId string yes The advertiser that owns it, prefixed acc_.
adGroups[].createdAt number or null yes When AdCrunch first stored this row. Null when the row was read live: AdCrunch holds no copy of it. createdAt, updatedAt and deletedAt are AdCrunch’s own times, so all three are null together on a live row.
adGroups[].createdTime number or null yes When the provider created the entity. This is the provider’s own time, so a live row carries it. Null where the provider reports none.
adGroups[].currency string or null yes The account currency, ISO 4217. Every row of one advertiser carries the same one. Null when AdCrunch does not know it yet.
adGroups[].deletedAt number or null yes When AdCrunch marked the row deleted. A listing never carries a deleted row, so this is null.
adGroups[].id string yes The id the provider gives, with no prefix. It is unique for one provider and one type, and it may legitimately recur across two types or two providers.
adGroups[].name string yes The name at the provider.
adGroups[].path string yes The ancestors and this entity, ids joined by /, oldest first. This is what makes a subtree one string comparison.
adGroups[].provider string yes The ad platform: meta, tiktok or gads. Those three are the providers whose entities AdCrunch reads, and https://docs.adcrunch.dev/connect/providers says how deep each one goes.
adGroups[].status one of ACTIVE, PAUSED, DELETED, ARCHIVED yes The status, normalized across the providers. TikTok ENABLE and DISABLE read here as ACTIVE and PAUSED.
adGroups[].updatedAt number or null yes When AdCrunch last rewrote this row. Null if it never changed.
adGroups[].updatedTime number or null yes When the provider last edited the entity. Null where the provider reports none.
adGroups[].budget number or null yes The budget this entity carries itself, in whole units of currency: 50 is 50.00, never 50 cents. It is the unit of spend on an Insight, so a budget and a spend compare directly. AdCrunch converts each provider’s own unit — Meta’s minor unit, TikTok’s whole units and Google Ads’ micros — so every provider answers the same unit here. Null when the entity carries no budget of its own: budgetLevel then says where its budget lives. A campaign answers a budget only when its budgetLevel is campaign, so a budget always paces delivery at the level that answers it. Null also when AdCrunch does not know the account currency yet, because nobody can read a budget with no currency. At Google Ads one budget may be shared by several campaigns, and each of them answers the whole shared amount. A stored budget can be older than the rest of the row. Meta does not mark a campaign changed when only its budget changes, and AdCrunch does not yet follow a Google Ads budget change, so the ingestion can miss a budget edited in the provider’s own interface. A live read answers the budget the provider holds now. AdCrunch takes a budget in the same whole units when it writes one, so a budget you read here goes back with no conversion.
adGroups[].budgetLevel one of campaign, ad_group or null yes Where the budget of this entity’s campaign lives. campaign when the campaign carries it — Meta Advantage campaign budget, TikTok Campaign Budget Optimization, and every Google Ads campaign. ad_group when each ad group carries its own. Null on a TikTok campaign whose payload does not say.
adGroups[].budgetType one of daily, lifetime or null yes daily for a budget spent each day, lifetime for one spent over the whole life of the entity. Null exactly when budget has no provider value to describe.
adGroups[].campaignId string or null yes The campaign it belongs to, as the bare id its provider gives. Null only when the stored path of the row names no campaign.
adGroups[].type string yes The type the provider uses, kept as the provider writes it: adset at Meta, adgroup at TikTok and ad_group at Google Ads. The resource names the concept, and the row keeps the provider’s own word, because a Meta adset and a Google Ads ad_group are not the same object.
nextCursor string no Send this value as cursor to get the next page. It is absent on the last page.

Failure codes

A failed call has isError set, and structuredContent.error holds one of these codes. Errors describes the shape of a failed call.

  • invalid_cursor
  • forbidden
  • invalid_request
  • internal_error

Scope

The token must hold observe:read. Auth & scopes lists each scope.

Annotations

A client reads these hints. A hint that the tool does not declare has the default value of the MCP specification.

  • Read-only. The tool changes nothing.
  • Closed world. The tool reads and writes the data of AdCrunch only.

Example

The arguments:

{
  "campaignId": "120210000000000"
}

The result, in structuredContent:

{
  "adGroups": [
    {
      "advertiserId": "acc_1203456789012345",
      "budget": null,
      "budgetLevel": "campaign",
      "budgetType": null,
      "campaignId": "120210000000000",
      "createdAt": 1789610000000,
      "createdTime": 1789600000000,
      "currency": "EUR",
      "deletedAt": null,
      "id": "120210000000001",
      "name": "Women 25-44, France",
      "path": "120210000000000/120210000000001",
      "provider": "meta",
      "status": "ACTIVE",
      "type": "adset",
      "updatedAt": null,
      "updatedTime": 1789900000000
    }
  ]
}

Was this page helpful?