Skip to content

TargetingSpec.md

Latest commit

 

History

History
56 lines (50 loc) · 3.92 KB

TargetingSpec.md

File metadata and controls

56 lines (50 loc) · 3.92 KB
Raw

Zernio::TargetingSpec

Properties

Name Type Description Notes
countries Array<String> ISO 3166-1 alpha-2 country codes (e.g. ['US']). [optional]
regions Array<CreateStandaloneAdRequestZipsInner> Region/state targeting. `key` is the platform location ID from /v1/ads/targeting/search?dimension=geo&geoType=region. [optional]
cities Array<TargetingSpecCitiesInner> City targeting. Optional `radius` + `distance_unit` extend beyond the city limits; both must be set together or both omitted. `radius` is only honoured on platforms whose capability map allows city radius (Meta). [optional]
zips Array<CreateStandaloneAdRequestZipsInner> Postal/ZIP targeting. `key` is the platform's postal location ID (e.g. Meta `US:94304`). Supported on Meta, Google, TikTok, Pinterest, X. [optional]
metros Array<CreateStandaloneAdRequestZipsInner> DMA / metro-area targeting. `key` is the platform's metro ID (e.g. Meta `DMA:807`). [optional]
custom_locations Array<TargetingSpecCustomLocationsInner> Point-radius (lat/lng) targeting (Meta custom_locations / Google proximity). Honoured only where the capability map allows radius (Meta). [optional]
excluded_locations TargetingSpecExcludedLocations [optional]
age_min Integer [optional]
age_max Integer [optional]
gender String Restrict by gender. 'all' (default) targets everyone. [optional]
income_tier String Normalized household-income tier (ZIP/percentile based). Meta and TikTok express all four. Google maps only `top_10` (its INCOME_RANGE_90_UP); other tiers on Google, and any income tier on LinkedIn / X / Pinterest, are rejected. On Meta, income/zip targeting requires the relevant `specialAdCategories` to be unset (housing/employment/credit ads cannot use it). [optional]
languages Array<String> Language codes (e.g. ['en']). [optional]
interests Array<CreateStandaloneAdRequestBehaviorsInner> Interest entities from /v1/ads/targeting/search?dimension=interest. Each carries the platform's opaque id. [optional]
behaviors Array<CreateStandaloneAdRequestBehaviorsInner> Behaviour entities from /v1/ads/targeting/search?dimension=behavior. Supported on Meta and TikTok. [optional]
industries Array<String> LinkedIn B2B only. Industry URN id fragments. [optional]
company_sizes Array<String> LinkedIn B2B only. [optional]
seniorities Array<String> LinkedIn B2B only. [optional]
job_functions Array<String> LinkedIn B2B only. [optional]
audience_include Array<String> Platform audience IDs to include. [optional]
audience_exclude Array<String> Platform audience IDs to exclude. [optional]

Example

require 'zernio-sdk'

instance = Zernio::TargetingSpec.new(
  countries: null,
  regions: null,
  cities: null,
  zips: null,
  metros: null,
  custom_locations: null,
  excluded_locations: null,
  age_min: null,
  age_max: null,
  gender: null,
  income_tier: null,
  languages: null,
  interests: null,
  behaviors: null,
  industries: null,
  company_sizes: null,
  seniorities: null,
  job_functions: null,
  audience_include: null,
  audience_exclude: null
)