--- title: "POST /v1/{+parent}/networkReport:generate" method: POST path: "/v1/{+parent}/networkReport:generate" tags: ["accounts"] --- # POST /v1/{+parent}/networkReport:generate `POST /v1/{+parent}/networkReport:generate` Generates an AdMob Network report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses. ## Path parameters - `parent` string, required ## Request body - GenerateNetworkReportRequest — Request to generate an AdMob Network report. - `reportSpec` NetworkReportSpec — The specification for generating an AdMob Network report. For example, the specification to get clicks and estimated earnings for only the 'US' and 'CN' countries can look like the following example: { 'date_range': { 'start_date': {'year': 2021, 'month': 9, 'day': 1}, 'end_date': {'year': 2021, 'month': 9, 'day': 30} }, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'], 'dimension_filters': [ { 'dimension': 'COUNTRY', 'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]} } ], 'sort_conditions': [ {'dimension':'APP', order: 'ASCENDING'}, {'metric':'CLICKS', order: 'DESCENDING'} ], 'localization_settings': { 'currency_code': 'USD', 'language_code': 'en-US' } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2021-09-01' AND DATE <= '2021-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC; - `dimensionFilters` NetworkReportSpecDimensionFilter[] — Describes which report rows to match based on their dimension values. - `matchesAny` StringList — List of string values. - `values` string[] — The string values. - `dimension` 'DIMENSION_UNSPECIFIED' | 'DATE' | 'MONTH' | 'WEEK' | 'AD_UNIT' | 'APP' | 'AD_TYPE' | 'COUNTRY' | 'FORMAT' | 'PLATFORM' | 'MOBILE_OS_VERSION' | 'GMA_SDK_VERSION' | 'APP_VERSION_NAME' | 'SERVING_RESTRICTION' — Applies the filter criterion to the specified dimension. - `timeZone` string — A report time zone. Accepts an IANA TZ name values, such as "America/Los_Angeles." If no time zone is defined, the account default takes effect. Check default value by the get account action. **Warning:** The "America/Los_Angeles" is the only supported value at the moment. - `dateRange` DateRange — Specification of a single date range. Both dates are inclusive. - `endDate` Date — Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - `day` integer — Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - `year` integer — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. - `month` integer — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - `startDate` Date — Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - `day` integer — Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - `year` integer — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. - `month` integer — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - `dimensions` string[] — List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account. - `sortConditions` NetworkReportSpecSortCondition[] — Describes the sorting of report rows. The order of the condition in the list defines its precedence; the earlier the condition, the higher its precedence. If no sort conditions are specified, the row ordering is undefined. - `dimension` 'DIMENSION_UNSPECIFIED' | 'DATE' | 'MONTH' | 'WEEK' | 'AD_UNIT' | 'APP' | 'AD_TYPE' | 'COUNTRY' | 'FORMAT' | 'PLATFORM' | 'MOBILE_OS_VERSION' | 'GMA_SDK_VERSION' | 'APP_VERSION_NAME' | 'SERVING_RESTRICTION' — Sort by the specified dimension. - `metric` 'METRIC_UNSPECIFIED' | 'AD_REQUESTS' | 'CLICKS' | 'ESTIMATED_EARNINGS' | 'IMPRESSIONS' | 'IMPRESSION_CTR' | 'IMPRESSION_RPM' | 'MATCHED_REQUESTS' | 'MATCH_RATE' | 'SHOW_RATE' — Sort by the specified metric. - `order` 'SORT_ORDER_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING' — Sorting order of the dimension or metric. - `localizationSettings` LocalizationSettings — Localization settings for reports, such as currency and language. It affects how metrics are calculated. - `languageCode` string — Language used for any localized text, such as some dimension value display labels. The language tag defined in the IETF BCP47. Defaults to 'en-US' if unspecified. - `currencyCode` string — Currency code of the earning related metrics, which is the 3-letter code defined in ISO 4217. The daily average rate is used for the currency conversion. Defaults to the account currency code if unspecified. - `metrics` string[] — List of metrics of the report. A report must specify at least one metric. - `maxReportRows` integer — Maximum number of report data rows to return. If the value is not set, the API returns as many rows as possible, up to 100000. Acceptable values are 1-100000, inclusive. Values larger than 100000 return an error. ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/admob.md) · [All operations](https://skmtc.dev/google/apis/admob/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/admob/revisions/daa0f395ce67/schema)