googleapis.admob.v1 library

Classes

AccountsMediationReportResourceApi
AccountsNetworkReportResourceApi
AccountsResourceApi
AdmobApi
The AdMob API allows publishers to programmatically get information about their AdMob account.
Date
Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp.
DateRange
Specification of a single date range. Both dates are inclusive.
GenerateMediationReportRequest
Request to generate an AdMob Mediation report.
GenerateMediationReportResponse
The streaming response for the AdMob Mediation report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: { "header": { "date_range": { "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date": {"year": 2018, "month": 9, "day": 1} }, "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } }, { "row": { "dimension_values": { "DATE": {"value": "20180918"}, "APP": { "value": "ca-app-pub-8123415297019784~1001342552", "display_label": "My app name!" } }, "metric_values": { "ESTIMATED_EARNINGS": {"decimal_value": "1324746"} } } }, { "footer": {"matching_row_count": 1} }
GenerateNetworkReportRequest
Request to generate an AdMob Network report.
GenerateNetworkReportResponse
The streaming response for the AdMob Network report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: { "header": { "dateRange": { "startDate": {"year": 2018, "month": 9, "day": 1}, "endDate": {"year": 2018, "month": 9, "day": 1} }, "localizationSettings": { "currencyCode": "USD", "languageCode": "en-US" } } }, { "row": { "dimensionValues": { "DATE": {"value": "20180918"}, "APP": { "value": "ca-app-pub-8123415297019784~1001342552", displayLabel: "My app name!" } }, "metricValues": { "ESTIMATED_EARNINGS": {"microsValue": 6500000} } } }, { "footer": {"matchingRowCount": 1} }
ListPublisherAccountsResponse
Response for the publisher account list request.
LocalizationSettings
Localization settings for reports, such as currency and language. It affects how metrics are calculated.
MediationReportSpec
The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { "date_range": { "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date": {"year": 2018, "month": 9, "day": 30} }, "dimensions": "AD_SOURCE", "APP", "COUNTRY", "metrics": "OBSERVED_ECPM", "dimension_filters": [ { "dimension": "COUNTRY", "matches_any": {"values": {"value": "US", "value": "CN"}} } ], "sort_conditions": {"dimension":"APP", order: "ASCENDING"} , "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 AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;
MediationReportSpecDimensionFilter
Describes which report rows to match based on their dimension values.
MediationReportSpecSortCondition
Sorting direction to be applied on a dimension or a metric.
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': 2018, 'month': 9, 'day': 1}, 'end_date': {'year': 2018, '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 >= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC;
NetworkReportSpecDimensionFilter
Describes which report rows to match based on their dimension values.
NetworkReportSpecSortCondition
Sorting direction to be applied on a dimension or a metric.
PublisherAccount
A publisher account contains information relevant to the use of this API, such as the time zone used for the reports.
ReportFooter
Groups data available after report generation, for example, warnings and row counts. Always sent as the last message in the stream response.
ReportHeader
Groups data helps to treat the generated report. Always sent as a first message in the stream response.
ReportRow
A row of the returning report.
ReportRowDimensionValue
Representation of a dimension value.
ReportRowMetricValue
Representation of a metric value.
ReportWarning
Warnings associated with generation of the report.
StringList
List of string values.

Constants

USER_AGENT → const String
'dart-api-client admob/v1'

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.