google-apis-admob_v1beta 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 6baba7d7f6e930a78974f59d2b3ac10739efac3a740ab7c23975eb442d7b1e2a
4
+ data.tar.gz: 8fd60a98d71c34826014c6fbef3b8deed7148e404e9975800771bf3f3f982500
5
+ SHA512:
6
+ metadata.gz: a5ab552ad56126084aed518362bf1e04e9174af11ecb9966ede44d84c08e214587f800df897ad3cebc4fd2c95c1647b40419af74bc84f49add9891ac45a07fa2
7
+ data.tar.gz: 3a104e835833eb459afe28a3885466c2f629637c5e3a6f171e2f86bcee41f2082ac1de1e2480bc9bc11a6037506afe0c763e4c4012f2e6d4e01d2dc4f604c30b
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-admob_v1beta
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/admob_v1beta/*.rb
9
+ lib/google/apis/admob_v1beta.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-admob_v1beta
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated from discovery document revision 20201231
6
+ * Regenerated using generator version 0.1.1
7
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1beta of the AdMob API
2
+
3
+ This is a simple client library for version V1beta of the AdMob API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/admob.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-admob_v1beta', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-admob_v1beta
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/admob_v1beta"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::AdmobV1beta::AdMobService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Admob service in particular.)
67
+
68
+ For reference information on specific calls in the AdMob API, see the {Google::Apis::AdmobV1beta::AdMobService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-admob_v1beta`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://developers.google.com/admob/api/) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require "google/apis/admob_v1beta"
@@ -0,0 +1,40 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/admob_v1beta/service.rb'
16
+ require 'google/apis/admob_v1beta/classes.rb'
17
+ require 'google/apis/admob_v1beta/representations.rb'
18
+ require 'google/apis/admob_v1beta/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # AdMob API
23
+ #
24
+ # The AdMob API allows publishers to programmatically get information about
25
+ # their AdMob account.
26
+ #
27
+ # @see https://developers.google.com/admob/api/
28
+ module AdmobV1beta
29
+ # Version of the AdMob API this client connects to.
30
+ # This is NOT the gem version.
31
+ VERSION = 'V1beta'
32
+
33
+ # See your AdMob data
34
+ AUTH_ADMOB_READONLY = 'https://www.googleapis.com/auth/admob.readonly'
35
+
36
+ # See your AdMob data
37
+ AUTH_ADMOB_REPORT = 'https://www.googleapis.com/auth/admob.report'
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,1035 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module AdmobV1beta
24
+
25
+ # Describes an AdMob ad unit.
26
+ class AdUnit
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # AdFormat of the ad unit. Possible values are as follows: "BANNER" - Banner ad
30
+ # format. "BANNER_INTERSTITIAL" - Legacy format that can be used as either
31
+ # banner or interstitial. This format can no longer be created but can be
32
+ # targeted by mediation groups. "INTERSTITIAL" - A full screen ad. Supported ad
33
+ # types are "RICH_MEDIA" and "VIDEO". "NATIVE" - Native ad format. "REWARDED" -
34
+ # An ad that, once viewed, gets a callback verifying the view so that a reward
35
+ # can be given to the user. Supported ad types are "RICH_MEDIA" (interactive)
36
+ # and video where video can not be excluded.
37
+ # Corresponds to the JSON property `adFormat`
38
+ # @return [String]
39
+ attr_accessor :ad_format
40
+
41
+ # Ad media type supported by this ad unit. Possible values as follows: "
42
+ # RICH_MEDIA" - Text, image, and other non-video media. "VIDEO" - Video media.
43
+ # Corresponds to the JSON property `adTypes`
44
+ # @return [Array<String>]
45
+ attr_accessor :ad_types
46
+
47
+ # The externally visible ID of the ad unit which can be used to integrate with
48
+ # the AdMob SDK. This is a read only property. Example: ca-app-pub-
49
+ # 9876543210987654/0123456789
50
+ # Corresponds to the JSON property `adUnitId`
51
+ # @return [String]
52
+ attr_accessor :ad_unit_id
53
+
54
+ # The externally visible ID of the app this ad unit is associated with. Example:
55
+ # ca-app-pub-9876543210987654~0123456789
56
+ # Corresponds to the JSON property `appId`
57
+ # @return [String]
58
+ attr_accessor :app_id
59
+
60
+ # The display name of the ad unit as shown in the AdMob UI, which is provided by
61
+ # the user. The maximum length allowed is 80 characters.
62
+ # Corresponds to the JSON property `displayName`
63
+ # @return [String]
64
+ attr_accessor :display_name
65
+
66
+ # Resource name for this ad unit. Format is accounts/`publisher_id`/adUnits/`
67
+ # ad_unit_id_fragment` Example: accounts/pub-9876543210987654/adUnits/0123456789
68
+ # Corresponds to the JSON property `name`
69
+ # @return [String]
70
+ attr_accessor :name
71
+
72
+ def initialize(**args)
73
+ update!(**args)
74
+ end
75
+
76
+ # Update properties of this object
77
+ def update!(**args)
78
+ @ad_format = args[:ad_format] if args.key?(:ad_format)
79
+ @ad_types = args[:ad_types] if args.key?(:ad_types)
80
+ @ad_unit_id = args[:ad_unit_id] if args.key?(:ad_unit_id)
81
+ @app_id = args[:app_id] if args.key?(:app_id)
82
+ @display_name = args[:display_name] if args.key?(:display_name)
83
+ @name = args[:name] if args.key?(:name)
84
+ end
85
+ end
86
+
87
+ # Describes an AdMob app for a specific platform (For example: Android or iOS).
88
+ class App
89
+ include Google::Apis::Core::Hashable
90
+
91
+ # The externally visible ID of the app which can be used to integrate with the
92
+ # AdMob SDK. This is a read only property. Example: ca-app-pub-9876543210987654~
93
+ # 0123456789
94
+ # Corresponds to the JSON property `appId`
95
+ # @return [String]
96
+ attr_accessor :app_id
97
+
98
+ # Information from the app store if the app is linked to an app store.
99
+ # Corresponds to the JSON property `linkedAppInfo`
100
+ # @return [Google::Apis::AdmobV1beta::AppLinkedAppInfo]
101
+ attr_accessor :linked_app_info
102
+
103
+ # Information provided for manual apps which are not linked to an application
104
+ # store (Example: Google Play, App Store).
105
+ # Corresponds to the JSON property `manualAppInfo`
106
+ # @return [Google::Apis::AdmobV1beta::AppManualAppInfo]
107
+ attr_accessor :manual_app_info
108
+
109
+ # Resource name for this app. Format is accounts/`publisher_id`/apps/`
110
+ # app_id_fragment` Example: accounts/pub-9876543210987654/apps/0123456789
111
+ # Corresponds to the JSON property `name`
112
+ # @return [String]
113
+ attr_accessor :name
114
+
115
+ # Describes the platform of the app. Limited to "IOS" and "ANDROID".
116
+ # Corresponds to the JSON property `platform`
117
+ # @return [String]
118
+ attr_accessor :platform
119
+
120
+ def initialize(**args)
121
+ update!(**args)
122
+ end
123
+
124
+ # Update properties of this object
125
+ def update!(**args)
126
+ @app_id = args[:app_id] if args.key?(:app_id)
127
+ @linked_app_info = args[:linked_app_info] if args.key?(:linked_app_info)
128
+ @manual_app_info = args[:manual_app_info] if args.key?(:manual_app_info)
129
+ @name = args[:name] if args.key?(:name)
130
+ @platform = args[:platform] if args.key?(:platform)
131
+ end
132
+ end
133
+
134
+ # Information from the app store if the app is linked to an app store.
135
+ class AppLinkedAppInfo
136
+ include Google::Apis::Core::Hashable
137
+
138
+ # The app store ID of the app; present if and only if the app is linked to an
139
+ # app store. If the app is added to the Google Play store, it will be the
140
+ # application ID of the app. For example: "com.example.myapp". See https://
141
+ # developer.android.com/studio/build/application-id. If the app is added to the
142
+ # Apple App Store, it will be app store ID. For example "105169111". Note that
143
+ # setting the app store id is considered an irreversible action. Once an app is
144
+ # linked, it cannot be unlinked.
145
+ # Corresponds to the JSON property `appStoreId`
146
+ # @return [String]
147
+ attr_accessor :app_store_id
148
+
149
+ # Output only. Display name of the app as it appears in the app store. This is
150
+ # an output-only field, and may be empty if the app cannot be found in the store.
151
+ # Corresponds to the JSON property `displayName`
152
+ # @return [String]
153
+ attr_accessor :display_name
154
+
155
+ def initialize(**args)
156
+ update!(**args)
157
+ end
158
+
159
+ # Update properties of this object
160
+ def update!(**args)
161
+ @app_store_id = args[:app_store_id] if args.key?(:app_store_id)
162
+ @display_name = args[:display_name] if args.key?(:display_name)
163
+ end
164
+ end
165
+
166
+ # Information provided for manual apps which are not linked to an application
167
+ # store (Example: Google Play, App Store).
168
+ class AppManualAppInfo
169
+ include Google::Apis::Core::Hashable
170
+
171
+ # The display name of the app as shown in the AdMob UI, which is provided by the
172
+ # user. The maximum length allowed is 80 characters.
173
+ # Corresponds to the JSON property `displayName`
174
+ # @return [String]
175
+ attr_accessor :display_name
176
+
177
+ def initialize(**args)
178
+ update!(**args)
179
+ end
180
+
181
+ # Update properties of this object
182
+ def update!(**args)
183
+ @display_name = args[:display_name] if args.key?(:display_name)
184
+ end
185
+ end
186
+
187
+ # Represents a whole or partial calendar date, such as a birthday. The time of
188
+ # day and time zone are either specified elsewhere or are insignificant. The
189
+ # date is relative to the Gregorian Calendar. This can represent one of the
190
+ # following: * A full date, with non-zero year, month, and day values * A month
191
+ # and day value, with a zero year, such as an anniversary * A year on its own,
192
+ # with zero month and day values * A year and month value, with a zero day, such
193
+ # as a credit card expiration date Related types are google.type.TimeOfDay and `
194
+ # google.protobuf.Timestamp`.
195
+ class Date
196
+ include Google::Apis::Core::Hashable
197
+
198
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
199
+ # specify a year by itself or a year and month where the day isn't significant.
200
+ # Corresponds to the JSON property `day`
201
+ # @return [Fixnum]
202
+ attr_accessor :day
203
+
204
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
205
+ # and day.
206
+ # Corresponds to the JSON property `month`
207
+ # @return [Fixnum]
208
+ attr_accessor :month
209
+
210
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
211
+ # year.
212
+ # Corresponds to the JSON property `year`
213
+ # @return [Fixnum]
214
+ attr_accessor :year
215
+
216
+ def initialize(**args)
217
+ update!(**args)
218
+ end
219
+
220
+ # Update properties of this object
221
+ def update!(**args)
222
+ @day = args[:day] if args.key?(:day)
223
+ @month = args[:month] if args.key?(:month)
224
+ @year = args[:year] if args.key?(:year)
225
+ end
226
+ end
227
+
228
+ # Specification of a single date range. Both dates are inclusive.
229
+ class DateRange
230
+ include Google::Apis::Core::Hashable
231
+
232
+ # Represents a whole or partial calendar date, such as a birthday. The time of
233
+ # day and time zone are either specified elsewhere or are insignificant. The
234
+ # date is relative to the Gregorian Calendar. This can represent one of the
235
+ # following: * A full date, with non-zero year, month, and day values * A month
236
+ # and day value, with a zero year, such as an anniversary * A year on its own,
237
+ # with zero month and day values * A year and month value, with a zero day, such
238
+ # as a credit card expiration date Related types are google.type.TimeOfDay and `
239
+ # google.protobuf.Timestamp`.
240
+ # Corresponds to the JSON property `endDate`
241
+ # @return [Google::Apis::AdmobV1beta::Date]
242
+ attr_accessor :end_date
243
+
244
+ # Represents a whole or partial calendar date, such as a birthday. The time of
245
+ # day and time zone are either specified elsewhere or are insignificant. The
246
+ # date is relative to the Gregorian Calendar. This can represent one of the
247
+ # following: * A full date, with non-zero year, month, and day values * A month
248
+ # and day value, with a zero year, such as an anniversary * A year on its own,
249
+ # with zero month and day values * A year and month value, with a zero day, such
250
+ # as a credit card expiration date Related types are google.type.TimeOfDay and `
251
+ # google.protobuf.Timestamp`.
252
+ # Corresponds to the JSON property `startDate`
253
+ # @return [Google::Apis::AdmobV1beta::Date]
254
+ attr_accessor :start_date
255
+
256
+ def initialize(**args)
257
+ update!(**args)
258
+ end
259
+
260
+ # Update properties of this object
261
+ def update!(**args)
262
+ @end_date = args[:end_date] if args.key?(:end_date)
263
+ @start_date = args[:start_date] if args.key?(:start_date)
264
+ end
265
+ end
266
+
267
+ # Request to generate an AdMob Mediation report.
268
+ class GenerateMediationReportRequest
269
+ include Google::Apis::Core::Hashable
270
+
271
+ # The specification for generating an AdMob Mediation report. For example, the
272
+ # specification to get observed ECPM sliced by ad source and app for the 'US'
273
+ # and 'CN' countries can look like the following example: ` "date_range": ` "
274
+ # start_date": `"year": 2018, "month": 9, "day": 1`, "end_date": `"year": 2018, "
275
+ # month": 9, "day": 30` `, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], "
276
+ # metrics": ["OBSERVED_ECPM"], "dimension_filters": [ ` "dimension": "COUNTRY", "
277
+ # matches_any": `"values": [`"value": "US", "value": "CN"`]` ` ], "
278
+ # sort_conditions": [ `"dimension":"APP", order: "ASCENDING"` ], "
279
+ # localization_settings": ` "currency_code": "USD", "language_code": "en-US" ` `
280
+ # For a better understanding, you can treat the preceding specification like the
281
+ # following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM
282
+ # MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND
283
+ # COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;
284
+ # Corresponds to the JSON property `reportSpec`
285
+ # @return [Google::Apis::AdmobV1beta::MediationReportSpec]
286
+ attr_accessor :report_spec
287
+
288
+ def initialize(**args)
289
+ update!(**args)
290
+ end
291
+
292
+ # Update properties of this object
293
+ def update!(**args)
294
+ @report_spec = args[:report_spec] if args.key?(:report_spec)
295
+ end
296
+ end
297
+
298
+ # The streaming response for the AdMob Mediation report where the first response
299
+ # contains the report header, then a stream of row responses, and finally a
300
+ # footer as the last response message. For example: [` "header": ` "date_range":
301
+ # ` "start_date": `"year": 2018, "month": 9, "day": 1`, "end_date": `"year":
302
+ # 2018, "month": 9, "day": 1` `, "localization_settings": ` "currency_code": "
303
+ # USD", "language_code": "en-US" ` ` `, ` "row": ` "dimension_values": ` "DATE":
304
+ # `"value": "20180918"`, "APP": ` "value": "ca-app-pub-8123415297019784~
305
+ # 1001342552", "display_label": "My app name!" ` `, "metric_values": ` "
306
+ # ESTIMATED_EARNINGS": `"decimal_value": "1324746"` ` ` `, ` "footer": `"
307
+ # matching_row_count": 1` `]
308
+ class GenerateMediationReportResponse
309
+ include Google::Apis::Core::Hashable
310
+
311
+ # Groups data available after report generation, for example, warnings and row
312
+ # counts. Always sent as the last message in the stream response.
313
+ # Corresponds to the JSON property `footer`
314
+ # @return [Google::Apis::AdmobV1beta::ReportFooter]
315
+ attr_accessor :footer
316
+
317
+ # Groups data helps to treat the generated report. Always sent as a first
318
+ # message in the stream response.
319
+ # Corresponds to the JSON property `header`
320
+ # @return [Google::Apis::AdmobV1beta::ReportHeader]
321
+ attr_accessor :header
322
+
323
+ # A row of the returning report.
324
+ # Corresponds to the JSON property `row`
325
+ # @return [Google::Apis::AdmobV1beta::ReportRow]
326
+ attr_accessor :row
327
+
328
+ def initialize(**args)
329
+ update!(**args)
330
+ end
331
+
332
+ # Update properties of this object
333
+ def update!(**args)
334
+ @footer = args[:footer] if args.key?(:footer)
335
+ @header = args[:header] if args.key?(:header)
336
+ @row = args[:row] if args.key?(:row)
337
+ end
338
+ end
339
+
340
+ # Request to generate an AdMob Network report.
341
+ class GenerateNetworkReportRequest
342
+ include Google::Apis::Core::Hashable
343
+
344
+ # The specification for generating an AdMob Network report. For example, the
345
+ # specification to get clicks and estimated earnings for only the 'US' and 'CN'
346
+ # countries can look like the following example: ` 'date_range': ` 'start_date':
347
+ # `'year': 2018, 'month': 9, 'day': 1`, 'end_date': `'year': 2018, 'month': 9, '
348
+ # day': 30` `, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', '
349
+ # ESTIMATED_EARNINGS'], 'dimension_filters': [ ` 'dimension': 'COUNTRY', '
350
+ # matches_any': `'values': [`'value': 'US', 'value': 'CN'`]` ` ], '
351
+ # sort_conditions': [ `'dimension':'APP', order: 'ASCENDING'`, `'metric':'CLICKS'
352
+ # , order: 'DESCENDING'` ], 'localization_settings': ` 'currency_code': 'USD', '
353
+ # language_code': 'en-US' ` ` For a better understanding, you can treat the
354
+ # preceding specification like the following pseudo SQL: SELECT DATE, APP,
355
+ # COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2018-09-
356
+ # 01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP,
357
+ # COUNTRY ORDER BY APP ASC, CLICKS DESC;
358
+ # Corresponds to the JSON property `reportSpec`
359
+ # @return [Google::Apis::AdmobV1beta::NetworkReportSpec]
360
+ attr_accessor :report_spec
361
+
362
+ def initialize(**args)
363
+ update!(**args)
364
+ end
365
+
366
+ # Update properties of this object
367
+ def update!(**args)
368
+ @report_spec = args[:report_spec] if args.key?(:report_spec)
369
+ end
370
+ end
371
+
372
+ # The streaming response for the AdMob Network report where the first response
373
+ # contains the report header, then a stream of row responses, and finally a
374
+ # footer as the last response message. For example: [` "header": ` "dateRange": `
375
+ # "startDate": `"year": 2018, "month": 9, "day": 1`, "endDate": `"year": 2018, "
376
+ # month": 9, "day": 1` `, "localizationSettings": ` "currencyCode": "USD", "
377
+ # languageCode": "en-US" ` ` `, ` "row": ` "dimensionValues": ` "DATE": `"value":
378
+ # "20180918"`, "APP": ` "value": "ca-app-pub-8123415297019784~1001342552",
379
+ # displayLabel: "My app name!" ` `, "metricValues": ` "ESTIMATED_EARNINGS": `"
380
+ # microsValue": 6500000` ` ` `, ` "footer": `"matchingRowCount": 1` `]
381
+ class GenerateNetworkReportResponse
382
+ include Google::Apis::Core::Hashable
383
+
384
+ # Groups data available after report generation, for example, warnings and row
385
+ # counts. Always sent as the last message in the stream response.
386
+ # Corresponds to the JSON property `footer`
387
+ # @return [Google::Apis::AdmobV1beta::ReportFooter]
388
+ attr_accessor :footer
389
+
390
+ # Groups data helps to treat the generated report. Always sent as a first
391
+ # message in the stream response.
392
+ # Corresponds to the JSON property `header`
393
+ # @return [Google::Apis::AdmobV1beta::ReportHeader]
394
+ attr_accessor :header
395
+
396
+ # A row of the returning report.
397
+ # Corresponds to the JSON property `row`
398
+ # @return [Google::Apis::AdmobV1beta::ReportRow]
399
+ attr_accessor :row
400
+
401
+ def initialize(**args)
402
+ update!(**args)
403
+ end
404
+
405
+ # Update properties of this object
406
+ def update!(**args)
407
+ @footer = args[:footer] if args.key?(:footer)
408
+ @header = args[:header] if args.key?(:header)
409
+ @row = args[:row] if args.key?(:row)
410
+ end
411
+ end
412
+
413
+ # Response for the ad units list request.
414
+ class ListAdUnitsResponse
415
+ include Google::Apis::Core::Hashable
416
+
417
+ # The resulting ad units for the requested account.
418
+ # Corresponds to the JSON property `adUnits`
419
+ # @return [Array<Google::Apis::AdmobV1beta::AdUnit>]
420
+ attr_accessor :ad_units
421
+
422
+ # If not empty, indicates that there may be more ad units for the request; this
423
+ # value should be passed in a new `ListAdUnitsRequest`.
424
+ # Corresponds to the JSON property `nextPageToken`
425
+ # @return [String]
426
+ attr_accessor :next_page_token
427
+
428
+ def initialize(**args)
429
+ update!(**args)
430
+ end
431
+
432
+ # Update properties of this object
433
+ def update!(**args)
434
+ @ad_units = args[:ad_units] if args.key?(:ad_units)
435
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
436
+ end
437
+ end
438
+
439
+ # Response for the apps list request.
440
+ class ListAppsResponse
441
+ include Google::Apis::Core::Hashable
442
+
443
+ # The resulting apps for the requested account.
444
+ # Corresponds to the JSON property `apps`
445
+ # @return [Array<Google::Apis::AdmobV1beta::App>]
446
+ attr_accessor :apps
447
+
448
+ # If not empty, indicates that there may be more apps for the request; this
449
+ # value should be passed in a new `ListAppsRequest`.
450
+ # Corresponds to the JSON property `nextPageToken`
451
+ # @return [String]
452
+ attr_accessor :next_page_token
453
+
454
+ def initialize(**args)
455
+ update!(**args)
456
+ end
457
+
458
+ # Update properties of this object
459
+ def update!(**args)
460
+ @apps = args[:apps] if args.key?(:apps)
461
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
462
+ end
463
+ end
464
+
465
+ # Response for the publisher account list request.
466
+ class ListPublisherAccountsResponse
467
+ include Google::Apis::Core::Hashable
468
+
469
+ # Publisher that the client credentials can access.
470
+ # Corresponds to the JSON property `account`
471
+ # @return [Array<Google::Apis::AdmobV1beta::PublisherAccount>]
472
+ attr_accessor :account
473
+
474
+ # If not empty, indicates that there might be more accounts for the request; you
475
+ # must pass this value in a new `ListPublisherAccountsRequest`.
476
+ # Corresponds to the JSON property `nextPageToken`
477
+ # @return [String]
478
+ attr_accessor :next_page_token
479
+
480
+ def initialize(**args)
481
+ update!(**args)
482
+ end
483
+
484
+ # Update properties of this object
485
+ def update!(**args)
486
+ @account = args[:account] if args.key?(:account)
487
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
488
+ end
489
+ end
490
+
491
+ # Localization settings for reports, such as currency and language. It affects
492
+ # how metrics are calculated.
493
+ class LocalizationSettings
494
+ include Google::Apis::Core::Hashable
495
+
496
+ # Currency code of the earning related metrics, which is the 3-letter code
497
+ # defined in ISO 4217. The daily average rate is used for the currency
498
+ # conversion. Defaults to the account currency code if unspecified.
499
+ # Corresponds to the JSON property `currencyCode`
500
+ # @return [String]
501
+ attr_accessor :currency_code
502
+
503
+ # Language used for any localized text, such as some dimension value display
504
+ # labels. The language tag defined in the IETF BCP47. Defaults to 'en-US' if
505
+ # unspecified.
506
+ # Corresponds to the JSON property `languageCode`
507
+ # @return [String]
508
+ attr_accessor :language_code
509
+
510
+ def initialize(**args)
511
+ update!(**args)
512
+ end
513
+
514
+ # Update properties of this object
515
+ def update!(**args)
516
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
517
+ @language_code = args[:language_code] if args.key?(:language_code)
518
+ end
519
+ end
520
+
521
+ # The specification for generating an AdMob Mediation report. For example, the
522
+ # specification to get observed ECPM sliced by ad source and app for the 'US'
523
+ # and 'CN' countries can look like the following example: ` "date_range": ` "
524
+ # start_date": `"year": 2018, "month": 9, "day": 1`, "end_date": `"year": 2018, "
525
+ # month": 9, "day": 30` `, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], "
526
+ # metrics": ["OBSERVED_ECPM"], "dimension_filters": [ ` "dimension": "COUNTRY", "
527
+ # matches_any": `"values": [`"value": "US", "value": "CN"`]` ` ], "
528
+ # sort_conditions": [ `"dimension":"APP", order: "ASCENDING"` ], "
529
+ # localization_settings": ` "currency_code": "USD", "language_code": "en-US" ` `
530
+ # For a better understanding, you can treat the preceding specification like the
531
+ # following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM
532
+ # MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND
533
+ # COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;
534
+ class MediationReportSpec
535
+ include Google::Apis::Core::Hashable
536
+
537
+ # Specification of a single date range. Both dates are inclusive.
538
+ # Corresponds to the JSON property `dateRange`
539
+ # @return [Google::Apis::AdmobV1beta::DateRange]
540
+ attr_accessor :date_range
541
+
542
+ # Describes which report rows to match based on their dimension values.
543
+ # Corresponds to the JSON property `dimensionFilters`
544
+ # @return [Array<Google::Apis::AdmobV1beta::MediationReportSpecDimensionFilter>]
545
+ attr_accessor :dimension_filters
546
+
547
+ # List of dimensions of the report. The value combination of these dimensions
548
+ # determines the row of the report. If no dimensions are specified, the report
549
+ # returns a single row of requested metrics for the entire account.
550
+ # Corresponds to the JSON property `dimensions`
551
+ # @return [Array<String>]
552
+ attr_accessor :dimensions
553
+
554
+ # Localization settings for reports, such as currency and language. It affects
555
+ # how metrics are calculated.
556
+ # Corresponds to the JSON property `localizationSettings`
557
+ # @return [Google::Apis::AdmobV1beta::LocalizationSettings]
558
+ attr_accessor :localization_settings
559
+
560
+ # Maximum number of report data rows to return. If the value is not set, the API
561
+ # returns as many rows as possible, up to 100000. Acceptable values are 1-100000,
562
+ # inclusive. Values larger than 100000 return an error.
563
+ # Corresponds to the JSON property `maxReportRows`
564
+ # @return [Fixnum]
565
+ attr_accessor :max_report_rows
566
+
567
+ # List of metrics of the report. A report must specify at least one metric.
568
+ # Corresponds to the JSON property `metrics`
569
+ # @return [Array<String>]
570
+ attr_accessor :metrics
571
+
572
+ # Describes the sorting of report rows. The order of the condition in the list
573
+ # defines its precedence; the earlier the condition, the higher its precedence.
574
+ # If no sort conditions are specified, the row ordering is undefined.
575
+ # Corresponds to the JSON property `sortConditions`
576
+ # @return [Array<Google::Apis::AdmobV1beta::MediationReportSpecSortCondition>]
577
+ attr_accessor :sort_conditions
578
+
579
+ # A report time zone. Accepts an IANA TZ name values, such as "America/
580
+ # Los_Angeles." If no time zone is defined, the account default takes effect.
581
+ # Check default value by the get account action. **Warning:** The "America/
582
+ # Los_Angeles" is the only supported value at the moment.
583
+ # Corresponds to the JSON property `timeZone`
584
+ # @return [String]
585
+ attr_accessor :time_zone
586
+
587
+ def initialize(**args)
588
+ update!(**args)
589
+ end
590
+
591
+ # Update properties of this object
592
+ def update!(**args)
593
+ @date_range = args[:date_range] if args.key?(:date_range)
594
+ @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters)
595
+ @dimensions = args[:dimensions] if args.key?(:dimensions)
596
+ @localization_settings = args[:localization_settings] if args.key?(:localization_settings)
597
+ @max_report_rows = args[:max_report_rows] if args.key?(:max_report_rows)
598
+ @metrics = args[:metrics] if args.key?(:metrics)
599
+ @sort_conditions = args[:sort_conditions] if args.key?(:sort_conditions)
600
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
601
+ end
602
+ end
603
+
604
+ # Describes which report rows to match based on their dimension values.
605
+ class MediationReportSpecDimensionFilter
606
+ include Google::Apis::Core::Hashable
607
+
608
+ # Applies the filter criterion to the specified dimension.
609
+ # Corresponds to the JSON property `dimension`
610
+ # @return [String]
611
+ attr_accessor :dimension
612
+
613
+ # List of string values.
614
+ # Corresponds to the JSON property `matchesAny`
615
+ # @return [Google::Apis::AdmobV1beta::StringList]
616
+ attr_accessor :matches_any
617
+
618
+ def initialize(**args)
619
+ update!(**args)
620
+ end
621
+
622
+ # Update properties of this object
623
+ def update!(**args)
624
+ @dimension = args[:dimension] if args.key?(:dimension)
625
+ @matches_any = args[:matches_any] if args.key?(:matches_any)
626
+ end
627
+ end
628
+
629
+ # Sorting direction to be applied on a dimension or a metric.
630
+ class MediationReportSpecSortCondition
631
+ include Google::Apis::Core::Hashable
632
+
633
+ # Sort by the specified dimension.
634
+ # Corresponds to the JSON property `dimension`
635
+ # @return [String]
636
+ attr_accessor :dimension
637
+
638
+ # Sort by the specified metric.
639
+ # Corresponds to the JSON property `metric`
640
+ # @return [String]
641
+ attr_accessor :metric
642
+
643
+ # Sorting order of the dimension or metric.
644
+ # Corresponds to the JSON property `order`
645
+ # @return [String]
646
+ attr_accessor :order
647
+
648
+ def initialize(**args)
649
+ update!(**args)
650
+ end
651
+
652
+ # Update properties of this object
653
+ def update!(**args)
654
+ @dimension = args[:dimension] if args.key?(:dimension)
655
+ @metric = args[:metric] if args.key?(:metric)
656
+ @order = args[:order] if args.key?(:order)
657
+ end
658
+ end
659
+
660
+ # The specification for generating an AdMob Network report. For example, the
661
+ # specification to get clicks and estimated earnings for only the 'US' and 'CN'
662
+ # countries can look like the following example: ` 'date_range': ` 'start_date':
663
+ # `'year': 2018, 'month': 9, 'day': 1`, 'end_date': `'year': 2018, 'month': 9, '
664
+ # day': 30` `, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', '
665
+ # ESTIMATED_EARNINGS'], 'dimension_filters': [ ` 'dimension': 'COUNTRY', '
666
+ # matches_any': `'values': [`'value': 'US', 'value': 'CN'`]` ` ], '
667
+ # sort_conditions': [ `'dimension':'APP', order: 'ASCENDING'`, `'metric':'CLICKS'
668
+ # , order: 'DESCENDING'` ], 'localization_settings': ` 'currency_code': 'USD', '
669
+ # language_code': 'en-US' ` ` For a better understanding, you can treat the
670
+ # preceding specification like the following pseudo SQL: SELECT DATE, APP,
671
+ # COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2018-09-
672
+ # 01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP,
673
+ # COUNTRY ORDER BY APP ASC, CLICKS DESC;
674
+ class NetworkReportSpec
675
+ include Google::Apis::Core::Hashable
676
+
677
+ # Specification of a single date range. Both dates are inclusive.
678
+ # Corresponds to the JSON property `dateRange`
679
+ # @return [Google::Apis::AdmobV1beta::DateRange]
680
+ attr_accessor :date_range
681
+
682
+ # Describes which report rows to match based on their dimension values.
683
+ # Corresponds to the JSON property `dimensionFilters`
684
+ # @return [Array<Google::Apis::AdmobV1beta::NetworkReportSpecDimensionFilter>]
685
+ attr_accessor :dimension_filters
686
+
687
+ # List of dimensions of the report. The value combination of these dimensions
688
+ # determines the row of the report. If no dimensions are specified, the report
689
+ # returns a single row of requested metrics for the entire account.
690
+ # Corresponds to the JSON property `dimensions`
691
+ # @return [Array<String>]
692
+ attr_accessor :dimensions
693
+
694
+ # Localization settings for reports, such as currency and language. It affects
695
+ # how metrics are calculated.
696
+ # Corresponds to the JSON property `localizationSettings`
697
+ # @return [Google::Apis::AdmobV1beta::LocalizationSettings]
698
+ attr_accessor :localization_settings
699
+
700
+ # Maximum number of report data rows to return. If the value is not set, the API
701
+ # returns as many rows as possible, up to 100000. Acceptable values are 1-100000,
702
+ # inclusive. Values larger than 100000 return an error.
703
+ # Corresponds to the JSON property `maxReportRows`
704
+ # @return [Fixnum]
705
+ attr_accessor :max_report_rows
706
+
707
+ # List of metrics of the report. A report must specify at least one metric.
708
+ # Corresponds to the JSON property `metrics`
709
+ # @return [Array<String>]
710
+ attr_accessor :metrics
711
+
712
+ # Describes the sorting of report rows. The order of the condition in the list
713
+ # defines its precedence; the earlier the condition, the higher its precedence.
714
+ # If no sort conditions are specified, the row ordering is undefined.
715
+ # Corresponds to the JSON property `sortConditions`
716
+ # @return [Array<Google::Apis::AdmobV1beta::NetworkReportSpecSortCondition>]
717
+ attr_accessor :sort_conditions
718
+
719
+ # A report time zone. Accepts an IANA TZ name values, such as "America/
720
+ # Los_Angeles." If no time zone is defined, the account default takes effect.
721
+ # Check default value by the get account action. **Warning:** The "America/
722
+ # Los_Angeles" is the only supported value at the moment.
723
+ # Corresponds to the JSON property `timeZone`
724
+ # @return [String]
725
+ attr_accessor :time_zone
726
+
727
+ def initialize(**args)
728
+ update!(**args)
729
+ end
730
+
731
+ # Update properties of this object
732
+ def update!(**args)
733
+ @date_range = args[:date_range] if args.key?(:date_range)
734
+ @dimension_filters = args[:dimension_filters] if args.key?(:dimension_filters)
735
+ @dimensions = args[:dimensions] if args.key?(:dimensions)
736
+ @localization_settings = args[:localization_settings] if args.key?(:localization_settings)
737
+ @max_report_rows = args[:max_report_rows] if args.key?(:max_report_rows)
738
+ @metrics = args[:metrics] if args.key?(:metrics)
739
+ @sort_conditions = args[:sort_conditions] if args.key?(:sort_conditions)
740
+ @time_zone = args[:time_zone] if args.key?(:time_zone)
741
+ end
742
+ end
743
+
744
+ # Describes which report rows to match based on their dimension values.
745
+ class NetworkReportSpecDimensionFilter
746
+ include Google::Apis::Core::Hashable
747
+
748
+ # Applies the filter criterion to the specified dimension.
749
+ # Corresponds to the JSON property `dimension`
750
+ # @return [String]
751
+ attr_accessor :dimension
752
+
753
+ # List of string values.
754
+ # Corresponds to the JSON property `matchesAny`
755
+ # @return [Google::Apis::AdmobV1beta::StringList]
756
+ attr_accessor :matches_any
757
+
758
+ def initialize(**args)
759
+ update!(**args)
760
+ end
761
+
762
+ # Update properties of this object
763
+ def update!(**args)
764
+ @dimension = args[:dimension] if args.key?(:dimension)
765
+ @matches_any = args[:matches_any] if args.key?(:matches_any)
766
+ end
767
+ end
768
+
769
+ # Sorting direction to be applied on a dimension or a metric.
770
+ class NetworkReportSpecSortCondition
771
+ include Google::Apis::Core::Hashable
772
+
773
+ # Sort by the specified dimension.
774
+ # Corresponds to the JSON property `dimension`
775
+ # @return [String]
776
+ attr_accessor :dimension
777
+
778
+ # Sort by the specified metric.
779
+ # Corresponds to the JSON property `metric`
780
+ # @return [String]
781
+ attr_accessor :metric
782
+
783
+ # Sorting order of the dimension or metric.
784
+ # Corresponds to the JSON property `order`
785
+ # @return [String]
786
+ attr_accessor :order
787
+
788
+ def initialize(**args)
789
+ update!(**args)
790
+ end
791
+
792
+ # Update properties of this object
793
+ def update!(**args)
794
+ @dimension = args[:dimension] if args.key?(:dimension)
795
+ @metric = args[:metric] if args.key?(:metric)
796
+ @order = args[:order] if args.key?(:order)
797
+ end
798
+ end
799
+
800
+ # A publisher account contains information relevant to the use of this API, such
801
+ # as the time zone used for the reports.
802
+ class PublisherAccount
803
+ include Google::Apis::Core::Hashable
804
+
805
+ # Currency code of the earning-related metrics, which is the 3-letter code
806
+ # defined in ISO 4217. The daily average rate is used for the currency
807
+ # conversion.
808
+ # Corresponds to the JSON property `currencyCode`
809
+ # @return [String]
810
+ attr_accessor :currency_code
811
+
812
+ # Resource name of this account. Format is accounts/`publisher_id`.
813
+ # Corresponds to the JSON property `name`
814
+ # @return [String]
815
+ attr_accessor :name
816
+
817
+ # The unique ID by which this publisher account can be identified in the API
818
+ # requests (for example, pub-1234567890).
819
+ # Corresponds to the JSON property `publisherId`
820
+ # @return [String]
821
+ attr_accessor :publisher_id
822
+
823
+ # The time zone that is used in reports that are generated for this account. The
824
+ # value is a time-zone ID as specified by the CLDR project, for example, "
825
+ # America/Los_Angeles".
826
+ # Corresponds to the JSON property `reportingTimeZone`
827
+ # @return [String]
828
+ attr_accessor :reporting_time_zone
829
+
830
+ def initialize(**args)
831
+ update!(**args)
832
+ end
833
+
834
+ # Update properties of this object
835
+ def update!(**args)
836
+ @currency_code = args[:currency_code] if args.key?(:currency_code)
837
+ @name = args[:name] if args.key?(:name)
838
+ @publisher_id = args[:publisher_id] if args.key?(:publisher_id)
839
+ @reporting_time_zone = args[:reporting_time_zone] if args.key?(:reporting_time_zone)
840
+ end
841
+ end
842
+
843
+ # Groups data available after report generation, for example, warnings and row
844
+ # counts. Always sent as the last message in the stream response.
845
+ class ReportFooter
846
+ include Google::Apis::Core::Hashable
847
+
848
+ # Total number of rows that matched the request. Warning: This count does NOT
849
+ # always match the number of rows in the response. Do not make that assumption
850
+ # when processing the response.
851
+ # Corresponds to the JSON property `matchingRowCount`
852
+ # @return [Fixnum]
853
+ attr_accessor :matching_row_count
854
+
855
+ # Warnings associated with generation of the report.
856
+ # Corresponds to the JSON property `warnings`
857
+ # @return [Array<Google::Apis::AdmobV1beta::ReportWarning>]
858
+ attr_accessor :warnings
859
+
860
+ def initialize(**args)
861
+ update!(**args)
862
+ end
863
+
864
+ # Update properties of this object
865
+ def update!(**args)
866
+ @matching_row_count = args[:matching_row_count] if args.key?(:matching_row_count)
867
+ @warnings = args[:warnings] if args.key?(:warnings)
868
+ end
869
+ end
870
+
871
+ # Groups data helps to treat the generated report. Always sent as a first
872
+ # message in the stream response.
873
+ class ReportHeader
874
+ include Google::Apis::Core::Hashable
875
+
876
+ # Specification of a single date range. Both dates are inclusive.
877
+ # Corresponds to the JSON property `dateRange`
878
+ # @return [Google::Apis::AdmobV1beta::DateRange]
879
+ attr_accessor :date_range
880
+
881
+ # Localization settings for reports, such as currency and language. It affects
882
+ # how metrics are calculated.
883
+ # Corresponds to the JSON property `localizationSettings`
884
+ # @return [Google::Apis::AdmobV1beta::LocalizationSettings]
885
+ attr_accessor :localization_settings
886
+
887
+ # The report time zone. The value is a time-zone ID as specified by the CLDR
888
+ # project, for example, "America/Los_Angeles".
889
+ # Corresponds to the JSON property `reportingTimeZone`
890
+ # @return [String]
891
+ attr_accessor :reporting_time_zone
892
+
893
+ def initialize(**args)
894
+ update!(**args)
895
+ end
896
+
897
+ # Update properties of this object
898
+ def update!(**args)
899
+ @date_range = args[:date_range] if args.key?(:date_range)
900
+ @localization_settings = args[:localization_settings] if args.key?(:localization_settings)
901
+ @reporting_time_zone = args[:reporting_time_zone] if args.key?(:reporting_time_zone)
902
+ end
903
+ end
904
+
905
+ # A row of the returning report.
906
+ class ReportRow
907
+ include Google::Apis::Core::Hashable
908
+
909
+ # Map of dimension values in a row, with keys as enum name of the dimensions.
910
+ # Corresponds to the JSON property `dimensionValues`
911
+ # @return [Hash<String,Google::Apis::AdmobV1beta::ReportRowDimensionValue>]
912
+ attr_accessor :dimension_values
913
+
914
+ # Map of metric values in a row, with keys as enum name of the metrics. If a
915
+ # metric being requested has no value returned, the map will not include it.
916
+ # Corresponds to the JSON property `metricValues`
917
+ # @return [Hash<String,Google::Apis::AdmobV1beta::ReportRowMetricValue>]
918
+ attr_accessor :metric_values
919
+
920
+ def initialize(**args)
921
+ update!(**args)
922
+ end
923
+
924
+ # Update properties of this object
925
+ def update!(**args)
926
+ @dimension_values = args[:dimension_values] if args.key?(:dimension_values)
927
+ @metric_values = args[:metric_values] if args.key?(:metric_values)
928
+ end
929
+ end
930
+
931
+ # Representation of a dimension value.
932
+ class ReportRowDimensionValue
933
+ include Google::Apis::Core::Hashable
934
+
935
+ # The localized string representation of the value. If unspecified, the display
936
+ # label should be derived from the value.
937
+ # Corresponds to the JSON property `displayLabel`
938
+ # @return [String]
939
+ attr_accessor :display_label
940
+
941
+ # Dimension value in the format specified in the report's spec Dimension enum.
942
+ # Corresponds to the JSON property `value`
943
+ # @return [String]
944
+ attr_accessor :value
945
+
946
+ def initialize(**args)
947
+ update!(**args)
948
+ end
949
+
950
+ # Update properties of this object
951
+ def update!(**args)
952
+ @display_label = args[:display_label] if args.key?(:display_label)
953
+ @value = args[:value] if args.key?(:value)
954
+ end
955
+ end
956
+
957
+ # Representation of a metric value.
958
+ class ReportRowMetricValue
959
+ include Google::Apis::Core::Hashable
960
+
961
+ # Double precision (approximate) decimal values. Rates are from 0 to 1.
962
+ # Corresponds to the JSON property `doubleValue`
963
+ # @return [Float]
964
+ attr_accessor :double_value
965
+
966
+ # Metric integer value.
967
+ # Corresponds to the JSON property `integerValue`
968
+ # @return [Fixnum]
969
+ attr_accessor :integer_value
970
+
971
+ # Amount in micros. One million is equivalent to one unit. Currency value is in
972
+ # the unit (USD, EUR or other) specified by the request. For example, $6.50
973
+ # whould be represented as 6500000 micros.
974
+ # Corresponds to the JSON property `microsValue`
975
+ # @return [Fixnum]
976
+ attr_accessor :micros_value
977
+
978
+ def initialize(**args)
979
+ update!(**args)
980
+ end
981
+
982
+ # Update properties of this object
983
+ def update!(**args)
984
+ @double_value = args[:double_value] if args.key?(:double_value)
985
+ @integer_value = args[:integer_value] if args.key?(:integer_value)
986
+ @micros_value = args[:micros_value] if args.key?(:micros_value)
987
+ end
988
+ end
989
+
990
+ # Warnings associated with generation of the report.
991
+ class ReportWarning
992
+ include Google::Apis::Core::Hashable
993
+
994
+ # Describes the details of the warning message, in English.
995
+ # Corresponds to the JSON property `description`
996
+ # @return [String]
997
+ attr_accessor :description
998
+
999
+ # Type of the warning.
1000
+ # Corresponds to the JSON property `type`
1001
+ # @return [String]
1002
+ attr_accessor :type
1003
+
1004
+ def initialize(**args)
1005
+ update!(**args)
1006
+ end
1007
+
1008
+ # Update properties of this object
1009
+ def update!(**args)
1010
+ @description = args[:description] if args.key?(:description)
1011
+ @type = args[:type] if args.key?(:type)
1012
+ end
1013
+ end
1014
+
1015
+ # List of string values.
1016
+ class StringList
1017
+ include Google::Apis::Core::Hashable
1018
+
1019
+ # The string values.
1020
+ # Corresponds to the JSON property `values`
1021
+ # @return [Array<String>]
1022
+ attr_accessor :values
1023
+
1024
+ def initialize(**args)
1025
+ update!(**args)
1026
+ end
1027
+
1028
+ # Update properties of this object
1029
+ def update!(**args)
1030
+ @values = args[:values] if args.key?(:values)
1031
+ end
1032
+ end
1033
+ end
1034
+ end
1035
+ end