Contents

AdGroupTargeting

The comprehensive audience and placement configuration for an ad group.

Declaration

object AdGroupTargeting

Properties

NameTypeDescription
countryAdGroupTargeting.Country

Country targeting. Include a country ID returned by the Geo Search API. Include only. Used with App Store campaigns. See TargetingData. Mutable.

adminAreaAdGroupTargeting.AdminArea

State or province targeting. Include admin area IDs returned by the Geo API. Include only. Used with App Store and Apple Maps campaigns. See TargetingData. Mutable.

localityAdGroupTargeting.Locality

City targeting. Include locality IDs returned by the Geo API. Include only. Used with App Store and Apple Maps campaigns. See TargetingData. Mutable.

postalCodeAdGroupTargeting.PostalCode

Postal code targeting. Include postal code IDs returned by the Geo API. Include only. Used with Apple Maps campaigns. See TargetingData. Mutable.

radiusAdGroupTargeting.Radius

Radius targeting, used with Apple Maps campaigns to restrict delivery to users within a given proximity of the brand’s locations. Valid values: CLOSE, MEDIUM, FAR. Include only. In practice, radius targeting is applied on MAPS_SEARCH_RESULTS campaigns and shouldn’t be combined with geo location targeting in the same ad group, but the API doesn’t enforce either constraint at the schema level. See TargetingData. Mutable.

deviceClassAdGroupTargeting.DeviceClass

Device class targeting. Valid values: IPHONE, IPAD. Include only. Used with App Store campaigns. See TargetingData. Mutable.

minAgeAdGroupTargeting.MinAge

Minimum age targeting. Sets the lower bound of the target age range. Minimum value is 18, maximum value is 64. Include only. Used with App Store campaigns. See TargetingData. Mutable.

maxAgeAdGroupTargeting.MaxAge

Maximum age targeting. Sets the upper bound of the target age range. Minimum value is 18, maximum value is 64. To target users 65 and older, omit maxAge or send include as null. Include only. Used with App Store campaigns. See TargetingData. Mutable.

genderAdGroupTargeting.Gender

Gender targeting, used with App Store campaigns. Valid values: M, F. Include only. See TargetingData. Mutable.

appCategoryAdGroupTargeting.AppCategory

App category targeting. Category ID 100 is a special value representing the same category as the promoted app. A value of 100 in include means you’re targeting apps in the same category as your app, and a value of 100 in exclude means you aren’t. Include and exclude supported. Used with App Store campaigns. See TargetingData. Mutable.

appDownloaderAdGroupTargeting.AppDownloader

Reach or suppress users based on whether they downloaded specific apps. Use include to reach users who downloaded those apps. Use exclude to suppress users who already have your app (acquisition targeting). Use the adamId of the app you’re promoting in your campaign as an included or excluded value; API users can only pass in their own apps. To target all users, don’t include this dimension in the request payload. Include and exclude supported. Use with App Store campaigns. See TargetingData. Mutable.

daypartAdGroupTargeting.Daypart

Hour-of-day targeting. Include slot integers (0–167) to restrict delivery to those hours. Include only. Used with App Store and Apple Maps campaigns. Values represent one-hour windows in a 7-day week grid starting on Sunday. See AdGroupTargeting.Daypart for the full slot reference. See TargetingData. Mutable.

locationGroupAdGroupTargeting.LocationGroup

Location group targeting. Include location group IDs to restrict delivery to the business locations in those groups. Include only. Used with Apple Maps campaigns. For creating and managing groups, see Managing Location Groups. See TargetingData. Mutable.

Discussion

The AdGroupTargeting object is the comprehensive audience and placement configuration for an ad group. The CampaignTargeting establishes campaign-level supply source, placement, and geographic markets first, and AdGroupTargeting then refines audience and delivery within the bounds of that campaign.

Each field uses a TargetingData object with include and exclude arrays. Setting exclude on an include-only dimension has no effect.

Not every targeting dimension is meaningful for every campaign type in practice. The API represents every dimension as the same generic TargetingData shape, so campaign-type pairing is usage guidance rather than a constraint the schema enforces.

Combining multiple dimensions uses AND logic: a user must match all specified criteria to be eligible.

For valid location identifier values and geographic lookup, see Geo Targeting Endpoints. For managing location groups used in locationGroup targeting, see Managing Location Groups.

For a full request that embeds targeting alongside the other ad group fields, see Create an Ad Group (create) and Update an Ad Group (update).

Example

{
  "country": {
    "include": ["1125", "1107"]
  },
  "adminArea": {
    "include": ["9070", "12683"]
  },
  "locality": {
    "include": ["11390462"]
  },
  "postalCode": {
    "include": ["11412181", "11412183"]
  },
  "radius": {
    "include": ["MEDIUM"]
  },
  "deviceClass": {
    "include": ["IPHONE", "IPAD"]
  },
  "minAge": {
    "include": ["25"]
  },
  "maxAge": {
    "include": ["54"]
  },
  "gender": {
    "include": ["M", "F"]
  },
  "appCategory": {
    "include": ["100"],
    "exclude": ["100"]
  },
  "appDownloader": {
    "include": ["987654321"],
    "exclude": ["555666777"]
  },
  "daypart": {
    "include": ["8", "9", "10", "32", "33", "34"]
  },
  "locationGroup": {
    "include": ["123456789"]
  }
}

Topics

Dictionaries

See Also