google-api-ruby-client/generated/google/apis/admob_v1beta/classes.rb

1036 lines
44 KiB
Ruby
Raw Normal View History

feat: Automated regeneration of admob v1beta client (#1466) This PR was generated using Autosynth. :rainbow: <details><summary>Log from Synthtool</summary> ``` 2020-11-11 01:30:06,483 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py. On branch autosynth-admob-v1beta nothing to commit, working tree clean 2020-11-11 01:30:06,510 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth admob v1beta DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth admob v1beta bundle install Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will break this application for all non-root users on this machine. The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`. Fetching gem metadata from https://rubygems.org/......... Fetching gem metadata from https://rubygems.org/. Resolving dependencies... Fetching rake 11.3.0 Installing rake 11.3.0 Fetching concurrent-ruby 1.1.7 Installing concurrent-ruby 1.1.7 Fetching i18n 1.8.5 Installing i18n 1.8.5 Fetching minitest 5.14.2 Installing minitest 5.14.2 Fetching thread_safe 0.3.6 Installing thread_safe 0.3.6 Fetching tzinfo 1.2.8 Installing tzinfo 1.2.8 Fetching activesupport 5.0.7.2 Installing activesupport 5.0.7.2 Fetching public_suffix 4.0.6 Installing public_suffix 4.0.6 Fetching addressable 2.7.0 Installing addressable 2.7.0 Fetching ast 2.4.1 Installing ast 2.4.1 Using bundler 2.1.4 Fetching byebug 11.1.3 Installing byebug 11.1.3 with native extensions Fetching coderay 1.1.3 Installing coderay 1.1.3 Fetching json 2.3.1 Installing json 2.3.1 with native extensions Fetching docile 1.3.2 Installing docile 1.3.2 Fetching simplecov-html 0.10.2 Installing simplecov-html 0.10.2 Fetching simplecov 0.16.1 Installing simplecov 0.16.1 Using sync 0.5.0 Fetching tins 1.26.0 Installing tins 1.26.0 Fetching term-ansicolor 1.7.1 Installing term-ansicolor 1.7.1 Fetching thor 0.20.3 Installing thor 0.20.3 Fetching coveralls 0.8.23 Installing coveralls 0.8.23 Fetching crack 0.4.4 Installing crack 0.4.4 Fetching declarative 0.0.20 Installing declarative 0.0.20 Fetching declarative-option 0.1.0 Installing declarative-option 0.1.0 Fetching diff-lcs 1.4.4 Installing diff-lcs 1.4.4 Fetching dotenv 2.7.6 Installing dotenv 2.7.6 Fetching fakefs 0.20.1 Installing fakefs 0.20.1 Fetching multipart-post 2.1.1 Installing multipart-post 2.1.1 Fetching ruby2_keywords 0.0.2 Installing ruby2_keywords 0.0.2 Fetching faraday 1.1.0 Installing faraday 1.1.0 Fetching gems 1.2.0 Installing gems 1.2.0 Fetching github-markup 1.7.0 Installing github-markup 1.7.0 Fetching jwt 2.2.2 Installing jwt 2.2.2 Fetching memoist 0.16.2 Installing memoist 0.16.2 Fetching multi_json 1.15.0 Installing multi_json 1.15.0 Fetching os 0.9.6 Installing os 0.9.6 Fetching signet 0.14.0 Installing signet 0.14.0 Fetching googleauth 0.14.0 Installing googleauth 0.14.0 Fetching httpclient 2.8.3 Installing httpclient 2.8.3 Fetching mini_mime 1.0.2 Installing mini_mime 1.0.2 Fetching uber 0.1.0 Installing uber 0.1.0 Fetching representable 3.0.4 Installing representable 3.0.4 Fetching retriable 3.1.2 Installing retriable 3.1.2 Fetching rexml 3.2.4 Installing rexml 3.2.4 Using google-api-client 0.49.0 from source at `.` Fetching google-id-token 1.4.2 Installing google-id-token 1.4.2 Fetching hashdiff 1.0.1 Installing hashdiff 1.0.1 Fetching mime-types-data 3.2020.1104 Installing mime-types-data 3.2020.1104 Fetching mime-types 3.3.1 Installing mime-types 3.3.1 Fetching multi_xml 0.6.0 Installing multi_xml 0.6.0 Fetching httparty 0.18.1 Installing httparty 0.18.1 Fetching rspec-support 3.10.0 Installing rspec-support 3.10.0 Fetching rspec-core 3.10.0 Installing rspec-core 3.10.0 Fetching rspec-expectations 3.10.0 Installing rspec-expectations 3.10.0 Fetching rspec-mocks 3.10.0 Installing rspec-mocks 3.10.0 Fetching rspec 3.10.0 Installing rspec 3.10.0 Fetching json_spec 1.1.5 Installing json_spec 1.1.5 Fetching launchy 2.5.0 Installing launchy 2.5.0 Fetching little-plugger 1.1.4 Installing little-plugger 1.1.4 Fetching logging 2.3.0 Installing logging 2.3.0 Fetching method_source 1.0.0 Installing method_source 1.0.0 Fetching opencensus 0.5.0 Installing opencensus 0.5.0 Fetching parallel 1.20.0 Installing parallel 1.20.0 Fetching parser 2.7.2.0 Installing parser 2.7.2.0 Fetching powerpack 0.1.2 Installing powerpack 0.1.2 Fetching pry 0.13.1 Installing pry 0.13.1 Fetching pry-byebug 3.9.0 Installing pry-byebug 3.9.0 Fetching yard 0.9.25 Installing yard 0.9.25 Fetching pry-doc 0.13.5 Installing pry-doc 0.13.5 Fetching rainbow 2.2.2 Installing rainbow 2.2.2 with native extensions Fetching redcarpet 3.5.0 Installing redcarpet 3.5.0 with native extensions Fetching redis 3.3.5 Installing redis 3.3.5 Fetching rmail 1.1.4 Installing rmail 1.1.4 Fetching ruby-progressbar 1.10.1 Installing ruby-progressbar 1.10.1 Fetching unicode-display_width 1.7.0 Installing unicode-display_width 1.7.0 Fetching rubocop 0.49.1 Installing rubocop 0.49.1 Fetching webmock 2.3.2 Installing webmock 2.3.2 Bundle complete! 31 Gemfile dependencies, 78 gems now installed. Use `bundle info [gemname]` to see where a bundled gem is installed. Post-install message from i18n: HEADS UP! i18n 1.1 changed fallbacks to exclude default locale. But that may break your application. If you are upgrading your Rails application from an older version of Rails: Please check your Rails app for 'config.i18n.fallbacks = true'. If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be 'config.i18n.fallbacks = [I18n.default_locale]'. If not, fallbacks will be broken in your app by I18n 1.1.x. If you are starting a NEW Rails application, you can ignore this notice. For more info see: https://github.com/svenfuchs/i18n/releases/tag/v1.1.0 Post-install message from httparty: When you HTTParty, you must party hard! echo a | bundle exec bin/generate-api gen generated --api=admob.v1beta --names-out=/workspace/api_names_out.yaml Loading admob, version v1beta from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/admob.v1beta.json create google/apis/admob_v1beta.rb create google/apis/admob_v1beta/service.rb create google/apis/admob_v1beta/classes.rb create google/apis/admob_v1beta/representations.rb conflict /workspace/api_names_out.yaml Overwrite /workspace/api_names_out.yaml? (enter "h" for help) [Ynaqdhm] a force /workspace/api_names_out.yaml 2020-11-11 01:30:31,234 synthtool [DEBUG] > Wrote metadata to generated/google/apis/admob_v1beta/synth.metadata. DEBUG:synthtool:Wrote metadata to generated/google/apis/admob_v1beta/synth.metadata. ``` </details> Full log will be available here: https://source.cloud.google.com/results/invocations/563cc11f-8781-4ca7-969f-979083ad200c/targets - [ ] To automatically regenerate this PR, check this box.
2020-11-11 09:48:10 +00:00
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module AdmobV1beta
# Describes an AdMob ad unit.
class AdUnit
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `adFormat`
# @return [String]
attr_accessor :ad_format
# Ad media type supported by this ad unit. Possible values as follows: "
# RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media.
# Corresponds to the JSON property `adTypes`
# @return [Array<String>]
attr_accessor :ad_types
# 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
# Corresponds to the JSON property `adUnitId`
# @return [String]
attr_accessor :ad_unit_id
# The externally visible ID of the app this ad unit is associated with. Example:
# ca-app-pub-9876543210987654~0123456789
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# 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.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Resource name for this ad unit. Format is accounts/`publisher_id`/adUnits/`
# ad_unit_id_fragment` Example: accounts/pub-9876543210987654/adUnits/0123456789
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ad_format = args[:ad_format] if args.key?(:ad_format)
@ad_types = args[:ad_types] if args.key?(:ad_types)
@ad_unit_id = args[:ad_unit_id] if args.key?(:ad_unit_id)
@app_id = args[:app_id] if args.key?(:app_id)
@display_name = args[:display_name] if args.key?(:display_name)
@name = args[:name] if args.key?(:name)
end
end
# Describes an AdMob app for a specific platform (For example: Android or iOS).
class App
include Google::Apis::Core::Hashable
# 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
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# Information from the app store if the app is linked to an app store.
# Corresponds to the JSON property `linkedAppInfo`
# @return [Google::Apis::AdmobV1beta::AppLinkedAppInfo]
attr_accessor :linked_app_info
# Information provided for manual apps which are not linked to an application
# store (Example: Google Play, App Store).
# Corresponds to the JSON property `manualAppInfo`
# @return [Google::Apis::AdmobV1beta::AppManualAppInfo]
attr_accessor :manual_app_info
# Resource name for this app. Format is accounts/`publisher_id`/apps/`
# app_id_fragment` Example: accounts/pub-9876543210987654/apps/0123456789
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Describes the platform of the app. Limited to "IOS" and "ANDROID".
# Corresponds to the JSON property `platform`
# @return [String]
attr_accessor :platform
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@app_id = args[:app_id] if args.key?(:app_id)
@linked_app_info = args[:linked_app_info] if args.key?(:linked_app_info)
@manual_app_info = args[:manual_app_info] if args.key?(:manual_app_info)
@name = args[:name] if args.key?(:name)
@platform = args[:platform] if args.key?(:platform)
end
end
# Information from the app store if the app is linked to an app store.
class AppLinkedAppInfo
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `appStoreId`
# @return [String]
attr_accessor :app_store_id
# 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.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@app_store_id = args[:app_store_id] if args.key?(:app_store_id)
@display_name = args[:display_name] if args.key?(:display_name)
end
end
# Information provided for manual apps which are not linked to an application
# store (Example: Google Play, App Store).
class AppManualAppInfo
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_name = args[:display_name] if args.key?(:display_name)
end
end
# 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`.
class Date
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `day`
# @return [Fixnum]
attr_accessor :day
# Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
# and day.
# Corresponds to the JSON property `month`
# @return [Fixnum]
attr_accessor :month
# Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
# year.
# Corresponds to the JSON property `year`
# @return [Fixnum]
attr_accessor :year
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@day = args[:day] if args.key?(:day)
@month = args[:month] if args.key?(:month)
@year = args[:year] if args.key?(:year)
end
end
# Specification of a single date range. Both dates are inclusive.
class DateRange
include Google::Apis::Core::Hashable
# 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`.
# Corresponds to the JSON property `endDate`
# @return [Google::Apis::AdmobV1beta::Date]
attr_accessor :end_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 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`.
# Corresponds to the JSON property `startDate`
# @return [Google::Apis::AdmobV1beta::Date]
attr_accessor :start_date
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@end_date = args[:end_date] if args.key?(:end_date)
@start_date = args[:start_date] if args.key?(:start_date)
end
end
# Request to generate an AdMob Mediation report.
class GenerateMediationReportRequest
include Google::Apis::Core::Hashable
# 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;
# Corresponds to the JSON property `reportSpec`
# @return [Google::Apis::AdmobV1beta::MediationReportSpec]
attr_accessor :report_spec
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@report_spec = args[:report_spec] if args.key?(:report_spec)
end
end
# 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` `]
class GenerateMediationReportResponse
include Google::Apis::Core::Hashable
# Groups data available after report generation, for example, warnings and row
# counts. Always sent as the last message in the stream response.
# Corresponds to the JSON property `footer`
# @return [Google::Apis::AdmobV1beta::ReportFooter]
attr_accessor :footer
# Groups data helps to treat the generated report. Always sent as a first
# message in the stream response.
# Corresponds to the JSON property `header`
# @return [Google::Apis::AdmobV1beta::ReportHeader]
attr_accessor :header
# A row of the returning report.
# Corresponds to the JSON property `row`
# @return [Google::Apis::AdmobV1beta::ReportRow]
attr_accessor :row
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@footer = args[:footer] if args.key?(:footer)
@header = args[:header] if args.key?(:header)
@row = args[:row] if args.key?(:row)
end
end
# Request to generate an AdMob Network report.
class GenerateNetworkReportRequest
include Google::Apis::Core::Hashable
# 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;
# Corresponds to the JSON property `reportSpec`
# @return [Google::Apis::AdmobV1beta::NetworkReportSpec]
attr_accessor :report_spec
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@report_spec = args[:report_spec] if args.key?(:report_spec)
end
end
# 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` `]
class GenerateNetworkReportResponse
include Google::Apis::Core::Hashable
# Groups data available after report generation, for example, warnings and row
# counts. Always sent as the last message in the stream response.
# Corresponds to the JSON property `footer`
# @return [Google::Apis::AdmobV1beta::ReportFooter]
attr_accessor :footer
# Groups data helps to treat the generated report. Always sent as a first
# message in the stream response.
# Corresponds to the JSON property `header`
# @return [Google::Apis::AdmobV1beta::ReportHeader]
attr_accessor :header
# A row of the returning report.
# Corresponds to the JSON property `row`
# @return [Google::Apis::AdmobV1beta::ReportRow]
attr_accessor :row
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@footer = args[:footer] if args.key?(:footer)
@header = args[:header] if args.key?(:header)
@row = args[:row] if args.key?(:row)
end
end
# Response for the ad units list request.
class ListAdUnitsResponse
include Google::Apis::Core::Hashable
# The resulting ad units for the requested account.
# Corresponds to the JSON property `adUnits`
# @return [Array<Google::Apis::AdmobV1beta::AdUnit>]
attr_accessor :ad_units
# If not empty, indicates that there may be more ad units for the request; this
# value should be passed in a new `ListAdUnitsRequest`.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ad_units = args[:ad_units] if args.key?(:ad_units)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Response for the apps list request.
class ListAppsResponse
include Google::Apis::Core::Hashable
# The resulting apps for the requested account.
# Corresponds to the JSON property `apps`
# @return [Array<Google::Apis::AdmobV1beta::App>]
attr_accessor :apps
# If not empty, indicates that there may be more apps for the request; this
# value should be passed in a new `ListAppsRequest`.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@apps = args[:apps] if args.key?(:apps)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Response for the publisher account list request.
class ListPublisherAccountsResponse
include Google::Apis::Core::Hashable
# Publisher that the client credentials can access.
# Corresponds to the JSON property `account`
# @return [Array<Google::Apis::AdmobV1beta::PublisherAccount>]
attr_accessor :account
# If not empty, indicates that there might be more accounts for the request; you
# must pass this value in a new `ListPublisherAccountsRequest`.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@account = args[:account] if args.key?(:account)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Localization settings for reports, such as currency and language. It affects
# how metrics are calculated.
class LocalizationSettings
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
# 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.
# Corresponds to the JSON property `languageCode`
# @return [String]
attr_accessor :language_code
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@currency_code = args[:currency_code] if args.key?(:currency_code)
@language_code = args[:language_code] if args.key?(:language_code)
end
end
# 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;
class MediationReportSpec
include Google::Apis::Core::Hashable
# Specification of a single date range. Both dates are inclusive.
# Corresponds to the JSON property `dateRange`
# @return [Google::Apis::AdmobV1beta::DateRange]
attr_accessor :date_range
# Describes which report rows to match based on their dimension values.
# Corresponds to the JSON property `dimensionFilters`
# @return [Array<Google::Apis::AdmobV1beta::MediationReportSpecDimensionFilter>]
attr_accessor :dimension_filters
# 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.
# Corresponds to the JSON property `dimensions`
# @return [Array<String>]
attr_accessor :dimensions
# Localization settings for reports, such as currency and language. It affects
# how metrics are calculated.
# Corresponds to the JSON property `localizationSettings`
# @return [Google::Apis::AdmobV1beta::LocalizationSettings]
attr_accessor :localization_settings
# 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.
# Corresponds to the JSON property `maxReportRows`
# @return [Fixnum]
attr_accessor :max_report_rows
# List of metrics of the report. A report must specify at least one metric.
# Corresponds to the JSON property `metrics`
# @return [Array<String>]
attr_accessor :metrics
# 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.
# Corresponds to the JSON property `sortConditions`
# @return [Array<Google::Apis::AdmobV1beta::MediationReportSpecSortCondition>]
attr_accessor :sort_conditions
# 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.
# Corresponds to the JSON property `timeZone`
# @return [String]
attr_accessor :time_zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@date_range = args[:date_range] if args.key?(:date_range)
@dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters)
@dimensions = args[:dimensions] if args.key?(:dimensions)
@localization_settings = args[:localization_settings] if args.key?(:localization_settings)
@max_report_rows = args[:max_report_rows] if args.key?(:max_report_rows)
@metrics = args[:metrics] if args.key?(:metrics)
@sort_conditions = args[:sort_conditions] if args.key?(:sort_conditions)
@time_zone = args[:time_zone] if args.key?(:time_zone)
end
end
# Describes which report rows to match based on their dimension values.
class MediationReportSpecDimensionFilter
include Google::Apis::Core::Hashable
# Applies the filter criterion to the specified dimension.
# Corresponds to the JSON property `dimension`
# @return [String]
attr_accessor :dimension
# List of string values.
# Corresponds to the JSON property `matchesAny`
# @return [Google::Apis::AdmobV1beta::StringList]
attr_accessor :matches_any
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dimension = args[:dimension] if args.key?(:dimension)
@matches_any = args[:matches_any] if args.key?(:matches_any)
end
end
# Sorting direction to be applied on a dimension or a metric.
class MediationReportSpecSortCondition
include Google::Apis::Core::Hashable
# Sort by the specified dimension.
# Corresponds to the JSON property `dimension`
# @return [String]
attr_accessor :dimension
# Sort by the specified metric.
# Corresponds to the JSON property `metric`
# @return [String]
attr_accessor :metric
# Sorting order of the dimension or metric.
# Corresponds to the JSON property `order`
# @return [String]
attr_accessor :order
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dimension = args[:dimension] if args.key?(:dimension)
@metric = args[:metric] if args.key?(:metric)
@order = args[:order] if args.key?(:order)
end
end
# 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;
class NetworkReportSpec
include Google::Apis::Core::Hashable
# Specification of a single date range. Both dates are inclusive.
# Corresponds to the JSON property `dateRange`
# @return [Google::Apis::AdmobV1beta::DateRange]
attr_accessor :date_range
# Describes which report rows to match based on their dimension values.
# Corresponds to the JSON property `dimensionFilters`
# @return [Array<Google::Apis::AdmobV1beta::NetworkReportSpecDimensionFilter>]
attr_accessor :dimension_filters
# 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.
# Corresponds to the JSON property `dimensions`
# @return [Array<String>]
attr_accessor :dimensions
# Localization settings for reports, such as currency and language. It affects
# how metrics are calculated.
# Corresponds to the JSON property `localizationSettings`
# @return [Google::Apis::AdmobV1beta::LocalizationSettings]
attr_accessor :localization_settings
# 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.
# Corresponds to the JSON property `maxReportRows`
# @return [Fixnum]
attr_accessor :max_report_rows
# List of metrics of the report. A report must specify at least one metric.
# Corresponds to the JSON property `metrics`
# @return [Array<String>]
attr_accessor :metrics
# 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.
# Corresponds to the JSON property `sortConditions`
# @return [Array<Google::Apis::AdmobV1beta::NetworkReportSpecSortCondition>]
attr_accessor :sort_conditions
# 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.
# Corresponds to the JSON property `timeZone`
# @return [String]
attr_accessor :time_zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@date_range = args[:date_range] if args.key?(:date_range)
@dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters)
@dimensions = args[:dimensions] if args.key?(:dimensions)
@localization_settings = args[:localization_settings] if args.key?(:localization_settings)
@max_report_rows = args[:max_report_rows] if args.key?(:max_report_rows)
@metrics = args[:metrics] if args.key?(:metrics)
@sort_conditions = args[:sort_conditions] if args.key?(:sort_conditions)
@time_zone = args[:time_zone] if args.key?(:time_zone)
end
end
# Describes which report rows to match based on their dimension values.
class NetworkReportSpecDimensionFilter
include Google::Apis::Core::Hashable
# Applies the filter criterion to the specified dimension.
# Corresponds to the JSON property `dimension`
# @return [String]
attr_accessor :dimension
# List of string values.
# Corresponds to the JSON property `matchesAny`
# @return [Google::Apis::AdmobV1beta::StringList]
attr_accessor :matches_any
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dimension = args[:dimension] if args.key?(:dimension)
@matches_any = args[:matches_any] if args.key?(:matches_any)
end
end
# Sorting direction to be applied on a dimension or a metric.
class NetworkReportSpecSortCondition
include Google::Apis::Core::Hashable
# Sort by the specified dimension.
# Corresponds to the JSON property `dimension`
# @return [String]
attr_accessor :dimension
# Sort by the specified metric.
# Corresponds to the JSON property `metric`
# @return [String]
attr_accessor :metric
# Sorting order of the dimension or metric.
# Corresponds to the JSON property `order`
# @return [String]
attr_accessor :order
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dimension = args[:dimension] if args.key?(:dimension)
@metric = args[:metric] if args.key?(:metric)
@order = args[:order] if args.key?(:order)
end
end
# A publisher account contains information relevant to the use of this API, such
# as the time zone used for the reports.
class PublisherAccount
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `currencyCode`
# @return [String]
attr_accessor :currency_code
# Resource name of this account. Format is accounts/`publisher_id`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The unique ID by which this publisher account can be identified in the API
# requests (for example, pub-1234567890).
# Corresponds to the JSON property `publisherId`
# @return [String]
attr_accessor :publisher_id
# 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".
# Corresponds to the JSON property `reportingTimeZone`
# @return [String]
attr_accessor :reporting_time_zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@currency_code = args[:currency_code] if args.key?(:currency_code)
@name = args[:name] if args.key?(:name)
@publisher_id = args[:publisher_id] if args.key?(:publisher_id)
@reporting_time_zone = args[:reporting_time_zone] if args.key?(:reporting_time_zone)
end
end
# Groups data available after report generation, for example, warnings and row
# counts. Always sent as the last message in the stream response.
class ReportFooter
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `matchingRowCount`
# @return [Fixnum]
attr_accessor :matching_row_count
# Warnings associated with generation of the report.
# Corresponds to the JSON property `warnings`
# @return [Array<Google::Apis::AdmobV1beta::ReportWarning>]
attr_accessor :warnings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@matching_row_count = args[:matching_row_count] if args.key?(:matching_row_count)
@warnings = args[:warnings] if args.key?(:warnings)
end
end
# Groups data helps to treat the generated report. Always sent as a first
# message in the stream response.
class ReportHeader
include Google::Apis::Core::Hashable
# Specification of a single date range. Both dates are inclusive.
# Corresponds to the JSON property `dateRange`
# @return [Google::Apis::AdmobV1beta::DateRange]
attr_accessor :date_range
# Localization settings for reports, such as currency and language. It affects
# how metrics are calculated.
# Corresponds to the JSON property `localizationSettings`
# @return [Google::Apis::AdmobV1beta::LocalizationSettings]
attr_accessor :localization_settings
# The report time zone. The value is a time-zone ID as specified by the CLDR
# project, for example, "America/Los_Angeles".
# Corresponds to the JSON property `reportingTimeZone`
# @return [String]
attr_accessor :reporting_time_zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@date_range = args[:date_range] if args.key?(:date_range)
@localization_settings = args[:localization_settings] if args.key?(:localization_settings)
@reporting_time_zone = args[:reporting_time_zone] if args.key?(:reporting_time_zone)
end
end
# A row of the returning report.
class ReportRow
include Google::Apis::Core::Hashable
# Map of dimension values in a row, with keys as enum name of the dimensions.
# Corresponds to the JSON property `dimensionValues`
# @return [Hash<String,Google::Apis::AdmobV1beta::ReportRowDimensionValue>]
attr_accessor :dimension_values
# 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.
# Corresponds to the JSON property `metricValues`
# @return [Hash<String,Google::Apis::AdmobV1beta::ReportRowMetricValue>]
attr_accessor :metric_values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dimension_values = args[:dimension_values] if args.key?(:dimension_values)
@metric_values = args[:metric_values] if args.key?(:metric_values)
end
end
# Representation of a dimension value.
class ReportRowDimensionValue
include Google::Apis::Core::Hashable
# The localized string representation of the value. If unspecified, the display
# label should be derived from the value.
# Corresponds to the JSON property `displayLabel`
# @return [String]
attr_accessor :display_label
# Dimension value in the format specified in the report's spec Dimension enum.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@display_label = args[:display_label] if args.key?(:display_label)
@value = args[:value] if args.key?(:value)
end
end
# Representation of a metric value.
class ReportRowMetricValue
include Google::Apis::Core::Hashable
# Double precision (approximate) decimal values. Rates are from 0 to 1.
# Corresponds to the JSON property `doubleValue`
# @return [Float]
attr_accessor :double_value
# Metric integer value.
# Corresponds to the JSON property `integerValue`
# @return [Fixnum]
attr_accessor :integer_value
# 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.
# Corresponds to the JSON property `microsValue`
# @return [Fixnum]
attr_accessor :micros_value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@double_value = args[:double_value] if args.key?(:double_value)
@integer_value = args[:integer_value] if args.key?(:integer_value)
@micros_value = args[:micros_value] if args.key?(:micros_value)
end
end
# Warnings associated with generation of the report.
class ReportWarning
include Google::Apis::Core::Hashable
# Describes the details of the warning message, in English.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Type of the warning.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@type = args[:type] if args.key?(:type)
end
end
# List of string values.
class StringList
include Google::Apis::Core::Hashable
# The string values.
# Corresponds to the JSON property `values`
# @return [Array<String>]
attr_accessor :values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@values = args[:values] if args.key?(:values)
end
end
end
end
end