Nextdoor

App · 21 actions

Run your Nextdoor ads: see results for advertisers, campaigns, ad groups and ads, create, rename, pause and archive campaigns, pause or run ad groups and ads, and build reports.

Actions

ActionWhat it does
Archive campaignArchive a campaign so it stops for good and leaves the campaign list.
Archive reportArchive a report so it leaves the advertiser's report list.
Create campaignStart a campaign with a name and goal.
Create reportAsk Nextdoor to build a spreadsheet of results, broken down by day, campaign, ad or audience.
Get accountGet the Ads Manager user the connection acts as, its business profile, and the advertisers it can reach with its role on each.
Get adGet one ad with its ad group, creative and status.
Get ad groupGet one ad group with its budget, bid, placements, targeting, dates and status.
Get ad group resultsGet an ad group's totals for a range of days: impressions, clicks, spend, results and conversions.
Get ad resultsGet an ad's totals for a range of days: impressions, clicks, spend, results and conversions.
Get advertiserGet an advertiser's details: name, website, address, currency, time zone, account balance and billing limit.
Get advertiser resultsGet an advertiser's totals across all its ads for a range of days: impressions, clicks, spend, results and conversions.
Get campaignGet one campaign with its objective, status and dates.
Get campaign resultsGet a campaign's totals for a range of days: impressions, clicks, spend, results and conversions.
Get reportGet a report's status and, once it is COMPLETED, the link to download it.
List ad groupsList an advertiser's ad groups, or one campaign's, with their budget, bid, dates and status.
List adsList an advertiser's ads, or those in one campaign or ad group, with their status.
List campaignsList an advertiser's campaigns with their objective and status.
Pause or run ad groupPause an ad group, or set it running again.
Pause or run campaignPause a campaign, or set it running again.
Rename campaignGive a campaign a new name.
Turn ad on or offTurn an ad off, or on again.

Archive campaign

Archive a campaign so it stops for good and leaves the campaign list. It can't be set running again.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

archivedtrue/false
True once archived
archived_idtext
The id of what was archived
Example output
{
  "archived": true,
  "archived_id": "2468013579"
}

Archive report

Archive a report so it leaves the advertiser's report list.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Report IDreport_idtextRequired
The report's id, from 'Create report' or an earlier step.

Outputs

archivedtrue/false
True once archived
archived_idtext
The id of what was archived
Example output
{
  "archived": true,
  "archived_id": "7788990011"
}

Create campaign

Start a campaign with a name and goal. It shows no ads and spends nothing until you add an ad group to it in Ads Manager.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
NamenametextRequired
The campaign's name.
GoalobjectivetextRequired
What the campaign is for.One of: AWARENESS, CONSIDERATION, CONVERSION, LEAD_GENERATION (Lead generation).
Detailed goalsub_objectivetext
A narrower goal within it, such as website visits for a consideration campaign.One of: BRAND_AWARENESS (Brand awareness), WEBSITE_VISITS (Website visits), LEAD_GENERATION (Lead generation), WEBSITE_CONVERSIONS (Website conversions), APP_INSTALL (App installs).

Outputs

campaignobject
The new campaign
Example output
{
  "campaign": {
    "advertiser_id": "1234567890",
    "created_at": "2026-09-28T17:00:00Z",
    "end_time": null,
    "id": "2468013579",
    "name": "Fall open house",
    "objective": "AWARENESS",
    "start_time": "2026-10-01T07:00:00Z",
    "status": "DRAFT",
    "sub_objective": "BRAND_AWARENESS",
    "updated_at": "2026-10-01T07:00:00Z",
    "user_status": "ACTIVE"
  }
}

Create report

Ask Nextdoor to build a spreadsheet of results, broken down by day, campaign, ad or audience. It takes a few minutes; 'Get report' gives its download link once its status is COMPLETED, and Nextdoor can also email it.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
NamenametextRequired
The report's name.
MeasuresmetricslistRequired
What to count, such as impressions, clicks and spend.One or more of: IMPRESSIONS, UNIQUE_IMPRESSIONS (Unique impressions), AVG_FREQUENCY (Average frequency), CLICKS, CTR (Click-through rate), SPEND, BILLABLE_SPEND (Billable spend), CPM (Cost per 1,000 impressions), CPC (Cost per click), CPA (Cost per action), and 18 more.
Break down bydimensionslist
How to split the rows, such as by day and campaign. Leave empty for one total row.One or more of: DAY, WEEK, MONTH, CAMPAIGN, CAMPAIGN_ID (Campaign ID), AD_GROUP (Ad group), AD_GROUP_ID (Ad group ID), AD, AD_ID (Ad ID), CREATIVE, and 19 more.
Report typereport_typetext
Which kind of report. Defaults to delivery and results.One of: DELIVERY_METRICS_REPORT (Delivery and results (default)), LEAD_GEN_FORM_RESULTS_REPORT (Lead form results), DCO_ENTITY_REPORT (Dynamic creative results). Default: DELIVERY_METRICS_REPORT.
Fromstart_timedate and time
The start of the period. Defaults to 7 days before its end.
Toend_timedate and time
The end of the period. Defaults to now.
File typeoutput_formattext
CSV or Excel. Defaults to CSV.One of: CSV (CSV (default)), XLSX (Excel (XLSX)). Default: CSV.
Email it torecipient_emailstext
Email addresses Nextdoor sends the finished report to, separated by commas. Leave empty to only download it.

Outputs

reportobject
The new report
Example output
{
  "report": {
    "advertiser_id": "1234567890",
    "dimensions": [
      "DAY",
      "CAMPAIGN"
    ],
    "download_url": "",
    "filters": [],
    "id": "7788990011",
    "metrics": [
      "IMPRESSIONS",
      "CLICKS",
      "SPEND"
    ],
    "name": "Weekly results",
    "output_format": "CSV",
    "status": "STARTED"
  }
}

Get account

Get the Ads Manager user the connection acts as, its business profile, and the advertisers it can reach with its role on each.

Inputs

None.

Outputs

advertiserslist
The advertisers the user can reach, with the user's role
countnumber
How many advertisers
profileobject
The business profile
userobject
The Ads Manager user
Example output
{
  "advertisers": [
    {
      "id": "1234567890",
      "role": "ADVERTISER_ADMIN"
    }
  ],
  "count": 1,
  "profile": {
    "associated_user_ids": [
      "u-1"
    ],
    "id": "9876543210",
    "is_ad_agency": false,
    "name": "Corner Bakery",
    "payment_profile_id": "555"
  },
  "user": {
    "advertisers_with_access": [
      {
        "id": "1234567890",
        "role": "ADVERTISER_ADMIN"
      }
    ],
    "email": "owner@example.com",
    "email_confirmed": true,
    "id": "u-1",
    "language_locale": "EN_US",
    "name": "Jo Bloggs"
  }
}

Get ad

Get one ad with its ad group, creative and status.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Ad IDad_idtextRequired
The ad's id, from 'List ads' or an earlier step.

Outputs

adobject
The ad
Example output
{
  "ad": {
    "adgroup_id": "1357924680",
    "advertiser_id": "1234567890",
    "created_at": "2026-09-28T17:10:00Z",
    "creative_id": "5544332211",
    "id": "1122334455",
    "name": "Fresh bread banner",
    "status": "ACTIVE",
    "updated_at": "2026-10-01T07:00:00Z",
    "user_status": "ACTIVE"
  }
}

Get ad group

Get one ad group with its budget, bid, placements, targeting, dates and status.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Ad groupad_group_idtextRequired
The ad group. Pick one, or give its id from an earlier step.

Outputs

ad_groupobject
The ad group
Example output
{
  "ad_group": {
    "advertiser_id": "1234567890",
    "bid": {
      "amount": null,
      "bid_strategy": "AUTO_BID",
      "pricing_type": "CPM"
    },
    "budget": {
      "amount": "20.00",
      "budget_type": "DAILY_CAP_MONEY"
    },
    "campaign_id": "2468013579",
    "created_at": "2026-09-28T17:05:00Z",
    "end_time": null,
    "frequency_caps": [],
    "id": "1357924680",
    "name": "Neighbors near the shop",
    "placements": [
      "FEED"
    ],
    "start_time": "2026-10-01T07:00:00Z",
    "status": "ACTIVE",
    "targeting": {
      "included_location_targeting_ids": [
        "94612"
      ]
    },
    "updated_at": "2026-10-01T07:00:00Z",
    "user_status": "ACTIVE"
  }
}

Get ad group results

Get an ad group's totals for a range of days: impressions, clicks, spend, results and conversions.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Ad groupad_group_idtextRequired
The ad group. Pick one, or give its id from an earlier step.
Fromstart_datedate
The first day to count. Defaults to 7 days before the last day.
Toend_datedate
The last day to count, included. Defaults to yesterday.

Outputs

statsobject
The results
Example output
{
  "stats": {
    "add_to_cart_conversions": 0,
    "add_to_wishlist_conversions": 0,
    "billable_spend": "150.00",
    "clicks": 180,
    "cost_per_result": "0.83",
    "cpc": "0.83",
    "cpm": "12.50",
    "ctr": 1.5,
    "end_time": "2026-11-05T00:00:00Z",
    "impressions": 12000,
    "initiate_checkout_conversions": 0,
    "lead_conversions": 2,
    "other_conversions": 0,
    "purchase_conversions": 4,
    "result": 180,
    "roas": 1.6,
    "search_conversions": 0,
    "sign_up_conversions": 0,
    "start_time": "2026-10-29T00:00:00Z",
    "subscribe_conversions": 0,
    "total_conversion_value": "240.00",
    "total_conversions": 6,
    "view_content_conversions": 0
  }
}

Get ad results

Get an ad's totals for a range of days: impressions, clicks, spend, results and conversions.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Ad IDad_idtextRequired
The ad's id, from 'List ads' or an earlier step.
Fromstart_datedate
The first day to count. Defaults to 7 days before the last day.
Toend_datedate
The last day to count, included. Defaults to yesterday.

Outputs

statsobject
The results
Example output
{
  "stats": {
    "add_to_cart_conversions": 0,
    "add_to_wishlist_conversions": 0,
    "billable_spend": "150.00",
    "clicks": 180,
    "cost_per_result": "0.83",
    "cpc": "0.83",
    "cpm": "12.50",
    "ctr": 1.5,
    "end_time": "2026-11-05T00:00:00Z",
    "impressions": 12000,
    "initiate_checkout_conversions": 0,
    "lead_conversions": 2,
    "other_conversions": 0,
    "purchase_conversions": 4,
    "result": 180,
    "roas": 1.6,
    "search_conversions": 0,
    "sign_up_conversions": 0,
    "start_time": "2026-10-29T00:00:00Z",
    "subscribe_conversions": 0,
    "total_conversion_value": "240.00",
    "total_conversions": 6,
    "view_content_conversions": 0
  }
}

Get advertiser

Get an advertiser's details: name, website, address, currency, time zone, account balance and billing limit.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.

Outputs

advertiserobject
The advertiser
Example output
{
  "advertiser": {
    "account_balance": "USD 0.00",
    "address": {
      "city": "Oakland",
      "coordinates": {
        "latitude": 37.8,
        "longitude": -122.27
      },
      "country": "US",
      "postal_code": "94612",
      "state": "CA",
      "street_address": "1 Main St",
      "street_address_2": ""
    },
    "bill_to_payment_profile_id": null,
    "billing_limit": "USD 500.00",
    "categories": [
      "Bakery"
    ],
    "country": "US",
    "currency": "USD",
    "id": "1234567890",
    "name": "Corner Bakery",
    "payment_profile_id": "555",
    "profile_id": "9876543210",
    "timezone": "America/Los_Angeles",
    "website_url": "https://example.com"
  }
}

Get advertiser results

Get an advertiser's totals across all its ads for a range of days: impressions, clicks, spend, results and conversions.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Fromstart_datedate
The first day to count. Defaults to 7 days before the last day.
Toend_datedate
The last day to count, included. Defaults to yesterday.

Outputs

statsobject
The results
Example output
{
  "stats": {
    "add_to_cart_conversions": 0,
    "add_to_wishlist_conversions": 0,
    "billable_spend": "150.00",
    "clicks": 180,
    "cost_per_result": "0.83",
    "cpc": "0.83",
    "cpm": "12.50",
    "ctr": 1.5,
    "end_time": "2026-11-05T00:00:00Z",
    "impressions": 12000,
    "initiate_checkout_conversions": 0,
    "lead_conversions": 2,
    "other_conversions": 0,
    "purchase_conversions": 4,
    "result": 180,
    "roas": 1.6,
    "search_conversions": 0,
    "sign_up_conversions": 0,
    "start_time": "2026-10-29T00:00:00Z",
    "subscribe_conversions": 0,
    "total_conversion_value": "240.00",
    "total_conversions": 6,
    "view_content_conversions": 0
  }
}

Get campaign

Get one campaign with its objective, status and dates.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.

Outputs

campaignobject
The campaign
Example output
{
  "campaign": {
    "advertiser_id": "1234567890",
    "created_at": "2026-09-28T17:00:00Z",
    "end_time": null,
    "id": "2468013579",
    "name": "Fall open house",
    "objective": "AWARENESS",
    "start_time": "2026-10-01T07:00:00Z",
    "status": "ACTIVE",
    "sub_objective": "BRAND_AWARENESS",
    "updated_at": "2026-10-01T07:00:00Z",
    "user_status": "ACTIVE"
  }
}

Get campaign results

Get a campaign's totals for a range of days: impressions, clicks, spend, results and conversions.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Fromstart_datedate
The first day to count. Defaults to 7 days before the last day.
Toend_datedate
The last day to count, included. Defaults to yesterday.

Outputs

statsobject
The results
Example output
{
  "stats": {
    "add_to_cart_conversions": 0,
    "add_to_wishlist_conversions": 0,
    "billable_spend": "150.00",
    "clicks": 180,
    "cost_per_result": "0.83",
    "cpc": "0.83",
    "cpm": "12.50",
    "ctr": 1.5,
    "end_time": "2026-11-05T00:00:00Z",
    "impressions": 12000,
    "initiate_checkout_conversions": 0,
    "lead_conversions": 2,
    "other_conversions": 0,
    "purchase_conversions": 4,
    "result": 180,
    "roas": 1.6,
    "search_conversions": 0,
    "sign_up_conversions": 0,
    "start_time": "2026-10-29T00:00:00Z",
    "subscribe_conversions": 0,
    "total_conversion_value": "240.00",
    "total_conversions": 6,
    "view_content_conversions": 0
  }
}

Get report

Get a report's status and, once it is COMPLETED, the link to download it.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Report IDreport_idtextRequired
The report's id, from 'Create report' or an earlier step.

Outputs

reportobject
The report
Example output
{
  "report": {
    "advertiser_id": "1234567890",
    "dimensions": [
      "DAY",
      "CAMPAIGN"
    ],
    "download_url": "https://ads.nextdoor.com/reports/7788990011.csv",
    "filters": [],
    "id": "7788990011",
    "metrics": [
      "IMPRESSIONS",
      "CLICKS",
      "SPEND"
    ],
    "name": "Weekly results",
    "output_format": "CSV",
    "status": "COMPLETED"
  }
}

List ad groups

List an advertiser's ad groups, or one campaign's, with their budget, bid, dates and status.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Campaigncampaign_idtext
Only this campaign's ad groups. Leave empty for all.
Include archivedinclude_archivedtrue/false
Also list archived ones. Off by default.
Page sizepage_sizenumber
How many to return, 1 to 500. Defaults to 100.From 1 to 500.
Next page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

adgroupslist
The ad groups
countnumber
How many came back in this page
next_cursortext
Give this as 'Next page cursor' to get the next page; empty when there are no more
Example output
{
  "adgroups": [
    {
      "advertiser_id": "1234567890",
      "bid": {
        "amount": null,
        "bid_strategy": "AUTO_BID",
        "pricing_type": "CPM"
      },
      "budget": {
        "amount": "20.00",
        "budget_type": "DAILY_CAP_MONEY"
      },
      "campaign_id": "2468013579",
      "created_at": "2026-09-28T17:05:00Z",
      "end_time": null,
      "frequency_caps": [],
      "id": "1357924680",
      "name": "Neighbors near the shop",
      "placements": [
        "FEED"
      ],
      "start_time": "2026-10-01T07:00:00Z",
      "status": "ACTIVE",
      "targeting": {
        "included_location_targeting_ids": [
          "94612"
        ]
      },
      "updated_at": "2026-10-01T07:00:00Z",
      "user_status": "ACTIVE"
    }
  ],
  "count": 1,
  "next_cursor": ""
}

List ads

List an advertiser's ads, or those in one campaign or ad group, with their status.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Campaign or ad group IDparent_idtext
Only the ads in this campaign or ad group, by its id. Leave empty for all.
Include archivedinclude_archivedtrue/false
Also list archived ones. Off by default.
Page sizepage_sizenumber
How many to return, 1 to 500. Defaults to 100.From 1 to 500.
Next page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

adslist
The ads
countnumber
How many came back in this page
next_cursortext
Give this as 'Next page cursor' to get the next page; empty when there are no more
Example output
{
  "ads": [
    {
      "adgroup_id": "1357924680",
      "advertiser_id": "1234567890",
      "created_at": "2026-09-28T17:10:00Z",
      "creative_id": "5544332211",
      "id": "1122334455",
      "name": "Fresh bread banner",
      "status": "ACTIVE",
      "updated_at": "2026-10-01T07:00:00Z",
      "user_status": "ACTIVE"
    }
  ],
  "count": 1,
  "next_cursor": ""
}

List campaigns

List an advertiser's campaigns with their objective and status.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Include archivedinclude_archivedtrue/false
Also list archived ones. Off by default.
Page sizepage_sizenumber
How many to return, 1 to 500. Defaults to 100.From 1 to 500.
Next page cursorcursortext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

campaignslist
The campaigns
countnumber
How many came back in this page
next_cursortext
Give this as 'Next page cursor' to get the next page; empty when there are no more
Example output
{
  "campaigns": [
    {
      "advertiser_id": "1234567890",
      "created_at": "2026-09-28T17:00:00Z",
      "end_time": null,
      "id": "2468013579",
      "name": "Fall open house",
      "objective": "AWARENESS",
      "start_time": "2026-10-01T07:00:00Z",
      "status": "ACTIVE",
      "sub_objective": "BRAND_AWARENESS",
      "updated_at": "2026-10-01T07:00:00Z",
      "user_status": "ACTIVE"
    }
  ],
  "count": 1,
  "next_cursor": ""
}

Pause or run ad group

Pause an ad group, or set it running again. Choosing the status it already has changes nothing.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Ad groupad_group_idtextRequired
The ad group. Pick one, or give its id from an earlier step.
Statususer_statustextRequired
Whether the ad group runs.One of: ACTIVE (Running (active)), PAUSED.

Outputs

ad_groupobject
The ad group
Example output
{
  "ad_group": {
    "advertiser_id": "1234567890",
    "bid": {
      "amount": null,
      "bid_strategy": "AUTO_BID",
      "pricing_type": "CPM"
    },
    "budget": {
      "amount": "20.00",
      "budget_type": "DAILY_CAP_MONEY"
    },
    "campaign_id": "2468013579",
    "created_at": "2026-09-28T17:05:00Z",
    "end_time": null,
    "frequency_caps": [],
    "id": "1357924680",
    "name": "Neighbors near the shop",
    "placements": [
      "FEED"
    ],
    "start_time": "2026-10-01T07:00:00Z",
    "status": "ACTIVE",
    "targeting": {
      "included_location_targeting_ids": [
        "94612"
      ]
    },
    "updated_at": "2026-10-01T07:00:00Z",
    "user_status": "PAUSED"
  }
}

Pause or run campaign

Pause a campaign, or set it running again. Choosing the status it already has changes nothing.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
Statususer_statustextRequired
Whether the campaign runs.One of: ACTIVE (Running (active)), PAUSED.

Outputs

campaignobject
The campaign
Example output
{
  "campaign": {
    "advertiser_id": "1234567890",
    "created_at": "2026-09-28T17:00:00Z",
    "end_time": null,
    "id": "2468013579",
    "name": "Fall open house",
    "objective": "AWARENESS",
    "start_time": "2026-10-01T07:00:00Z",
    "status": "PAUSED",
    "sub_objective": "BRAND_AWARENESS",
    "updated_at": "2026-10-01T07:00:00Z",
    "user_status": "PAUSED"
  }
}

Rename campaign

Give a campaign a new name. Nothing else about it changes; it is the only detail Nextdoor lets you edit.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Campaigncampaign_idtextRequired
The campaign. Pick one, or give its id from an earlier step.
New namenametextRequired
The campaign's new name.

Outputs

campaignobject
The campaign
Example output
{
  "campaign": {
    "advertiser_id": "1234567890",
    "created_at": "2026-09-28T17:00:00Z",
    "end_time": null,
    "id": "2468013579",
    "name": "Fall open house",
    "objective": "AWARENESS",
    "start_time": "2026-10-01T07:00:00Z",
    "status": "ACTIVE",
    "sub_objective": "BRAND_AWARENESS",
    "updated_at": "2026-10-01T07:00:00Z",
    "user_status": "ACTIVE"
  }
}

Turn ad on or off

Turn an ad off, or on again. Choosing the status it already has changes nothing.

Inputs

Advertiseradvertiser_idtextRequired
The advertiser (ad account) in Nextdoor Ads Manager. Pick one, or give its id from an earlier step.
Ad IDad_idtextRequired
The ad's id, from 'List ads' or an earlier step.
Statususer_statustextRequired
Whether the ad runs.One of: ACTIVE (Running (active)), INACTIVE (Off (inactive)).

Outputs

adobject
The ad
Example output
{
  "ad": {
    "adgroup_id": "1357924680",
    "advertiser_id": "1234567890",
    "created_at": "2026-09-28T17:10:00Z",
    "creative_id": "5544332211",
    "id": "1122334455",
    "name": "Fresh bread banner",
    "status": "INACTIVE",
    "updated_at": "2026-10-01T07:00:00Z",
    "user_status": "INACTIVE"
  }
}

On this page