Search targeting options

GET 
/ad-publishing/facebook/targeting/search

Search Facebook targeting options for ad set audience building. type selects which taxonomy is searched and determines the response shape: geolocation returns places, interest returns interests, behaviours, and demographics, and language returns locales. Geolocation and interest results are passed through from Facebook, so their fields are snake_case.

Request

Version stringrequired

API Version

Available optionsv3

locationId string

Location identifier

type stringrequired

Targeting search type

Available optionsgeolocationinterestlanguage

query stringrequired

Search query string

searchType string

Specific search subtype

application/json

Matching targeting options. The item shape follows the requested type: geo results for geolocation, interest/behaviour/demographic results for interest (sorted by estimated reach, largest first), and locales for language.

application/json

Schema

Schema

• Array [
oneOf
• FacebookGeoTargetingSearchResultDTO
• FacebookInterestTargetingSearchResultDTO
• FacebookLanguageTargetingSearchResultDTO

keystringrequired

Facebook geo key, used as the targeting id

namestringrequired

Location name

typestringrequired

Location granularity

Available optionscountryregioncitysubcityneighborhoodzipgeo_marketelectoral_district

country_codestring

ISO country code

country_namestring

Country name

regionstring

Region or state name

region_idnumber

Numeric region id

supports_regionboolean

Whether region-level targeting is available here

supports_cityboolean

Whether city-level targeting is available here

geo_hierarchy_levelstring

Position in the geo hierarchy. Absent on plain cities.

geo_hierarchy_namestring

Hierarchy label. Can differ from geo_hierarchy_level — a SUBCITY reports CITY here.

• ]

Example (auto)

[
  {
    "key": "1045272",
    "name": "Thane",
    "type": "city",
    "country_code": "IN",
    "country_name": "India",
    "region": "Maharashtra",
    "region_id": 1735,
    "supports_region": true,
    "supports_city": true,
    "geo_hierarchy_level": "NEIGHBORHOOD",
    "geo_hierarchy_name": "CITY"
  },
  {
    "id": "6003195226065",
    "name": "Tabletop game",
    "type": "interests",
    "subText": "interests",
    "path": [
      "Interests",
      "Technology",
      "Computers",
      "Tablet computers"
    ],
    "description": "People who primarily access Facebook using a tablet",
    "audience_size_lower_bound": 512619285,
    "audience_size_upper_bound": 602840280,
    "topic": "Technology",
    "disambiguation_category": "Computers (Brand)",
    "real_time_cluster": false
  },
  {
    "key": 1004,
    "name": "Chinese (All)"
  }
]