1{ 2 "auth": { 3 "oauth2": { 4 "scopes": { 5 "https://www.googleapis.com/auth/admob.readonly": { 6 "description": "See your AdMob data" 7 }, 8 "https://www.googleapis.com/auth/admob.report": { 9 "description": "See your AdMob data" 10 } 11 } 12 } 13 }, 14 "basePath": "", 15 "baseUrl": "https://admob.googleapis.com/", 16 "batchPath": "batch", 17 "canonicalName": "AdMob", 18 "description": "The AdMob API allows publishers to programmatically get information about their AdMob account. ", 19 "discoveryVersion": "v1", 20 "documentationLink": "https://developers.google.com/admob/api/", 21 "fullyEncodeReservedExpansion": true, 22 "icons": { 23 "x16": "http://www.google.com/images/icons/product/search-16.gif", 24 "x32": "http://www.google.com/images/icons/product/search-32.gif" 25 }, 26 "id": "admob:v1beta", 27 "kind": "discovery#restDescription", 28 "mtlsRootUrl": "https://admob.mtls.googleapis.com/", 29 "name": "admob", 30 "ownerDomain": "google.com", 31 "ownerName": "Google", 32 "parameters": { 33 "$.xgafv": { 34 "description": "V1 error format.", 35 "enum": [ 36 "1", 37 "2" 38 ], 39 "enumDescriptions": [ 40 "v1 error format", 41 "v2 error format" 42 ], 43 "location": "query", 44 "type": "string" 45 }, 46 "access_token": { 47 "description": "OAuth access token.", 48 "location": "query", 49 "type": "string" 50 }, 51 "alt": { 52 "default": "json", 53 "description": "Data format for response.", 54 "enum": [ 55 "json", 56 "media", 57 "proto" 58 ], 59 "enumDescriptions": [ 60 "Responses with Content-Type of application/json", 61 "Media download with context-dependent Content-Type", 62 "Responses with Content-Type of application/x-protobuf" 63 ], 64 "location": "query", 65 "type": "string" 66 }, 67 "callback": { 68 "description": "JSONP", 69 "location": "query", 70 "type": "string" 71 }, 72 "fields": { 73 "description": "Selector specifying which fields to include in a partial response.", 74 "location": "query", 75 "type": "string" 76 }, 77 "key": { 78 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", 79 "location": "query", 80 "type": "string" 81 }, 82 "oauth_token": { 83 "description": "OAuth 2.0 token for the current user.", 84 "location": "query", 85 "type": "string" 86 }, 87 "prettyPrint": { 88 "default": "true", 89 "description": "Returns response with indentations and line breaks.", 90 "location": "query", 91 "type": "boolean" 92 }, 93 "quotaUser": { 94 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", 95 "location": "query", 96 "type": "string" 97 }, 98 "uploadType": { 99 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", 100 "location": "query", 101 "type": "string" 102 }, 103 "upload_protocol": { 104 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", 105 "location": "query", 106 "type": "string" 107 } 108 }, 109 "protocol": "rest", 110 "resources": { 111 "accounts": { 112 "methods": { 113 "get": { 114 "description": "Gets information about the specified AdMob publisher account.", 115 "flatPath": "v1beta/accounts/{accountsId}", 116 "httpMethod": "GET", 117 "id": "admob.accounts.get", 118 "parameterOrder": [ 119 "name" 120 ], 121 "parameters": { 122 "name": { 123 "description": "Resource name of the publisher account to retrieve. Example: accounts/pub-9876543210987654", 124 "location": "path", 125 "pattern": "^accounts/[^/]+$", 126 "required": true, 127 "type": "string" 128 } 129 }, 130 "path": "v1beta/{+name}", 131 "response": { 132 "$ref": "PublisherAccount" 133 }, 134 "scopes": [ 135 "https://www.googleapis.com/auth/admob.readonly", 136 "https://www.googleapis.com/auth/admob.report" 137 ], 138 "streamingType": "NONE" 139 }, 140 "list": { 141 "description": "Lists the AdMob publisher account that was most recently signed in to from the AdMob UI. For more information, see https://support.google.com/admob/answer/10243672.", 142 "flatPath": "v1beta/accounts", 143 "httpMethod": "GET", 144 "id": "admob.accounts.list", 145 "parameterOrder": [], 146 "parameters": { 147 "pageSize": { 148 "description": "Maximum number of accounts to return.", 149 "format": "int32", 150 "location": "query", 151 "type": "integer" 152 }, 153 "pageToken": { 154 "description": "The value returned by the last `ListPublisherAccountsResponse`; indicates that this is a continuation of a prior `ListPublisherAccounts` call, and that the system should return the next page of data.", 155 "location": "query", 156 "type": "string" 157 } 158 }, 159 "path": "v1beta/accounts", 160 "response": { 161 "$ref": "ListPublisherAccountsResponse" 162 }, 163 "scopes": [ 164 "https://www.googleapis.com/auth/admob.readonly", 165 "https://www.googleapis.com/auth/admob.report" 166 ], 167 "streamingType": "NONE" 168 } 169 }, 170 "resources": { 171 "adUnits": { 172 "methods": { 173 "list": { 174 "description": "List the ad units under the specified AdMob account.", 175 "flatPath": "v1beta/accounts/{accountsId}/adUnits", 176 "httpMethod": "GET", 177 "id": "admob.accounts.adUnits.list", 178 "parameterOrder": [ 179 "parent" 180 ], 181 "parameters": { 182 "pageSize": { 183 "description": "The maximum number of ad units to return. If unspecified or 0, at most 1000 ad units will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.", 184 "format": "int32", 185 "location": "query", 186 "type": "integer" 187 }, 188 "pageToken": { 189 "description": "The value returned by the last `ListAdUnitsResponse`; indicates that this is a continuation of a prior `ListAdUnits` call, and that the system should return the next page of data.", 190 "location": "query", 191 "type": "string" 192 }, 193 "parent": { 194 "description": "Required. Resource name of the account to list ad units for. Example: accounts/pub-9876543210987654", 195 "location": "path", 196 "pattern": "^accounts/[^/]+$", 197 "required": true, 198 "type": "string" 199 } 200 }, 201 "path": "v1beta/{+parent}/adUnits", 202 "response": { 203 "$ref": "ListAdUnitsResponse" 204 }, 205 "scopes": [ 206 "https://www.googleapis.com/auth/admob.readonly" 207 ], 208 "streamingType": "NONE" 209 } 210 } 211 }, 212 "apps": { 213 "methods": { 214 "list": { 215 "description": "List the apps under the specified AdMob account.", 216 "flatPath": "v1beta/accounts/{accountsId}/apps", 217 "httpMethod": "GET", 218 "id": "admob.accounts.apps.list", 219 "parameterOrder": [ 220 "parent" 221 ], 222 "parameters": { 223 "pageSize": { 224 "description": "The maximum number of apps to return. If unspecified or 0, at most 1000 apps will be returned. The maximum value is 10,000; values above 10,000 will be coerced to 10,000.", 225 "format": "int32", 226 "location": "query", 227 "type": "integer" 228 }, 229 "pageToken": { 230 "description": "The value returned by the last `ListAppsResponse`; indicates that this is a continuation of a prior `ListApps` call, and that the system should return the next page of data.", 231 "location": "query", 232 "type": "string" 233 }, 234 "parent": { 235 "description": "Required. Resource name of the account to list apps for. Example: accounts/pub-9876543210987654", 236 "location": "path", 237 "pattern": "^accounts/[^/]+$", 238 "required": true, 239 "type": "string" 240 } 241 }, 242 "path": "v1beta/{+parent}/apps", 243 "response": { 244 "$ref": "ListAppsResponse" 245 }, 246 "scopes": [ 247 "https://www.googleapis.com/auth/admob.readonly" 248 ], 249 "streamingType": "NONE" 250 } 251 } 252 }, 253 "mediationReport": { 254 "methods": { 255 "generate": { 256 "description": "Generates an AdMob Mediation report based on the provided report specification. Returns result of a server-side streaming RPC. The result is returned in a sequence of responses.", 257 "flatPath": "v1beta/accounts/{accountsId}/mediationReport:generate", 258 "httpMethod": "POST", 259 "id": "admob.accounts.mediationReport.generate", 260 "parameterOrder": [ 261 "parent" 262 ], 263 "parameters": { 264 "parent": { 265 "description": "Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654", 266 "location": "path", 267 "pattern": "^accounts/[^/]+$", 268 "required": true, 269 "type": "string" 270 } 271 }, 272 "path": "v1beta/{+parent}/mediationReport:generate", 273 "request": { 274 "$ref": "GenerateMediationReportRequest" 275 }, 276 "response": { 277 "$ref": "GenerateMediationReportResponse" 278 }, 279 "scopes": [ 280 "https://www.googleapis.com/auth/admob.readonly", 281 "https://www.googleapis.com/auth/admob.report" 282 ], 283 "streamingType": "SERVER_SIDE" 284 } 285 } 286 }, 287 "networkReport": { 288 "methods": { 289 "generate": { 290 "description": "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.", 291 "flatPath": "v1beta/accounts/{accountsId}/networkReport:generate", 292 "httpMethod": "POST", 293 "id": "admob.accounts.networkReport.generate", 294 "parameterOrder": [ 295 "parent" 296 ], 297 "parameters": { 298 "parent": { 299 "description": "Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654", 300 "location": "path", 301 "pattern": "^accounts/[^/]+$", 302 "required": true, 303 "type": "string" 304 } 305 }, 306 "path": "v1beta/{+parent}/networkReport:generate", 307 "request": { 308 "$ref": "GenerateNetworkReportRequest" 309 }, 310 "response": { 311 "$ref": "GenerateNetworkReportResponse" 312 }, 313 "scopes": [ 314 "https://www.googleapis.com/auth/admob.readonly", 315 "https://www.googleapis.com/auth/admob.report" 316 ], 317 "streamingType": "SERVER_SIDE" 318 } 319 } 320 } 321 } 322 } 323 }, 324 "revision": "20220104", 325 "rootUrl": "https://admob.googleapis.com/", 326 "schemas": { 327 "AdUnit": { 328 "description": "Describes an AdMob ad unit.", 329 "id": "AdUnit", 330 "properties": { 331 "adFormat": { 332 "description": "AdFormat of the ad unit. Possible values are as follows: \"BANNER\" - Banner ad format. \"BANNER_INTERSTITIAL\" - Legacy format that can be used as either banner or interstitial. This format can no longer be created but can be targeted by mediation groups. \"INTERSTITIAL\" - A full screen ad. Supported ad types are \"RICH_MEDIA\" and \"VIDEO\". \"NATIVE\" - Native ad format. \"REWARDED\" - An ad that, once viewed, gets a callback verifying the view so that a reward can be given to the user. Supported ad types are \"RICH_MEDIA\" (interactive) and video where video can not be excluded.", 333 "type": "string" 334 }, 335 "adTypes": { 336 "description": "Ad media type supported by this ad unit. Possible values as follows: \"RICH_MEDIA\" - Text, image, and other non-video media. \"VIDEO\" - Video media.", 337 "items": { 338 "type": "string" 339 }, 340 "type": "array" 341 }, 342 "adUnitId": { 343 "description": "The externally visible ID of the ad unit which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654/0123456789", 344 "type": "string" 345 }, 346 "appId": { 347 "description": "The externally visible ID of the app this ad unit is associated with. Example: ca-app-pub-9876543210987654~0123456789", 348 "type": "string" 349 }, 350 "displayName": { 351 "description": "The display name of the ad unit as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.", 352 "type": "string" 353 }, 354 "name": { 355 "description": "Resource name for this ad unit. Format is accounts/{publisher_id}/adUnits/{ad_unit_id_fragment} Example: accounts/pub-9876543210987654/adUnits/0123456789", 356 "type": "string" 357 } 358 }, 359 "type": "object" 360 }, 361 "App": { 362 "description": "Describes an AdMob app for a specific platform (For example: Android or iOS).", 363 "id": "App", 364 "properties": { 365 "appId": { 366 "description": "The externally visible ID of the app which can be used to integrate with the AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~0123456789", 367 "type": "string" 368 }, 369 "linkedAppInfo": { 370 "$ref": "AppLinkedAppInfo", 371 "description": "Immutable. The information for an app that is linked to an app store. This field is present if and only if the app is linked to an app store." 372 }, 373 "manualAppInfo": { 374 "$ref": "AppManualAppInfo", 375 "description": "The information for an app that is not linked to any app store. After an app is linked, this information is still retrivable. If no name is provided for the app upon creation, a placeholder name will be used." 376 }, 377 "name": { 378 "description": "Resource name for this app. Format is accounts/{publisher_id}/apps/{app_id_fragment} Example: accounts/pub-9876543210987654/apps/0123456789", 379 "type": "string" 380 }, 381 "platform": { 382 "description": "Describes the platform of the app. Limited to \"IOS\" and \"ANDROID\".", 383 "type": "string" 384 } 385 }, 386 "type": "object" 387 }, 388 "AppLinkedAppInfo": { 389 "description": "Information from the app store if the app is linked to an app store.", 390 "id": "AppLinkedAppInfo", 391 "properties": { 392 "appStoreId": { 393 "description": "The app store ID of the app; present if and only if the app is linked to an app store. If the app is added to the Google Play store, it will be the application ID of the app. For example: \"com.example.myapp\". See https://developer.android.com/studio/build/application-id. If the app is added to the Apple App Store, it will be app store ID. For example \"105169111\". Note that setting the app store id is considered an irreversible action. Once an app is linked, it cannot be unlinked.", 394 "type": "string" 395 }, 396 "displayName": { 397 "description": "Output only. Display name of the app as it appears in the app store. This is an output-only field, and may be empty if the app cannot be found in the store.", 398 "readOnly": true, 399 "type": "string" 400 } 401 }, 402 "type": "object" 403 }, 404 "AppManualAppInfo": { 405 "description": "Information provided for manual apps which are not linked to an application store (Example: Google Play, App Store).", 406 "id": "AppManualAppInfo", 407 "properties": { 408 "displayName": { 409 "description": "The display name of the app as shown in the AdMob UI, which is provided by the user. The maximum length allowed is 80 characters.", 410 "type": "string" 411 } 412 }, 413 "type": "object" 414 }, 415 "Date": { 416 "description": "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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.", 417 "id": "Date", 418 "properties": { 419 "day": { 420 "description": "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.", 421 "format": "int32", 422 "type": "integer" 423 }, 424 "month": { 425 "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", 426 "format": "int32", 427 "type": "integer" 428 }, 429 "year": { 430 "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", 431 "format": "int32", 432 "type": "integer" 433 } 434 }, 435 "type": "object" 436 }, 437 "DateRange": { 438 "description": "Specification of a single date range. Both dates are inclusive.", 439 "id": "DateRange", 440 "properties": { 441 "endDate": { 442 "$ref": "Date", 443 "description": "End date of the date range, inclusive. Must be greater than or equal to the start date." 444 }, 445 "startDate": { 446 "$ref": "Date", 447 "description": "Start date of the date range, inclusive. Must be less than or equal to the end date." 448 } 449 }, 450 "type": "object" 451 }, 452 "GenerateMediationReportRequest": { 453 "description": "Request to generate an AdMob Mediation report.", 454 "id": "GenerateMediationReportRequest", 455 "properties": { 456 "reportSpec": { 457 "$ref": "MediationReportSpec", 458 "description": "Network report specification." 459 } 460 }, 461 "type": "object" 462 }, 463 "GenerateMediationReportResponse": { 464 "description": "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} }]", 465 "id": "GenerateMediationReportResponse", 466 "properties": { 467 "footer": { 468 "$ref": "ReportFooter", 469 "description": "Additional information about the generated report, such as warnings about the data." 470 }, 471 "header": { 472 "$ref": "ReportHeader", 473 "description": "Report generation settings that describes the report contents, such as the report date range and localization settings." 474 }, 475 "row": { 476 "$ref": "ReportRow", 477 "description": "Actual report data." 478 } 479 }, 480 "type": "object" 481 }, 482 "GenerateNetworkReportRequest": { 483 "description": "Request to generate an AdMob Network report.", 484 "id": "GenerateNetworkReportRequest", 485 "properties": { 486 "reportSpec": { 487 "$ref": "NetworkReportSpec", 488 "description": "Network report specification." 489 } 490 }, 491 "type": "object" 492 }, 493 "GenerateNetworkReportResponse": { 494 "description": "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} }]", 495 "id": "GenerateNetworkReportResponse", 496 "properties": { 497 "footer": { 498 "$ref": "ReportFooter", 499 "description": "Additional information about the generated report, such as warnings about the data." 500 }, 501 "header": { 502 "$ref": "ReportHeader", 503 "description": "Report generation settings that describes the report contents, such as the report date range and localization settings." 504 }, 505 "row": { 506 "$ref": "ReportRow", 507 "description": "Actual report data." 508 } 509 }, 510 "type": "object" 511 }, 512 "ListAdUnitsResponse": { 513 "description": "Response for the ad units list request.", 514 "id": "ListAdUnitsResponse", 515 "properties": { 516 "adUnits": { 517 "description": "The resulting ad units for the requested account.", 518 "items": { 519 "$ref": "AdUnit" 520 }, 521 "type": "array" 522 }, 523 "nextPageToken": { 524 "description": "If not empty, indicates that there may be more ad units for the request; this value should be passed in a new `ListAdUnitsRequest`.", 525 "type": "string" 526 } 527 }, 528 "type": "object" 529 }, 530 "ListAppsResponse": { 531 "description": "Response for the apps list request.", 532 "id": "ListAppsResponse", 533 "properties": { 534 "apps": { 535 "description": "The resulting apps for the requested account.", 536 "items": { 537 "$ref": "App" 538 }, 539 "type": "array" 540 }, 541 "nextPageToken": { 542 "description": "If not empty, indicates that there may be more apps for the request; this value should be passed in a new `ListAppsRequest`.", 543 "type": "string" 544 } 545 }, 546 "type": "object" 547 }, 548 "ListPublisherAccountsResponse": { 549 "description": "Response for the publisher account list request.", 550 "id": "ListPublisherAccountsResponse", 551 "properties": { 552 "account": { 553 "description": "Publisher that the client credentials can access.", 554 "items": { 555 "$ref": "PublisherAccount" 556 }, 557 "type": "array" 558 }, 559 "nextPageToken": { 560 "description": "If not empty, indicates that there might be more accounts for the request; you must pass this value in a new `ListPublisherAccountsRequest`.", 561 "type": "string" 562 } 563 }, 564 "type": "object" 565 }, 566 "LocalizationSettings": { 567 "description": "Localization settings for reports, such as currency and language. It affects how metrics are calculated.", 568 "id": "LocalizationSettings", 569 "properties": { 570 "currencyCode": { 571 "description": "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.", 572 "type": "string" 573 }, 574 "languageCode": { 575 "description": "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.", 576 "type": "string" 577 } 578 }, 579 "type": "object" 580 }, 581 "MediationReportSpec": { 582 "description": "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;", 583 "id": "MediationReportSpec", 584 "properties": { 585 "dateRange": { 586 "$ref": "DateRange", 587 "description": "The date range for which the report is generated." 588 }, 589 "dimensionFilters": { 590 "description": "Describes which report rows to match based on their dimension values.", 591 "items": { 592 "$ref": "MediationReportSpecDimensionFilter" 593 }, 594 "type": "array" 595 }, 596 "dimensions": { 597 "description": "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.", 598 "items": { 599 "enum": [ 600 "DIMENSION_UNSPECIFIED", 601 "DATE", 602 "MONTH", 603 "WEEK", 604 "AD_SOURCE", 605 "AD_SOURCE_INSTANCE", 606 "AD_UNIT", 607 "APP", 608 "MEDIATION_GROUP", 609 "COUNTRY", 610 "FORMAT", 611 "PLATFORM", 612 "MOBILE_OS_VERSION", 613 "GMA_SDK_VERSION", 614 "APP_VERSION_NAME", 615 "SERVING_RESTRICTION" 616 ], 617 "enumDescriptions": [ 618 "Default value for an unset field. Do not use.", 619 "A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 620 "A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.", 621 "The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 622 "The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).", 623 "The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).", 624 "The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.", 625 "The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").", 626 "The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).", 627 "CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.", 628 "Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.", 629 "Mobile OS platform of the app (for example, \"Android\" or \"iOS\").", 630 "Mobile operating system version, e.g. \"iOS 13.5.1\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.", 631 "GMA SDK version, e.g. \"iOS 7.62.0\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.", 632 "For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString. **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.", 633 "Restriction mode for ads serving (e.g. \"Non-personalized ads\"). **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) metric." 634 ], 635 "type": "string" 636 }, 637 "type": "array" 638 }, 639 "localizationSettings": { 640 "$ref": "LocalizationSettings", 641 "description": "Localization settings of the report." 642 }, 643 "maxReportRows": { 644 "description": "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.", 645 "format": "int32", 646 "type": "integer" 647 }, 648 "metrics": { 649 "description": "List of metrics of the report. A report must specify at least one metric.", 650 "items": { 651 "enum": [ 652 "METRIC_UNSPECIFIED", 653 "AD_REQUESTS", 654 "CLICKS", 655 "ESTIMATED_EARNINGS", 656 "IMPRESSIONS", 657 "IMPRESSION_CTR", 658 "MATCHED_REQUESTS", 659 "MATCH_RATE", 660 "OBSERVED_ECPM" 661 ], 662 "enumDescriptions": [ 663 "Default value for an unset field. Do not use.", 664 "The number of requests. The value is an integer.", 665 "The number of times a user clicks an ad. The value is an integer.", 666 "The estimated earnings of the AdMob publisher. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $6.50 would be represented as 6500000. Estimated earnings per mediation group and per ad source instance level is supported dating back to October 20, 2019. Third-party estimated earnings will show 0 for dates prior to October 20, 2019.", 667 "The total number of ads shown to users. The value is an integer.", 668 "The ratio of clicks over impressions. The value is a double precision (approximate) decimal value.", 669 "The number of times ads are returned in response to a request. The value is an integer.", 670 "The ratio of matched ad requests over the total ad requests. The value is a double precision (approximate) decimal value.", 671 "The third-party ad network's estimated average eCPM. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $2.30 would be represented as 2300000. The estimated average eCPM per mediation group and per ad source instance level is supported dating back to October 20, 2019. Third-party estimated average eCPM will show 0 for dates prior to October 20, 2019." 672 ], 673 "type": "string" 674 }, 675 "type": "array" 676 }, 677 "sortConditions": { 678 "description": "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.", 679 "items": { 680 "$ref": "MediationReportSpecSortCondition" 681 }, 682 "type": "array" 683 }, 684 "timeZone": { 685 "description": "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.", 686 "type": "string" 687 } 688 }, 689 "type": "object" 690 }, 691 "MediationReportSpecDimensionFilter": { 692 "description": "Describes which report rows to match based on their dimension values.", 693 "id": "MediationReportSpecDimensionFilter", 694 "properties": { 695 "dimension": { 696 "description": "Applies the filter criterion to the specified dimension.", 697 "enum": [ 698 "DIMENSION_UNSPECIFIED", 699 "DATE", 700 "MONTH", 701 "WEEK", 702 "AD_SOURCE", 703 "AD_SOURCE_INSTANCE", 704 "AD_UNIT", 705 "APP", 706 "MEDIATION_GROUP", 707 "COUNTRY", 708 "FORMAT", 709 "PLATFORM", 710 "MOBILE_OS_VERSION", 711 "GMA_SDK_VERSION", 712 "APP_VERSION_NAME", 713 "SERVING_RESTRICTION" 714 ], 715 "enumDescriptions": [ 716 "Default value for an unset field. Do not use.", 717 "A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 718 "A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.", 719 "The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 720 "The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).", 721 "The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).", 722 "The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.", 723 "The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").", 724 "The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).", 725 "CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.", 726 "Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.", 727 "Mobile OS platform of the app (for example, \"Android\" or \"iOS\").", 728 "Mobile operating system version, e.g. \"iOS 13.5.1\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.", 729 "GMA SDK version, e.g. \"iOS 7.62.0\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.", 730 "For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString. **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.", 731 "Restriction mode for ads serving (e.g. \"Non-personalized ads\"). **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) metric." 732 ], 733 "type": "string" 734 }, 735 "matchesAny": { 736 "$ref": "StringList", 737 "description": "Matches a row if its value for the specified dimension is in one of the values specified in this condition." 738 } 739 }, 740 "type": "object" 741 }, 742 "MediationReportSpecSortCondition": { 743 "description": "Sorting direction to be applied on a dimension or a metric.", 744 "id": "MediationReportSpecSortCondition", 745 "properties": { 746 "dimension": { 747 "description": "Sort by the specified dimension.", 748 "enum": [ 749 "DIMENSION_UNSPECIFIED", 750 "DATE", 751 "MONTH", 752 "WEEK", 753 "AD_SOURCE", 754 "AD_SOURCE_INSTANCE", 755 "AD_UNIT", 756 "APP", 757 "MEDIATION_GROUP", 758 "COUNTRY", 759 "FORMAT", 760 "PLATFORM", 761 "MOBILE_OS_VERSION", 762 "GMA_SDK_VERSION", 763 "APP_VERSION_NAME", 764 "SERVING_RESTRICTION" 765 ], 766 "enumDescriptions": [ 767 "Default value for an unset field. Do not use.", 768 "A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 769 "A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.", 770 "The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 771 "The [unique ID of the ad source](/admob/api/v1/ad_sources) (for example, \"5450213213286189855\" and \"AdMob Network\" as label value).", 772 "The unique ID of the ad source instance (for example, \"ca-app-pub-1234:asi:5678\" and \"AdMob (default)\" as label value).", 773 "The unique ID of the ad unit (for example, \"ca-app-pub-1234/8790\"). If AD_UNIT dimension is specified, then APP is included automatically.", 774 "The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").", 775 "The unique ID of the mediation group (for example, \"ca-app-pub-1234:mg:1234\" and \"AdMob (default)\" as label value).", 776 "CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.", 777 "Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.", 778 "Mobile OS platform of the app (for example, \"Android\" or \"iOS\").", 779 "Mobile operating system version, e.g. \"iOS 13.5.1\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.", 780 "GMA SDK version, e.g. \"iOS 7.62.0\". **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.", 781 "For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString. **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS), [OBSERVED_ECPM](#Metric.ENUM_VALUES.OBSERVED_ECPM) metrics.", 782 "Restriction mode for ads serving (e.g. \"Non-personalized ads\"). **Warning:** The dimension is incompatible with [ESTIMATED_EARNINGS](#Metric.ENUM_VALUES.ESTIMATED_EARNINGS) metric." 783 ], 784 "type": "string" 785 }, 786 "metric": { 787 "description": "Sort by the specified metric.", 788 "enum": [ 789 "METRIC_UNSPECIFIED", 790 "AD_REQUESTS", 791 "CLICKS", 792 "ESTIMATED_EARNINGS", 793 "IMPRESSIONS", 794 "IMPRESSION_CTR", 795 "MATCHED_REQUESTS", 796 "MATCH_RATE", 797 "OBSERVED_ECPM" 798 ], 799 "enumDescriptions": [ 800 "Default value for an unset field. Do not use.", 801 "The number of requests. The value is an integer.", 802 "The number of times a user clicks an ad. The value is an integer.", 803 "The estimated earnings of the AdMob publisher. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $6.50 would be represented as 6500000. Estimated earnings per mediation group and per ad source instance level is supported dating back to October 20, 2019. Third-party estimated earnings will show 0 for dates prior to October 20, 2019.", 804 "The total number of ads shown to users. The value is an integer.", 805 "The ratio of clicks over impressions. The value is a double precision (approximate) decimal value.", 806 "The number of times ads are returned in response to a request. The value is an integer.", 807 "The ratio of matched ad requests over the total ad requests. The value is a double precision (approximate) decimal value.", 808 "The third-party ad network's estimated average eCPM. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $2.30 would be represented as 2300000. The estimated average eCPM per mediation group and per ad source instance level is supported dating back to October 20, 2019. Third-party estimated average eCPM will show 0 for dates prior to October 20, 2019." 809 ], 810 "type": "string" 811 }, 812 "order": { 813 "description": "Sorting order of the dimension or metric.", 814 "enum": [ 815 "SORT_ORDER_UNSPECIFIED", 816 "ASCENDING", 817 "DESCENDING" 818 ], 819 "enumDescriptions": [ 820 "Default value for an unset field. Do not use.", 821 "Sort dimension value or metric value in ascending order.", 822 "Sort dimension value or metric value in descending order." 823 ], 824 "type": "string" 825 } 826 }, 827 "type": "object" 828 }, 829 "NetworkReportSpec": { 830 "description": "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;", 831 "id": "NetworkReportSpec", 832 "properties": { 833 "dateRange": { 834 "$ref": "DateRange", 835 "description": "The date range for which the report is generated." 836 }, 837 "dimensionFilters": { 838 "description": "Describes which report rows to match based on their dimension values.", 839 "items": { 840 "$ref": "NetworkReportSpecDimensionFilter" 841 }, 842 "type": "array" 843 }, 844 "dimensions": { 845 "description": "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.", 846 "items": { 847 "enum": [ 848 "DIMENSION_UNSPECIFIED", 849 "DATE", 850 "MONTH", 851 "WEEK", 852 "AD_UNIT", 853 "APP", 854 "AD_TYPE", 855 "COUNTRY", 856 "FORMAT", 857 "PLATFORM", 858 "MOBILE_OS_VERSION", 859 "GMA_SDK_VERSION", 860 "APP_VERSION_NAME", 861 "SERVING_RESTRICTION" 862 ], 863 "enumDescriptions": [ 864 "Default value for an unset field. Do not use.", 865 "A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 866 "A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.", 867 "The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 868 "The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.", 869 "The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").", 870 "Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.", 871 "CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.", 872 "Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.", 873 "Mobile OS platform of the app (for example, \"Android\" or \"iOS\").", 874 "Mobile operating system version, e.g. \"iOS 13.5.1\".", 875 "GMA SDK version, e.g. \"iOS 7.62.0\".", 876 "For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.", 877 "Restriction mode for ads serving (e.g. \"Non-personalized ads\")." 878 ], 879 "type": "string" 880 }, 881 "type": "array" 882 }, 883 "localizationSettings": { 884 "$ref": "LocalizationSettings", 885 "description": "Localization settings of the report." 886 }, 887 "maxReportRows": { 888 "description": "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.", 889 "format": "int32", 890 "type": "integer" 891 }, 892 "metrics": { 893 "description": "List of metrics of the report. A report must specify at least one metric.", 894 "items": { 895 "enum": [ 896 "METRIC_UNSPECIFIED", 897 "AD_REQUESTS", 898 "CLICKS", 899 "ESTIMATED_EARNINGS", 900 "IMPRESSIONS", 901 "IMPRESSION_CTR", 902 "IMPRESSION_RPM", 903 "MATCHED_REQUESTS", 904 "MATCH_RATE", 905 "SHOW_RATE" 906 ], 907 "enumDescriptions": [ 908 "Default value for an unset field. Do not use.", 909 "The number of ad requests. The value is an integer. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", 910 "The number of times a user clicks an ad. The value is an integer.", 911 "The estimated earnings of the AdMob publisher. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $6.50 would be represented as 6500000.", 912 "The total number of ads shown to users. The value is an integer.", 913 "The ratio of clicks over impressions. The value is a double precision (approximate) decimal value.", 914 "The estimated earnings per thousand ad impressions. The value is in micros. For example, $1.03 would be represented as 1030000. Equivalent to eCPM in the AdMob UI. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", 915 "The number of times ads are returned in response to a request. The value is an integer.", 916 "The ratio of matched ad requests over the total ad requests. The value is a double precision (approximate) decimal value. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", 917 "The ratio of ads that are displayed over ads that are returned, defined as impressions / matched requests. The value is a double precision (approximate) decimal value." 918 ], 919 "type": "string" 920 }, 921 "type": "array" 922 }, 923 "sortConditions": { 924 "description": "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.", 925 "items": { 926 "$ref": "NetworkReportSpecSortCondition" 927 }, 928 "type": "array" 929 }, 930 "timeZone": { 931 "description": "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.", 932 "type": "string" 933 } 934 }, 935 "type": "object" 936 }, 937 "NetworkReportSpecDimensionFilter": { 938 "description": "Describes which report rows to match based on their dimension values.", 939 "id": "NetworkReportSpecDimensionFilter", 940 "properties": { 941 "dimension": { 942 "description": "Applies the filter criterion to the specified dimension.", 943 "enum": [ 944 "DIMENSION_UNSPECIFIED", 945 "DATE", 946 "MONTH", 947 "WEEK", 948 "AD_UNIT", 949 "APP", 950 "AD_TYPE", 951 "COUNTRY", 952 "FORMAT", 953 "PLATFORM", 954 "MOBILE_OS_VERSION", 955 "GMA_SDK_VERSION", 956 "APP_VERSION_NAME", 957 "SERVING_RESTRICTION" 958 ], 959 "enumDescriptions": [ 960 "Default value for an unset field. Do not use.", 961 "A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 962 "A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.", 963 "The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 964 "The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.", 965 "The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").", 966 "Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.", 967 "CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.", 968 "Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.", 969 "Mobile OS platform of the app (for example, \"Android\" or \"iOS\").", 970 "Mobile operating system version, e.g. \"iOS 13.5.1\".", 971 "GMA SDK version, e.g. \"iOS 7.62.0\".", 972 "For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.", 973 "Restriction mode for ads serving (e.g. \"Non-personalized ads\")." 974 ], 975 "type": "string" 976 }, 977 "matchesAny": { 978 "$ref": "StringList", 979 "description": "Matches a row if its value for the specified dimension is in one of the values specified in this condition." 980 } 981 }, 982 "type": "object" 983 }, 984 "NetworkReportSpecSortCondition": { 985 "description": "Sorting direction to be applied on a dimension or a metric.", 986 "id": "NetworkReportSpecSortCondition", 987 "properties": { 988 "dimension": { 989 "description": "Sort by the specified dimension.", 990 "enum": [ 991 "DIMENSION_UNSPECIFIED", 992 "DATE", 993 "MONTH", 994 "WEEK", 995 "AD_UNIT", 996 "APP", 997 "AD_TYPE", 998 "COUNTRY", 999 "FORMAT", 1000 "PLATFORM", 1001 "MOBILE_OS_VERSION", 1002 "GMA_SDK_VERSION", 1003 "APP_VERSION_NAME", 1004 "SERVING_RESTRICTION" 1005 ], 1006 "enumDescriptions": [ 1007 "Default value for an unset field. Do not use.", 1008 "A date in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 1009 "A month in the YYYYMM format (for example, \"202107\"). Requests can specify at most one time dimension.", 1010 "The date of the first day of a week in the YYYYMMDD format (for example, \"20210701\"). Requests can specify at most one time dimension.", 1011 "The unique ID of the ad unit (for example, \"ca-app-pub-1234/1234\"). If AD_UNIT dimension is specified, then APP is included automatically.", 1012 "The unique ID of the mobile application (for example, \"ca-app-pub-1234~1234\").", 1013 "Type of the ad (for example, \"text\" or \"image\"), an ad delivery dimension. **Warning:** The dimension is incompatible with [AD_REQUESTS](#Metric.ENUM_VALUES.AD_REQUESTS), [MATCH_RATE](#Metric.ENUM_VALUES.MATCH_RATE) and [IMPRESSION_RPM](#Metric.ENUM_VALUES.IMPRESSION_RPM) metrics.", 1014 "CLDR country code of the place where the ad views/clicks occur (for example, \"US\" or \"FR\"). This is a geography dimension.", 1015 "Format of the ad unit (for example, \"banner\", \"native\"), an ad delivery dimension.", 1016 "Mobile OS platform of the app (for example, \"Android\" or \"iOS\").", 1017 "Mobile operating system version, e.g. \"iOS 13.5.1\".", 1018 "GMA SDK version, e.g. \"iOS 7.62.0\".", 1019 "For Android, the app version name can be found in versionName in PackageInfo. For iOS, the app version name can be found in CFBundleShortVersionString.", 1020 "Restriction mode for ads serving (e.g. \"Non-personalized ads\")." 1021 ], 1022 "type": "string" 1023 }, 1024 "metric": { 1025 "description": "Sort by the specified metric.", 1026 "enum": [ 1027 "METRIC_UNSPECIFIED", 1028 "AD_REQUESTS", 1029 "CLICKS", 1030 "ESTIMATED_EARNINGS", 1031 "IMPRESSIONS", 1032 "IMPRESSION_CTR", 1033 "IMPRESSION_RPM", 1034 "MATCHED_REQUESTS", 1035 "MATCH_RATE", 1036 "SHOW_RATE" 1037 ], 1038 "enumDescriptions": [ 1039 "Default value for an unset field. Do not use.", 1040 "The number of ad requests. The value is an integer. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", 1041 "The number of times a user clicks an ad. The value is an integer.", 1042 "The estimated earnings of the AdMob publisher. The currency unit (USD, EUR, or other) of the earning metrics are determined by the localization setting for currency. The amount is in micros. For example, $6.50 would be represented as 6500000.", 1043 "The total number of ads shown to users. The value is an integer.", 1044 "The ratio of clicks over impressions. The value is a double precision (approximate) decimal value.", 1045 "The estimated earnings per thousand ad impressions. The value is in micros. For example, $1.03 would be represented as 1030000. Equivalent to eCPM in the AdMob UI. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", 1046 "The number of times ads are returned in response to a request. The value is an integer.", 1047 "The ratio of matched ad requests over the total ad requests. The value is a double precision (approximate) decimal value. **Warning:** The metric is incompatible with [AD_TYPE](#Dimension.ENUM_VALUES.AD_TYPE) dimension.", 1048 "The ratio of ads that are displayed over ads that are returned, defined as impressions / matched requests. The value is a double precision (approximate) decimal value." 1049 ], 1050 "type": "string" 1051 }, 1052 "order": { 1053 "description": "Sorting order of the dimension or metric.", 1054 "enum": [ 1055 "SORT_ORDER_UNSPECIFIED", 1056 "ASCENDING", 1057 "DESCENDING" 1058 ], 1059 "enumDescriptions": [ 1060 "Default value for an unset field. Do not use.", 1061 "Sort dimension value or metric value in ascending order.", 1062 "Sort dimension value or metric value in descending order." 1063 ], 1064 "type": "string" 1065 } 1066 }, 1067 "type": "object" 1068 }, 1069 "PublisherAccount": { 1070 "description": "A publisher account contains information relevant to the use of this API, such as the time zone used for the reports.", 1071 "id": "PublisherAccount", 1072 "properties": { 1073 "currencyCode": { 1074 "description": "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.", 1075 "type": "string" 1076 }, 1077 "name": { 1078 "description": "Resource name of this account. Format is accounts/{publisher_id}.", 1079 "type": "string" 1080 }, 1081 "publisherId": { 1082 "description": "The unique ID by which this publisher account can be identified in the API requests (for example, pub-1234567890).", 1083 "type": "string" 1084 }, 1085 "reportingTimeZone": { 1086 "description": "The time zone that is used in reports that are generated for this account. The value is a time-zone ID as specified by the CLDR project, for example, \"America/Los_Angeles\".", 1087 "type": "string" 1088 } 1089 }, 1090 "type": "object" 1091 }, 1092 "ReportFooter": { 1093 "description": "Groups data available after report generation, for example, warnings and row counts. Always sent as the last message in the stream response.", 1094 "id": "ReportFooter", 1095 "properties": { 1096 "matchingRowCount": { 1097 "description": "Total number of rows that matched the request. Warning: This count does NOT always match the number of rows in the response. Do not make that assumption when processing the response.", 1098 "format": "int64", 1099 "type": "string" 1100 }, 1101 "warnings": { 1102 "description": "Warnings associated with generation of the report.", 1103 "items": { 1104 "$ref": "ReportWarning" 1105 }, 1106 "type": "array" 1107 } 1108 }, 1109 "type": "object" 1110 }, 1111 "ReportHeader": { 1112 "description": "Groups data helps to treat the generated report. Always sent as a first message in the stream response.", 1113 "id": "ReportHeader", 1114 "properties": { 1115 "dateRange": { 1116 "$ref": "DateRange", 1117 "description": "The date range for which the report is generated. This is identical to the range specified in the report request." 1118 }, 1119 "localizationSettings": { 1120 "$ref": "LocalizationSettings", 1121 "description": "Localization settings of the report. This is identical to the settings in the report request." 1122 }, 1123 "reportingTimeZone": { 1124 "description": "The report time zone. The value is a time-zone ID as specified by the CLDR project, for example, \"America/Los_Angeles\".", 1125 "type": "string" 1126 } 1127 }, 1128 "type": "object" 1129 }, 1130 "ReportRow": { 1131 "description": "A row of the returning report.", 1132 "id": "ReportRow", 1133 "properties": { 1134 "dimensionValues": { 1135 "additionalProperties": { 1136 "$ref": "ReportRowDimensionValue" 1137 }, 1138 "description": "Map of dimension values in a row, with keys as enum name of the dimensions.", 1139 "type": "object" 1140 }, 1141 "metricValues": { 1142 "additionalProperties": { 1143 "$ref": "ReportRowMetricValue" 1144 }, 1145 "description": "Map of metric values in a row, with keys as enum name of the metrics. If a metric being requested has no value returned, the map will not include it.", 1146 "type": "object" 1147 } 1148 }, 1149 "type": "object" 1150 }, 1151 "ReportRowDimensionValue": { 1152 "description": "Representation of a dimension value.", 1153 "id": "ReportRowDimensionValue", 1154 "properties": { 1155 "displayLabel": { 1156 "description": "The localized string representation of the value. If unspecified, the display label should be derived from the value.", 1157 "type": "string" 1158 }, 1159 "value": { 1160 "description": "Dimension value in the format specified in the report's spec Dimension enum.", 1161 "type": "string" 1162 } 1163 }, 1164 "type": "object" 1165 }, 1166 "ReportRowMetricValue": { 1167 "description": "Representation of a metric value.", 1168 "id": "ReportRowMetricValue", 1169 "properties": { 1170 "doubleValue": { 1171 "description": "Double precision (approximate) decimal values. Rates are from 0 to 1.", 1172 "format": "double", 1173 "type": "number" 1174 }, 1175 "integerValue": { 1176 "description": "Metric integer value.", 1177 "format": "int64", 1178 "type": "string" 1179 }, 1180 "microsValue": { 1181 "description": "Amount in micros. One million is equivalent to one unit. Currency value is in the unit (USD, EUR or other) specified by the request. For example, $6.50 whould be represented as 6500000 micros.", 1182 "format": "int64", 1183 "type": "string" 1184 } 1185 }, 1186 "type": "object" 1187 }, 1188 "ReportWarning": { 1189 "description": "Warnings associated with generation of the report.", 1190 "id": "ReportWarning", 1191 "properties": { 1192 "description": { 1193 "description": "Describes the details of the warning message, in English.", 1194 "type": "string" 1195 }, 1196 "type": { 1197 "description": "Type of the warning.", 1198 "enum": [ 1199 "TYPE_UNSPECIFIED", 1200 "DATA_BEFORE_ACCOUNT_TIMEZONE_CHANGE", 1201 "DATA_DELAYED", 1202 "OTHER", 1203 "REPORT_CURRENCY_NOT_ACCOUNT_CURRENCY" 1204 ], 1205 "enumDescriptions": [ 1206 "Default value for an unset field. Do not use.", 1207 "Some data in this report is aggregated based on a time zone different from the requested time zone. This could happen if a local time-zone report has the start time before the last time this time zone changed. The description field will contain the date of the last time zone change.", 1208 "There is an unusual delay in processing the source data for the requested date range. The report results might be less up to date than usual. AdMob is aware of the issue and is actively working to resolve it.", 1209 "Warnings that are exposed without a specific type. Useful when new warning types are added but the API is not changed yet.", 1210 "The currency being requested is not the account currency. The earning metrics will be based on the requested currency, and thus not a good estimation of the final payment anymore, due to the currency rate fluctuation." 1211 ], 1212 "type": "string" 1213 } 1214 }, 1215 "type": "object" 1216 }, 1217 "StringList": { 1218 "description": "List of string values.", 1219 "id": "StringList", 1220 "properties": { 1221 "values": { 1222 "description": "The string values.", 1223 "items": { 1224 "type": "string" 1225 }, 1226 "type": "array" 1227 } 1228 }, 1229 "type": "object" 1230 } 1231 }, 1232 "servicePath": "", 1233 "title": "AdMob API", 1234 "version": "v1beta", 1235 "version_module": true 1236}
