AdRoll
AdRoll is a digital marketing platform for managing advertising campaigns, audiences, account-based marketing, and performance reporting.
Tools (51)
Create Ad
Create an ad for an advertisable, optionally creating nested assets that do not have EIDs in the same operation.
Inputs: name, type, width, assets, height, status, subtype, read_only, is_dynamic, advertisable, ad_parameters, do_not_forward, multiple_products, is_multi_share_optimized
Create Adgroup
Create a web-retargeting adgroup under a Campaign v3 campaign.
Inputs: adgroup, campaign_id
Create Advertisable
Create an advertisable in an organization owned by the connected account.
Inputs: url, name, country_code, organization, set_as_default
Create Asset
Create an asset. File content is passed exactly as a base64 string in the JSON request body.
Inputs: file, name, type, subtype, description
Create Campaign
Create a web-retargeting campaign under a Campaign v3 strategy.
Inputs: campaign, strategy_id
Create Marketplace Mapping
Create a marketplace-to-merchant mapping. Both advertisables must be accessible and marketplace-enabled by AdRoll.
Inputs: shop_id, external_shop_id, dest_advertisable, source_advertisable
Create Rule
Create a pixel rule. AdRoll may normalize the requested order; use the returned value as authoritative. CRM-data rules require a CSV containing at least 100 emails, but the provider does not document its exact file encoding and header contract.
Inputs: name, type, order, pixel, source, pattern, csv_file, duration, display_name, match_method
Create Segment
Create one audience segment for an advertiser and seed it with user identifiers.
Inputs: name, users, segment_type, advertiser_id, duration_days, is_conversion, conversion_value, general_exclusion_type, salesforce_company_list_id
Create Strategy
Create a Campaign v3 strategy under an advertisable.
Inputs: strategy, advertisable_id
Delete Segment
Delete one existing audience segment.
Inputs: segment_id
Edit Advertisable
Edit the name, URL, or country code of an accessible advertisable.
Inputs: url, name, country_code, advertisable_id
Get Ad
Retrieve an ad by its Ad API resource eid, not its Reporting adroll_ad_eid.
Inputs: eid
Get Adgroup
Fetch one Campaign v3 adgroup by EID.
Inputs: adgroup_id
Get Adgroup Geotargets
Fetch a Campaign v3 adgroup and return its geotargets. A missing or null geotarget field is returned as an empty list.
Inputs: adgroup_id
Get Advertisable
Fetch an advertisable by EID. AdRoll returns matching records as an array.
Inputs: advertisable_id
Get Advertisable Pixel
Fetch the active pixel for an accessible advertisable.
Inputs: advertisable_id
Get Asset
Retrieve an asset by its EID.
Inputs: eid
Get Campaign
Fetch one Campaign v3 campaign by advertisable and campaign EID.
Inputs: campaign_id, advertisable_id
Get Consent Banner
Fetch an advertisable's consent banner state. banner_declined is available only to advertisables in countries not covered by GDPR.
Inputs: advertisable_id
Get Current Organization
Return the connected account's current organization from Reporting GraphQL, including nested advertisables.
Get Marketplace Mappings
Retrieve marketplace mappings for a parent marketplace advertisable and child merchant advertisable. Both must be accessible and marketplace-enabled by AdRoll.
Inputs: dest_advertisable, source_advertisable
Get Pixel
Fetch a pixel by EID.
Inputs: pixel_id
Get Pixel Segments
Fetch segments associated with a pixel. Ittes AI always sends page 0 when omitted; per_page remains omitted unless supplied, preserving the provider's unpaginated response behavior.
Inputs: page, per_page, pixel_id
Get Rule
Fetch a rule by EID, including its generated segments when returned.
Inputs: rule_id
Get Rule Segments
Fetch the segments associated with a specific rule.
Inputs: rule_id
Get Segment
Return one audience segment, optionally including general-exclusion attributes or an inactive segment.
Inputs: segment_id, include_general_exclusion_attributes
Get Strategy
Fetch one Campaign v3 strategy by EID.
Inputs: strategy_id
Get Cross-Device Opt-In
Retrieve an accessible advertisable's cross-device graph opt-in setting.
Inputs: advertisable_id
List Adgroups
Return Reporting GraphQL adgroups for one campaign. Omitted collection filters preserve provider defaults; supplied filters constrain active state or included/excluded statuses.
Inputs: statuses, is_active, campaign_id, exclude_statuses
List Ads
Retrieve one numbered page of ads for an advertisable, or set all='true' to request all matching ads. Omitted pagination inputs send page 1 with 10 records.
Inputs: all, page, sort, page_size, advertisable
List Advertisables
Fetch one numbered page of advertisables associated with an organization; omitted pagination inputs send page 1 with 10 records.
Inputs: page, per_page, organization_id
List Assets
Retrieve one numbered page of assets belonging to an advertisable; omitted pagination inputs send page 1 with 10 records.
Inputs: page, sort, page_size, advertisable
List Campaigns
Return Reporting GraphQL campaigns for one advertisable. Omitted collection filters preserve provider defaults; supplied filters support state, classification, channel, source, funnel, objective, and tags.
Inputs: types, sources, channels, statuses, abm_types, is_active, use_cases, objectives, tag_prefixes, exclude_types, funnel_stages, advertisable_id, exclude_sources, targeting_types, exclude_channels, exclude_statuses, exclude_abm_types, exclude_use_cases, exclude_funnel_stages, exclude_targeting_types
List Segments
Return audience segments for an advertiser, optionally filtered by segment type.
Inputs: omit_fields, segment_type, advertiser_id
List Strategies
Return strategies for an advertisable. Cursor, paginate, and include_drafts are omitted unless supplied; the response has no pagination metadata.
Inputs: cursor, paginate, include_drafts, advertisable_id
Query Reporting Adgroups
Query adgroups by campaign, advertisable, one EID, or many EIDs with nested relations and optional date/currency metrics.
Inputs: eid, eids, currency, end_date, statuses, is_active, past_days, parent_eid, start_date, lookup_mode, include_metrics, exclude_statuses, include_inactive_relations
Query Reporting Ads
Query ads by adgroup, advertisable, or Reporting EIDs (`adroll_ad_eid` from the Ad API), with optional date/currency metrics; parent lookup preserves adgroup relationship state.
Inputs: eid, eids, types, width, height, currency, end_date, statuses, is_active, past_days, parent_eid, start_date, lookup_mode, include_metrics, created_date_before, updated_date_before, created_date_after_or_on, updated_date_after_or_on, include_inactive_relations
Query Reporting Advertisables
Query advertisables by user, organization, one EID, or many EIDs with nested relations and optional date/currency metrics.
Inputs: eid, eids, currency, end_date, statuses, is_active, past_days, parent_eid, start_date, lookup_mode, include_metrics, include_inactive_relations
Query Reporting Campaigns
Query campaigns by advertisable, organization, one EID, or many EIDs with nested relations and optional date/currency metrics.
Inputs: eid, eids, types, sources, channels, currency, end_date, statuses, abm_types, is_active, past_days, use_cases, objectives, parent_eid, start_date, lookup_mode, tag_prefixes, exclude_types, funnel_stages, exclude_sources, include_metrics, targeting_types, exclude_channels, exclude_statuses, exclude_abm_types, exclude_use_cases, exclude_funnel_stages, exclude_targeting_types, include_inactive_relations
Query Reporting Organizations
Query the current AdRoll organization or organizations by one or many EIDs, including nested advertisables.
Inputs: eid, eids, currency, end_date, statuses, is_active, past_days, parent_eid, start_date, lookup_mode, include_metrics, include_inactive_relations
Run Reporting GraphQL Query
Execute one AdRoll Reporting GraphQL document and preserve complete or partial provider data, errors, request ID, and version.
Inputs: query, variables, operation_name
Query Reporting Segments
Query direct segment metadata or parent-scoped campaign/adgroup audiences with relationship state and optional date-scoped audience-size metrics.
Inputs: eid, eids, currency, end_date, statuses, is_active, past_days, parent_eid, start_date, lookup_mode, is_conversion, include_metrics, include_inactive_relations
Run Performance Report
Return current AdRoll GraphQL delivery metrics for advertisables, campaigns, adgroups, or ads, optionally with attribution metrics, as an aggregate summary, aggregate daily rows, or per-entity summaries.
Inputs: level, ad_ids, currency, end_date, past_days, start_date, adgroup_ids, data_format, campaign_ids, advertisable_ids, include_attributions
Search Geotargets
Search AdRoll geotargets by a location-name prefix and optional types. Use count and page to iterate through results until an empty items list is returned.
Inputs: page, count, geo_types, starts_with
Set Campaign Status
Pause or activate one campaign through the Campaign v3 edit operation.
Inputs: status, campaign_id
Update Adgroup
Edit one web-retargeting or web-prospecting Campaign v3 adgroup.
Inputs: adgroup, adgroup_id
Update Campaign
Edit one Campaign v3 web-retargeting or web-prospecting campaign. Retargeting nested adgroups are inferred as create-or-edit by eid; prospecting nested adgroups must include eid.
Inputs: campaign, campaign_id
Update Consent Banner
Create or update an advertisable's consent banner configuration. AdRoll permits banner_declined only for advertisables in countries not covered by GDPR.
Inputs: state, advertisable_id
Update Segment
Update audience-segment information and submit its user-record payload.
Inputs: name, users, segment_id, duration_days, conversion_value, general_exclusion_type, salesforce_company_list_id
Update Strategy
Edit a Campaign v3 strategy containing only web-retargeting or web-prospecting campaigns using a complete campaign set. Existing campaigns omitted from the set are deleted; nested campaigns with an EID are edited, and new web-retargeting campaigns can be created.
Inputs: strategy, strategy_id, confirm_complete_web_campaign_set
Update Cross-Device Opt-In
Update an accessible advertisable's cross-device graph opt-in setting; provider feature access is required.
Inputs: value, advertisable_id