Skip to content

input-reference.md

Latest commit

 

History

History
30 lines (26 loc) · 2.7 KB

input-reference.md

File metadata and controls

30 lines (26 loc) · 2.7 KB
Raw

Input reference

Choose at least one search target. query, pageId, and pageUrl are alternative ways to select the advertiser or search phrase; use a single target for predictable results.

Field Type Required Example Description
query string Conditional ikea Brand, advertiser, product, or exact phrase. Required when no page target is supplied.
pageId string Conditional 244033170035 Numeric Facebook Page ID. Use pageUrl for a URL or alias.
pageUrl string Conditional https://www.facebook.com/IKEASpain Public Facebook page URL or exact alias.
country string No ES Two-letter Meta market code; default ES. Use ALL for every available country.
activeStatus enum No ACTIVE ACTIVE, INACTIVE, or ALL; default ACTIVE.
mediaType enum No ALL ALL, IMAGE, VIDEO, or NONE; default ALL.
adType enum No ALL ALL, EMPLOYMENT_ADS, FINANCIAL_PRODUCTS_AND_SERVICES_ADS, HOUSING_ADS, or POLITICAL_AND_ISSUE_ADS; default ALL. Availability depends on the market.
publisherPlatforms array of enum No ["INSTAGRAM"] Empty includes all reported placements. Values include Facebook, Instagram, Messenger, Audience Network, Threads, WhatsApp, Oculus, and Streaming Services.
contentLanguages array of string No ["es"] Meta language codes selected from the input dropdown; empty includes every language.
startDate string No 2026-08-01 Earliest ad start date, formatted YYYY-MM-DD.
endDate string No 2026-09-30 Latest ad start date, formatted YYYY-MM-DD.
maxAds integer No 100 Unique ads to save; default 100, minimum 1, maximum 5,000.
maxPages integer No 100 Pagination safety limit; default 100, minimum 1, maximum 500.
includeDetails boolean No false When true, request optional advertiser transparency, audience, payer/beneficiary, and page-profile details.
detailsLimit integer No 25 Maximum ads to enrich when includeDetails is true; default 25, minimum 1, maximum 5,000.

Validation and limits

  • At least one of query, pageId, or pageUrl must be non-empty.
  • country must be ALL or a two-letter alphabetic code; full country names are not accepted.
  • Dates use YYYY-MM-DD; the Actor filters on the ad's reported start date.
  • publisherPlatforms and contentLanguages are multi-select arrays with unique values.
  • Results are deduplicated by ad_archive_id before Dataset delivery.
  • page_budget termination means the page limit was reached before the requested ad cap; exhausted means the source reported no next page.