Contents

LocationGroup

A collection of business locations associated with a brand, used to target geos in Apple Maps campaigns.

Declaration

object LocationGroup

Properties

NameTypeDescription
id Requiredstring

ID of the location group. Read-only.

name Requiredstring

Display name of the location group.

brandIdstring

Associated brand identifier.

adAccountIdstring

Ad account ID that owns this location group.

groupType RequiredLocationGroupType

Type of location grouping. Values: STATIC, DYNAMIC. See groupType Details in LocationGroupCreate.

systemStatusstring

System-managed status. Values: PENDING, VALID, INVALID, DELETED. Read-only.

rules[Rule]

Array of Rule objects defining membership criteria for DYNAMIC groups.

querystring

RSQL query string generated from rules for DYNAMIC groups. Generated by the server. Don’t set directly. Read-only.

locationIds[string]

Array of location IDs for STATIC groups.

isAllLocationsGroupboolean

true for the system-created “All Locations” group for a brand. Read-only.

descriptionstring

Optional description of the location group.

groupTotal Requiredint64

Total number of locations in the group. Read-only.

eligibilityEligibility

Eligibility status for this location group. See Eligibility. Read-only.

creationTimedate-time

Timestamp when the group was created. Read-only.

modificationTimedate-time

Timestamp of the last modification. Read-only.

Discussion

The LocationGroup object is a targeting unit that bundles one or more brand locations under a named group. It only scopes which locations are in play. Creatives, bids, and budget remain set on the ad group or ad itself, not per location group.

Example

{
  "id": "5764607523034238976",
  "name": "AwayFinder West Coast Stores",
  "brandId": "9151314442816847872",
  "adAccountId": "293897290",
  "groupType": "DYNAMIC",
  "systemStatus": "VALID",
  "rules": [
    {
      "field": "adminArea",
      "operator": "IN",
      "value": ["California", "Oregon", "Washington"]
    }
  ],
  "query": "administrativeArea==California,Oregon,Washington",
  "locationIds": [],
  "isAllLocationsGroup": false,
  "description": "All AwayFinder locations on the West Coast",
  "groupTotal": 42,
  "eligibility": {
    "status": "ELIGIBLE"
  },
  "creationTime": "2026-02-01T09:00:00.000",
  "modificationTime": "2026-03-25T16:00:00.000"
}

See Also