Ad Groups

Search Targeting Options

Changed on

Searches the ad platform's targeting taxonomy for options to target an ad group with. Each result comes back in the exact shape the ad-group body accepts for its type, so it can be used in detailed_targeting, regions, or languages as-is.

get/ad_groups/targeting_options

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/ad_groups/targeting_options
  • Auth: HTTP bearer

Query parameters

account_idstring

Account to search on behalf of. Defaults to the authenticated account.

platform'meta' required

The ad network whose targeting taxonomy to search.

querystring

The search term. Blank browses the small fixed lists (behaviors, browse demographic categories, and languages); interests, work employers, job titles, schools, majors, and locations return nothing without one.

typesstring[]

Kinds of targeting options to search. Defaults to all of them.

[
  "interests"
]
location_typesstring[]

Narrow location results to these kinds of places. Only applies when types includes locations.

[
  "country"
]
countrystring

Narrow location results to one country, as an ISO 3166-1 code such as US. Only applies when types includes locations.

limitinteger

Maximum number of results per requested type.

special_ad_categoriesstring[]

The campaign's declared special ad categories. Under housing, employment, or financial_products the ad platform allows interests only, drawn from a short approved list, so results are narrowed to what such a campaign can launch with and other kinds return nothing. Blank query browses that approved list instead of the usual fixed lists.

[
  "housing"
]

Response

types narrows the search and accepts a comma-separated list

Example response

{
  "data": [
    {
      "audience_size_lower_bound": 18400000,
      "audience_size_upper_bound": 21700000,
      "behavior_type": "video",
      "description": "People who have expressed an interest in or like pages related to car washing and detailing.",
      "id": "6003193685204",
      "name": "Car wash",
      "type": "interests"
    }
  ]
}

Changes

  • 42ce5c13e53bRevision changes
    • info

      added the new optional query request parameter special_ad_categories

  • 6a23760847c8Revision changes
    • warning

      added the new district enum value to the /// response property for the response status

    • warning

      added the new dma enum value to the /// response property for the response status

    • warning

      added the new medium_geo_area enum value to the /// response property for the response status

    • warning

      added the new neighborhood enum value to the /// response property for the response status

    • warning

      added the new subcity enum value to the /// response property for the response status

    • info

      added the enum value medium_geo_area to the property items/ of the query request parameter location_types

    • info

      added the enum value neighborhood to the property items/ of the query request parameter location_types

    • info

      added the enum value subcity to the property items/ of the query request parameter location_types

    • info

      added the required property /// to the response with the status