Brands Data Objects
Explore the request, response, and metadata objects that Brands report endpoints use.
Overview
Brands reports cover the five business-brands reporting entities: campaigns, ad groups, ads, keywords, and search terms. Each entity has its own endpoint, request and response pair, and metadata schema, but all five share the same row shape and request structure described below.
The five Brands reporting entities each have a dedicated endpoint.
Entity | Endpoint |
|---|---|
Campaign | |
Ad Group | |
Ad | |
Keyword | |
Search Term |
Shared Object Model
Every Brands report request uses BrandsReportingRequest as its body. Each response row follows the same three-part shape:
metadata: entity attributes (name, status, identifiers) plus anygroupBydimension value (deviceClass,locationId, orsupplyPlacement) applied to that row. Entity-specific metadata schemas define the fields available for each entity, including BrandsReportingCampaign, BrandsReportingAdGroup, BrandsReportingAd, BrandsReportingKeyword, and BrandsReportingSearchTerm. Ad metadata nests creative details in a BrandsReportingCreative object rather than a flat creative ID.totalMetrics: aggregate BrandsMetrics (or entity variant, for example, BrandsAdGroupMetrics) values for the row over the full requested date range.granularMetrics: an array of pure metrics objects, one per period in the requestedgranularity, with no dimension fields of their own. Only present whengranularityis specified in the request.
Action-count fields (actions, firstActions, getDirections, tapURL, call, share, getTheApp, galleryEngagement) are objects keyed by attribution type (for example {"tap": 170}), not bare integers, in both totalMetrics and granularMetrics.
Each endpoint’s response envelope, row, and summary objects follow a consistent per-entity naming pattern, for example BrandsCampaignReportResponse, BrandsCampaignReportRow, and BrandsCampaignResultContainer for campaigns, with equivalent objects for ad groups, ads, keywords, and search terms.
For a side-by-side comparison of Brands and Apps reporting differences (groupBy dimensions, options, creative metadata), see Managing Reports.
Topics
BrandsReportingRequestBrandsReportingCampaignBrandsReportingAdGroupBrandsReportingAdBrandsReportingCreativeBrandsReportingKeywordBrandsReportingSearchTermBrandsCampaignReportResponseBrandsCampaignReportRowBrandsCampaignReportSummaryBrandsCampaignResultContainerBrandsAdGroupReportResponseBrandsAdGroupReportRowBrandsAdGroupReportSummaryBrandsAdGroupResultContainerBrandsAdReportResponseBrandsAdReportRowBrandsAdReportSummaryBrandsAdResultContainerBrandsKeywordReportResponseBrandsKeywordReportRowBrandsKeywordReportSummaryBrandsKeywordResultContainerBrandsSearchTermReportResponseBrandsSearchTermReportRowBrandsSearchTermReportSummaryBrandsSearchTermResultContainerBrandsMetricsBrandsCampaignMetricsBrandsAdGroupMetricsBrandsOptionsBrandsTargetingProjection