Apps Data Objects
Request, response, and metadata objects for Apps report endpoints.
Overview
Apps reports cover the five apps 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 Apps reporting entities each have a dedicated endpoint.
Entity | Endpoint |
|---|---|
Campaign | |
Ad Group | |
Ad | |
Keyword | |
Search Term |
Shared Object Model
Every Apps report request uses AppsReportingRequest as its body. Every Apps report request must include a campaignId filter. Brands report requests don’t have this requirement. Each response row follows the same three-part shape:
metadata: entity attributes (name, status, identifiers) plus anygroupBydimension value (deviceClass,ageRange,gender,countryCode,adminArea,locality,storefront, orcountryOrRegion, with entity-level restrictions) applied to that row. Entity-specific metadata schemas define the fields available for each entity, including AppsReportingCampaign, AppsReportingAdGroup, AppsReportingAd, ReportingKeyword, and ReportingSearchTerm. Ad metadata nests creative details in an AppsReportingCreative object rather than a flat creative ID.totalMetrics: aggregate AppsMetrics (or entity variant, for example, AppsAdGroupMetrics) 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.
Each endpoint’s response envelope, row, and summary objects follow a consistent per-entity naming pattern, for example AppsCampaignReportResponse, AppsCampaignReportRow, and AppsCampaignResultContainer for campaigns, with equivalent objects for ad groups, ads, keywords, and search terms.
For a side-by-side comparison of Apps and Brands reporting differences (groupBy dimensions, options, creative metadata), see Managing Reports.
Topics
AppsReportingRequestAppsReportingCampaignAppsReportingAdGroupAppsReportingAdAppsReportingCreativeAppsCampaignReportResponseAppsCampaignReportRowAppsCampaignReportSummaryAppsCampaignResultContainerAppsAdGroupReportResponseAppsAdGroupReportRowAppsAdGroupReportSummaryAppsAdGroupResultContainerAppsAdReportResponseAppsAdReportRowAppsAdReportSummaryAppsAdResultContainerAppsKeywordReportResponseAppsKeywordReportRowAppsKeywordReportSummaryAppsKeywordResultContainerAppsSearchTermReportResponseAppsSearchTermReportRowAppsSearchTermReportSummaryAppsSearchTermResultContainerAppsMetricsAppsCampaignMetricsAppsAdGroupMetricsAppsOptionsAppsTargetingProjection