Show / Hide Table of Contents

Namespace Google.Apis.AdMob.v1beta.Data

Classes

AdSource

Definition of a mediation ad source.

AdUnit

Describes an AdMob ad unit.

AdUnitMapping

Settings to map an AdMob ad unit to a 3rd party ad unit.

AdUnitRewardSettings

Settings for a rewarded ad unit.

Adapter

Describes adapters supported by each mediation ad source. Adapters correspond to a specific SDK implementation of the ad source, and are each associated with a single platform and a list of supported ad unit formats. Adapters may also require setting some configurations to perform ad requests. Configurations can be specified in the AdUnitMapping by setting the ad_unit_configurations key/value pairs. For example, the ad_unit_configurations can be used to pass various IDs to the adapter's third-party SDK.

AdapterAdapterConfigMetadata

Configuration metadata associated with this adapter. They are used to define the ad_unit_configurations associated with AdUnitMappings for the this adapter.

App

Describes an AdMob app for a specific platform (For example: Android or iOS).

AppLinkedAppInfo

Information from the app store if the app is linked to an app store.

AppManualAppInfo

Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store).

BatchCreateAdUnitMappingsRequest

Request to create a batch of ad unit mappings under the specific AdMob account.

BatchCreateAdUnitMappingsResponse

Response containing a batch of created ad unit mappings.

CampaignReportSpec

The specification for generating a Campaign report. For example, the specification to get IMPRESSIONS and CLICKS sliced by CAMPAIGN_ID can look like the following example: { "date_range": { "start_date": {"year": 2021, "month": 12, "day": 1}, "end_date": {"year": 2021, "month": 12, "day": 30} }, "dimensions": ["CAMPAIGN_ID"], "metrics": ["IMPRESSIONS", "CLICKS"], }

CreateAdUnitMappingRequest

Request to create an ad unit mapping under the specific AdMob account and ad unit.

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

DateRange

Specification of a single date range. Both dates are inclusive.

GenerateCampaignReportRequest

Request to generate campaign report.

GenerateCampaignReportResponse

Campaign Report API response.

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} }]

ListAdSourcesResponse

Response for the ListAdSourcesRequest.

ListAdUnitMappingsResponse

Response for the ListAdUnitMappingsRequest.

ListAdUnitsResponse

Response for the ad units list request.

ListAdaptersResponse

Response for the ListAdaptersRequest.

ListAppsResponse

Response for the apps list request.

ListMediationGroupsResponse

Response for the mediation groups list request.

ListPublisherAccountsResponse

Response for the publisher account list request.

LocalizationSettings

Localization settings for reports, such as currency and language. It affects how metrics are calculated.

MediationAbExperiment

The mediation A/B experiment.

MediationAbExperimentExperimentMediationLine

The mediation group line for the experiment. It will be used for serving during the run of the experiment.

MediationGroup

Describes an AdMob Mediation group.

MediationGroupMediationGroupLine

Settings for an ad network used by a mediation group.

MediationGroupTargeting

Set of criteria targeted by this mediation group. For example, a mediation group can target specific ad unit IDs, platform, format and geo location.

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": 2021, "month": 9, "day": 1}, "end_date": {"year": 2021, "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 >= '2021-09-01' AND DATE <= '2021-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': 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;

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.

StopMediationAbExperimentRequest

Request to end the mediation A/B experiment and choose a winning variant.

StringList

List of string values.

In this article
Back to top Generated by DocFX