BrandsReportingAdGroup

Ad group metadata for brands report rows.

Declaration

object BrandsReportingAdGroup

Properties

Name	Type	Description
`id`	int64	The ad group’s unique identifier.
`campaignId`	int64	The campaign this ad group belongs to.
`adAccountId`	int64	The ad account this ad group belongs to.
`name`	string	The ad group name as configured at report time.
`status`	`BrandsReportingAdGroup.Status`	Possible values: `ENABLED`, `PAUSED`.
`deleted`	boolean	Whether the ad group has been soft-deleted.
`systemStatus`	`BrandsReportingAdGroup.SystemStatus`	Possible values: `RUNNING`, `NOT_RUNNING`.
`systemStatusReasons`	[`AdGroupSystemStatusReason`]	System-applied reasons contributing to the current `systemStatus`.
`systemStatusLimitingReasons`	[string]	Status-limiting reasons applied based on advertiser and system factors.
`automatedKeywordsOptIn`	boolean	Whether the ad group opted in to automated keywords.
`automatedKeywordsRequired`	boolean	Whether automated keywords are required for this ad group.
`pricingModel`	`BrandsReportingAdGroup.PricingModel`	Possible values: `CPA`, `CPM`, `CPT`.
`displayStatus`	string	System-computed, rolled-up delivery state combining ad group and campaign conditions.
`modificationTime`	date-time	Timestamp of the ad group’s last modification (ISO 8601).
`creationTime`	date-time	Timestamp when the ad group was created (ISO 8601).
`startTime`	date-time	Ad group start time.
`endTime`	date-time	Ad group end time.
`campaign`	`ReportingCampaignMin`	See ReportingCampaignMin for details.
`bidStrategy`	`ReportingBidStrategy`	See ReportingBidStrategy for details.
`targeting`	`BrandsTargetingProjection`	See BrandsTargetingProjection for details.
`deviceClass`	string	Device class groupBy dimension value.
`locationId`	string	Location ID groupBy dimension value.
`supplyPlacement`	string	Supply placement groupBy dimension value.

Discussion

The BrandsReportingAdGroup object is the ad group metadata embedded in brands ad group report rows. It captures configuration at report time, including the pricingModel, bidStrategy, and the brands-specific targeting projection with supply placement and location group details.

The campaign field embeds a lightweight ReportingCampaignMin for parent campaign context. The system populates the brands dimension fields (deviceClass, locationId, supplyPlacement) based on the groupBy dimensions in the report request. Note that keyword and search term entities exclude supplyPlacement and locationId as groupBy options.

Example

{
  "id": 123456789,
  "campaignId": 987654321,
  "adAccountId": 555666777,
  "name": "AwayFinder - Brands Ad Group",
  "status": "ENABLED",
  "deleted": false,
  "systemStatus": "RUNNING",
  "systemStatusReasons": ["PROCESSING"],
  "systemStatusLimitingReasons": [],
  "automatedKeywordsOptIn": false,
  "automatedKeywordsRequired": false,
  "pricingModel": "CPT",
  "displayStatus": "RUNNING",
  "modificationTime": "2025-01-10T08:00:00.000",
  "creationTime": "2025-01-05T08:00:00.000",
  "startTime": "2025-01-05T08:00:00.000",
  "endTime": "2025-06-30T08:00:00.000",
  "campaign": {},
  "bidStrategy": {
    "bidStrategyType": "MANUAL_CPT",
    "bid": {
      "amount": "2.50",
      "currency": "USD"
    }
  },
  "targeting": {
    "supplyPlacement": {
      "include": ["MAPS_SEARCH_RESULTS", "MAPS_SEARCH_HOME"]
    },
    "lifetimeStorefronts": {
      "include": ["US", "CA"]
    },
    "supplySource": {
      "include": ["MAPS"]
    },
    "promotedLocationGroup": {
      "include": ["555666777"]
    },
    "promotedLocation": {
      "include": ["123456789"]
    }
  },
  "deviceClass": "IPHONE",
  "locationId": "123456789",
  "supplyPlacement": "MAPS_SEARCH_RESULTS"
}

BrandsReportingAdGroup

Declaration

Properties

Discussion

Example

Topics

Type Aliases

See Also