google-apis-gmailpostmastertools_v1beta1 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: 62c8e89ad66e3e0635f0d24d13bb86aeabbeb0d99c81ef967243a4ebce1b483a
4
+ data.tar.gz: 2cf3bbaa29ee29dcf4fd5fac388619fdf9ddd7eb64528f85030686ba48b4a513
5
+ SHA512:
6
+ metadata.gz: 79fa0c82ca7a407f53af1897830c7bc813f1b7d6b2df748fe3182ac420612d5c344f0bd202e0db0f87ba58c7b88af9024b13fc547a44308dfdfef3488beee504
7
+ data.tar.gz: 1746a35dfeb84e77ffa8da4a3d43d3a2b52f11da8555a55673956fccb21a3cbc3dccb0eb626fa53b07ea1e465d2bb3896bdba734091484476bdefbebb2832fa3
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-gmailpostmastertools_v1beta1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/gmailpostmastertools_v1beta1/*.rb
9
+ lib/google/apis/gmailpostmastertools_v1beta1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-gmailpostmastertools_v1beta1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20201123
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 V1beta1 of the Gmail Postmaster Tools API
2
+
3
+ This is a simple client library for version V1beta1 of the Gmail Postmaster Tools 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/gmailpostmastertools.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-gmailpostmastertools_v1beta1', '~> 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-gmailpostmastertools_v1beta1
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/gmailpostmastertools_v1beta1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::GmailpostmastertoolsV1beta1::PostmasterToolsService.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 Gmailpostmastertools service in particular.)
67
+
68
+ For reference information on specific calls in the Gmail Postmaster Tools API, see the {Google::Apis::GmailpostmastertoolsV1beta1::PostmasterToolsService 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-gmailpostmastertools_v1beta1`, 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/gmail/postmaster) 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/gmailpostmastertools_v1beta1"
@@ -0,0 +1,38 @@
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/gmailpostmastertools_v1beta1/service.rb'
16
+ require 'google/apis/gmailpostmastertools_v1beta1/classes.rb'
17
+ require 'google/apis/gmailpostmastertools_v1beta1/representations.rb'
18
+ require 'google/apis/gmailpostmastertools_v1beta1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Gmail Postmaster Tools API
23
+ #
24
+ # The Postmaster Tools API is a RESTful API that provides programmatic access to
25
+ # email traffic metrics (like spam reports, delivery errors etc) otherwise
26
+ # available through the Gmail Postmaster Tools UI currently.
27
+ #
28
+ # @see https://developers.google.com/gmail/postmaster
29
+ module GmailpostmastertoolsV1beta1
30
+ # Version of the Gmail Postmaster Tools API this client connects to.
31
+ # This is NOT the gem version.
32
+ VERSION = 'V1beta1'
33
+
34
+ # See email traffic metrics for the domains you have registered in Gmail Postmaster Tools
35
+ AUTH_POSTMASTER_READONLY = 'https://www.googleapis.com/auth/postmaster.readonly'
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,310 @@
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 GmailpostmastertoolsV1beta1
24
+
25
+ # Metric on a particular delivery error type.
26
+ class DeliveryError
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # The class of delivery error.
30
+ # Corresponds to the JSON property `errorClass`
31
+ # @return [String]
32
+ attr_accessor :error_class
33
+
34
+ # The ratio of messages where the error occurred vs all authenticated traffic.
35
+ # Corresponds to the JSON property `errorRatio`
36
+ # @return [Float]
37
+ attr_accessor :error_ratio
38
+
39
+ # The type of delivery error.
40
+ # Corresponds to the JSON property `errorType`
41
+ # @return [String]
42
+ attr_accessor :error_type
43
+
44
+ def initialize(**args)
45
+ update!(**args)
46
+ end
47
+
48
+ # Update properties of this object
49
+ def update!(**args)
50
+ @error_class = args[:error_class] if args.key?(:error_class)
51
+ @error_ratio = args[:error_ratio] if args.key?(:error_ratio)
52
+ @error_type = args[:error_type] if args.key?(:error_type)
53
+ end
54
+ end
55
+
56
+ # A registered domain resource in the Postmaster API.
57
+ class Domain
58
+ include Google::Apis::Core::Hashable
59
+
60
+ # Timestamp when the user registered this domain. Assigned by the server.
61
+ # Corresponds to the JSON property `createTime`
62
+ # @return [String]
63
+ attr_accessor :create_time
64
+
65
+ # The resource name of the Domain. Domain names have the form `domains/`
66
+ # domain_name``, where domain_name is the fully qualified domain name (i.e.,
67
+ # mymail.mydomain.com).
68
+ # Corresponds to the JSON property `name`
69
+ # @return [String]
70
+ attr_accessor :name
71
+
72
+ # User’s permission for this domain. Assigned by the server.
73
+ # Corresponds to the JSON property `permission`
74
+ # @return [String]
75
+ attr_accessor :permission
76
+
77
+ def initialize(**args)
78
+ update!(**args)
79
+ end
80
+
81
+ # Update properties of this object
82
+ def update!(**args)
83
+ @create_time = args[:create_time] if args.key?(:create_time)
84
+ @name = args[:name] if args.key?(:name)
85
+ @permission = args[:permission] if args.key?(:permission)
86
+ end
87
+ end
88
+
89
+ # [Feedback loop](https://support.google.com/mail/answer/6254652) identifier
90
+ # information.
91
+ class FeedbackLoop
92
+ include Google::Apis::Core::Hashable
93
+
94
+ # Feedback loop identifier that uniquely identifies individual campaigns.
95
+ # Corresponds to the JSON property `id`
96
+ # @return [String]
97
+ attr_accessor :id
98
+
99
+ # The ratio of user marked spam messages with the identifier vs the total number
100
+ # of inboxed messages with that identifier.
101
+ # Corresponds to the JSON property `spamRatio`
102
+ # @return [Float]
103
+ attr_accessor :spam_ratio
104
+
105
+ def initialize(**args)
106
+ update!(**args)
107
+ end
108
+
109
+ # Update properties of this object
110
+ def update!(**args)
111
+ @id = args[:id] if args.key?(:id)
112
+ @spam_ratio = args[:spam_ratio] if args.key?(:spam_ratio)
113
+ end
114
+ end
115
+
116
+ # IP Reputation information for a set of IPs in a specific reputation category.
117
+ class IpReputation
118
+ include Google::Apis::Core::Hashable
119
+
120
+ # Total number of unique IPs in this reputation category. This metric only
121
+ # pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http:/
122
+ # /www.dkim.org/).
123
+ # Corresponds to the JSON property `ipCount`
124
+ # @return [Fixnum]
125
+ attr_accessor :ip_count
126
+
127
+ # Total number of unique IPs in this reputation category. This metric only
128
+ # pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http:/
129
+ # /www.dkim.org/). Deprecated to be complied with ApiLinter for Quantities. Use
130
+ # ip_count instead.
131
+ # Corresponds to the JSON property `numIps`
132
+ # @return [Fixnum]
133
+ attr_accessor :num_ips
134
+
135
+ # The reputation category this IP reputation represents.
136
+ # Corresponds to the JSON property `reputation`
137
+ # @return [String]
138
+ attr_accessor :reputation
139
+
140
+ # A sample of IPs in this reputation category.
141
+ # Corresponds to the JSON property `sampleIps`
142
+ # @return [Array<String>]
143
+ attr_accessor :sample_ips
144
+
145
+ def initialize(**args)
146
+ update!(**args)
147
+ end
148
+
149
+ # Update properties of this object
150
+ def update!(**args)
151
+ @ip_count = args[:ip_count] if args.key?(:ip_count)
152
+ @num_ips = args[:num_ips] if args.key?(:num_ips)
153
+ @reputation = args[:reputation] if args.key?(:reputation)
154
+ @sample_ips = args[:sample_ips] if args.key?(:sample_ips)
155
+ end
156
+ end
157
+
158
+ # Response message for ListDomains.
159
+ class ListDomainsResponse
160
+ include Google::Apis::Core::Hashable
161
+
162
+ # The list of domains.
163
+ # Corresponds to the JSON property `domains`
164
+ # @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::Domain>]
165
+ attr_accessor :domains
166
+
167
+ # Token to retrieve the next page of results, or empty if there are no more
168
+ # results in the list.
169
+ # Corresponds to the JSON property `nextPageToken`
170
+ # @return [String]
171
+ attr_accessor :next_page_token
172
+
173
+ def initialize(**args)
174
+ update!(**args)
175
+ end
176
+
177
+ # Update properties of this object
178
+ def update!(**args)
179
+ @domains = args[:domains] if args.key?(:domains)
180
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
181
+ end
182
+ end
183
+
184
+ # Response message for ListTrafficStats.
185
+ class ListTrafficStatsResponse
186
+ include Google::Apis::Core::Hashable
187
+
188
+ # Token to retrieve the next page of results, or empty if there are no more
189
+ # results in the list.
190
+ # Corresponds to the JSON property `nextPageToken`
191
+ # @return [String]
192
+ attr_accessor :next_page_token
193
+
194
+ # The list of TrafficStats.
195
+ # Corresponds to the JSON property `trafficStats`
196
+ # @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats>]
197
+ attr_accessor :traffic_stats
198
+
199
+ def initialize(**args)
200
+ update!(**args)
201
+ end
202
+
203
+ # Update properties of this object
204
+ def update!(**args)
205
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
206
+ @traffic_stats = args[:traffic_stats] if args.key?(:traffic_stats)
207
+ end
208
+ end
209
+
210
+ # Email traffic statistics pertaining to a specific date.
211
+ class TrafficStats
212
+ include Google::Apis::Core::Hashable
213
+
214
+ # Delivery errors for the domain. This metric only pertains to traffic that
215
+ # passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
216
+ # Corresponds to the JSON property `deliveryErrors`
217
+ # @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError>]
218
+ attr_accessor :delivery_errors
219
+
220
+ # The ratio of mail that successfully authenticated with DKIM vs. all mail that
221
+ # attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is
222
+ # excluded.
223
+ # Corresponds to the JSON property `dkimSuccessRatio`
224
+ # @return [Float]
225
+ attr_accessor :dkim_success_ratio
226
+
227
+ # The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs
228
+ # all mail received from the domain that successfully authenticated with either
229
+ # of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
230
+ # Corresponds to the JSON property `dmarcSuccessRatio`
231
+ # @return [Float]
232
+ attr_accessor :dmarc_success_ratio
233
+
234
+ # Reputation of the domain.
235
+ # Corresponds to the JSON property `domainReputation`
236
+ # @return [String]
237
+ attr_accessor :domain_reputation
238
+
239
+ # The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs
240
+ # all mail received from that domain. This metric only pertains to traffic that
241
+ # passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
242
+ # Corresponds to the JSON property `inboundEncryptionRatio`
243
+ # @return [Float]
244
+ attr_accessor :inbound_encryption_ratio
245
+
246
+ # Reputation information pertaining to the IP addresses of the email servers for
247
+ # the domain. There is exactly one entry for each reputation category except
248
+ # REPUTATION_CATEGORY_UNSPECIFIED.
249
+ # Corresponds to the JSON property `ipReputations`
250
+ # @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::IpReputation>]
251
+ attr_accessor :ip_reputations
252
+
253
+ # The resource name of the traffic statistics. Traffic statistic names have the
254
+ # form `domains/`domain`/trafficStats/`date``, where domain_name is the fully
255
+ # qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic
256
+ # statistics pertains to and date is the date in yyyymmdd format that these
257
+ # statistics corresponds to. For example: domains/mymail.mydomain.com/
258
+ # trafficStats/20160807
259
+ # Corresponds to the JSON property `name`
260
+ # @return [String]
261
+ attr_accessor :name
262
+
263
+ # The ratio of outgoing mail (from Gmail) that was accepted over secure
264
+ # transport (TLS).
265
+ # Corresponds to the JSON property `outboundEncryptionRatio`
266
+ # @return [Float]
267
+ attr_accessor :outbound_encryption_ratio
268
+
269
+ # Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/
270
+ # 6254652) with their individual spam rates. This metric only pertains to
271
+ # traffic that is authenticated by [DKIM](http://www.dkim.org/).
272
+ # Corresponds to the JSON property `spammyFeedbackLoops`
273
+ # @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop>]
274
+ attr_accessor :spammy_feedback_loops
275
+
276
+ # The ratio of mail that successfully authenticated with SPF vs. all mail that
277
+ # attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is
278
+ # excluded.
279
+ # Corresponds to the JSON property `spfSuccessRatio`
280
+ # @return [Float]
281
+ attr_accessor :spf_success_ratio
282
+
283
+ # The ratio of user-report spam vs. email that was sent to the inbox. This
284
+ # metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
285
+ # Corresponds to the JSON property `userReportedSpamRatio`
286
+ # @return [Float]
287
+ attr_accessor :user_reported_spam_ratio
288
+
289
+ def initialize(**args)
290
+ update!(**args)
291
+ end
292
+
293
+ # Update properties of this object
294
+ def update!(**args)
295
+ @delivery_errors = args[:delivery_errors] if args.key?(:delivery_errors)
296
+ @dkim_success_ratio = args[:dkim_success_ratio] if args.key?(:dkim_success_ratio)
297
+ @dmarc_success_ratio = args[:dmarc_success_ratio] if args.key?(:dmarc_success_ratio)
298
+ @domain_reputation = args[:domain_reputation] if args.key?(:domain_reputation)
299
+ @inbound_encryption_ratio = args[:inbound_encryption_ratio] if args.key?(:inbound_encryption_ratio)
300
+ @ip_reputations = args[:ip_reputations] if args.key?(:ip_reputations)
301
+ @name = args[:name] if args.key?(:name)
302
+ @outbound_encryption_ratio = args[:outbound_encryption_ratio] if args.key?(:outbound_encryption_ratio)
303
+ @spammy_feedback_loops = args[:spammy_feedback_loops] if args.key?(:spammy_feedback_loops)
304
+ @spf_success_ratio = args[:spf_success_ratio] if args.key?(:spf_success_ratio)
305
+ @user_reported_spam_ratio = args[:user_reported_spam_ratio] if args.key?(:user_reported_spam_ratio)
306
+ end
307
+ end
308
+ end
309
+ end
310
+ end
@@ -0,0 +1,28 @@
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
+ module Google
16
+ module Apis
17
+ module GmailpostmastertoolsV1beta1
18
+ # Version of the google-apis-gmailpostmastertools_v1beta1 gem
19
+ GEM_VERSION = "0.1.0"
20
+
21
+ # Version of the code generator used to generate this client
22
+ GENERATOR_VERSION = "0.1.1"
23
+
24
+ # Revision of the discovery document this client was generated from
25
+ REVISION = "20201123"
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,142 @@
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 GmailpostmastertoolsV1beta1
24
+
25
+ class DeliveryError
26
+ class Representation < Google::Apis::Core::JsonRepresentation; end
27
+
28
+ include Google::Apis::Core::JsonObjectSupport
29
+ end
30
+
31
+ class Domain
32
+ class Representation < Google::Apis::Core::JsonRepresentation; end
33
+
34
+ include Google::Apis::Core::JsonObjectSupport
35
+ end
36
+
37
+ class FeedbackLoop
38
+ class Representation < Google::Apis::Core::JsonRepresentation; end
39
+
40
+ include Google::Apis::Core::JsonObjectSupport
41
+ end
42
+
43
+ class IpReputation
44
+ class Representation < Google::Apis::Core::JsonRepresentation; end
45
+
46
+ include Google::Apis::Core::JsonObjectSupport
47
+ end
48
+
49
+ class ListDomainsResponse
50
+ class Representation < Google::Apis::Core::JsonRepresentation; end
51
+
52
+ include Google::Apis::Core::JsonObjectSupport
53
+ end
54
+
55
+ class ListTrafficStatsResponse
56
+ class Representation < Google::Apis::Core::JsonRepresentation; end
57
+
58
+ include Google::Apis::Core::JsonObjectSupport
59
+ end
60
+
61
+ class TrafficStats
62
+ class Representation < Google::Apis::Core::JsonRepresentation; end
63
+
64
+ include Google::Apis::Core::JsonObjectSupport
65
+ end
66
+
67
+ class DeliveryError
68
+ # @private
69
+ class Representation < Google::Apis::Core::JsonRepresentation
70
+ property :error_class, as: 'errorClass'
71
+ property :error_ratio, as: 'errorRatio'
72
+ property :error_type, as: 'errorType'
73
+ end
74
+ end
75
+
76
+ class Domain
77
+ # @private
78
+ class Representation < Google::Apis::Core::JsonRepresentation
79
+ property :create_time, as: 'createTime'
80
+ property :name, as: 'name'
81
+ property :permission, as: 'permission'
82
+ end
83
+ end
84
+
85
+ class FeedbackLoop
86
+ # @private
87
+ class Representation < Google::Apis::Core::JsonRepresentation
88
+ property :id, as: 'id'
89
+ property :spam_ratio, as: 'spamRatio'
90
+ end
91
+ end
92
+
93
+ class IpReputation
94
+ # @private
95
+ class Representation < Google::Apis::Core::JsonRepresentation
96
+ property :ip_count, :numeric_string => true, as: 'ipCount'
97
+ property :num_ips, :numeric_string => true, as: 'numIps'
98
+ property :reputation, as: 'reputation'
99
+ collection :sample_ips, as: 'sampleIps'
100
+ end
101
+ end
102
+
103
+ class ListDomainsResponse
104
+ # @private
105
+ class Representation < Google::Apis::Core::JsonRepresentation
106
+ collection :domains, as: 'domains', class: Google::Apis::GmailpostmastertoolsV1beta1::Domain, decorator: Google::Apis::GmailpostmastertoolsV1beta1::Domain::Representation
107
+
108
+ property :next_page_token, as: 'nextPageToken'
109
+ end
110
+ end
111
+
112
+ class ListTrafficStatsResponse
113
+ # @private
114
+ class Representation < Google::Apis::Core::JsonRepresentation
115
+ property :next_page_token, as: 'nextPageToken'
116
+ collection :traffic_stats, as: 'trafficStats', class: Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats, decorator: Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats::Representation
117
+
118
+ end
119
+ end
120
+
121
+ class TrafficStats
122
+ # @private
123
+ class Representation < Google::Apis::Core::JsonRepresentation
124
+ collection :delivery_errors, as: 'deliveryErrors', class: Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError, decorator: Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError::Representation
125
+
126
+ property :dkim_success_ratio, as: 'dkimSuccessRatio'
127
+ property :dmarc_success_ratio, as: 'dmarcSuccessRatio'
128
+ property :domain_reputation, as: 'domainReputation'
129
+ property :inbound_encryption_ratio, as: 'inboundEncryptionRatio'
130
+ collection :ip_reputations, as: 'ipReputations', class: Google::Apis::GmailpostmastertoolsV1beta1::IpReputation, decorator: Google::Apis::GmailpostmastertoolsV1beta1::IpReputation::Representation
131
+
132
+ property :name, as: 'name'
133
+ property :outbound_encryption_ratio, as: 'outboundEncryptionRatio'
134
+ collection :spammy_feedback_loops, as: 'spammyFeedbackLoops', class: Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop, decorator: Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop::Representation
135
+
136
+ property :spf_success_ratio, as: 'spfSuccessRatio'
137
+ property :user_reported_spam_ratio, as: 'userReportedSpamRatio'
138
+ end
139
+ end
140
+ end
141
+ end
142
+ end
@@ -0,0 +1,232 @@
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/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module GmailpostmastertoolsV1beta1
23
+ # Gmail Postmaster Tools API
24
+ #
25
+ # The Postmaster Tools API is a RESTful API that provides programmatic access to
26
+ # email traffic metrics (like spam reports, delivery errors etc) otherwise
27
+ # available through the Gmail Postmaster Tools UI currently.
28
+ #
29
+ # @example
30
+ # require 'google/apis/gmailpostmastertools_v1beta1'
31
+ #
32
+ # Gmailpostmastertools = Google::Apis::GmailpostmastertoolsV1beta1 # Alias the module
33
+ # service = Gmailpostmastertools::PostmasterToolsService.new
34
+ #
35
+ # @see https://developers.google.com/gmail/postmaster
36
+ class PostmasterToolsService < Google::Apis::Core::BaseService
37
+ # @return [String]
38
+ # API key. Your API key identifies your project and provides you with API access,
39
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
40
+ attr_accessor :key
41
+
42
+ # @return [String]
43
+ # Available to use for quota purposes for server-side applications. Can be any
44
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
45
+ attr_accessor :quota_user
46
+
47
+ def initialize
48
+ super('https://gmailpostmastertools.googleapis.com/', '',
49
+ client_name: 'google-apis-gmailpostmastertools_v1beta1',
50
+ client_version: Google::Apis::GmailpostmastertoolsV1beta1::GEM_VERSION)
51
+ @batch_path = 'batch'
52
+ end
53
+
54
+ # Gets a specific domain registered by the client. Returns NOT_FOUND if the
55
+ # domain does not exist.
56
+ # @param [String] name
57
+ # The resource name of the domain. It should have the form `domains/`domain_name`
58
+ # `, where domain_name is the fully qualified domain name.
59
+ # @param [String] fields
60
+ # Selector specifying which fields to include in a partial response.
61
+ # @param [String] quota_user
62
+ # Available to use for quota purposes for server-side applications. Can be any
63
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
64
+ # @param [Google::Apis::RequestOptions] options
65
+ # Request-specific options
66
+ #
67
+ # @yield [result, err] Result & error if block supplied
68
+ # @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::Domain] parsed result object
69
+ # @yieldparam err [StandardError] error object if request failed
70
+ #
71
+ # @return [Google::Apis::GmailpostmastertoolsV1beta1::Domain]
72
+ #
73
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
74
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
75
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
76
+ def get_domain(name, fields: nil, quota_user: nil, options: nil, &block)
77
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
78
+ command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::Domain::Representation
79
+ command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::Domain
80
+ command.params['name'] = name unless name.nil?
81
+ command.query['fields'] = fields unless fields.nil?
82
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
83
+ execute_or_queue_command(command, &block)
84
+ end
85
+
86
+ # Lists the domains that have been registered by the client. The order of
87
+ # domains in the response is unspecified and non-deterministic. Newly created
88
+ # domains will not necessarily be added to the end of this list.
89
+ # @param [Fixnum] page_size
90
+ # Requested page size. Server may return fewer domains than requested. If
91
+ # unspecified, server will pick an appropriate default.
92
+ # @param [String] page_token
93
+ # The next_page_token value returned from a previous List request, if any. This
94
+ # is the value of ListDomainsResponse.next_page_token returned from the previous
95
+ # call to `ListDomains` method.
96
+ # @param [String] fields
97
+ # Selector specifying which fields to include in a partial response.
98
+ # @param [String] quota_user
99
+ # Available to use for quota purposes for server-side applications. Can be any
100
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
101
+ # @param [Google::Apis::RequestOptions] options
102
+ # Request-specific options
103
+ #
104
+ # @yield [result, err] Result & error if block supplied
105
+ # @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse] parsed result object
106
+ # @yieldparam err [StandardError] error object if request failed
107
+ #
108
+ # @return [Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse]
109
+ #
110
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
111
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
112
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
113
+ def list_domains(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
114
+ command = make_simple_command(:get, 'v1beta1/domains', options)
115
+ command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse::Representation
116
+ command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::ListDomainsResponse
117
+ command.query['pageSize'] = page_size unless page_size.nil?
118
+ command.query['pageToken'] = page_token unless page_token.nil?
119
+ command.query['fields'] = fields unless fields.nil?
120
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
121
+ execute_or_queue_command(command, &block)
122
+ end
123
+
124
+ # Get traffic statistics for a domain on a specific date. Returns
125
+ # PERMISSION_DENIED if user does not have permission to access TrafficStats for
126
+ # the domain.
127
+ # @param [String] name
128
+ # The resource name of the traffic statistics to get. E.g., domains/mymail.
129
+ # mydomain.com/trafficStats/20160807.
130
+ # @param [String] fields
131
+ # Selector specifying which fields to include in a partial response.
132
+ # @param [String] quota_user
133
+ # Available to use for quota purposes for server-side applications. Can be any
134
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
135
+ # @param [Google::Apis::RequestOptions] options
136
+ # Request-specific options
137
+ #
138
+ # @yield [result, err] Result & error if block supplied
139
+ # @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats] parsed result object
140
+ # @yieldparam err [StandardError] error object if request failed
141
+ #
142
+ # @return [Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats]
143
+ #
144
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
145
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
146
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
147
+ def get_domain_traffic_stat(name, fields: nil, quota_user: nil, options: nil, &block)
148
+ command = make_simple_command(:get, 'v1beta1/{+name}', options)
149
+ command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats::Representation
150
+ command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats
151
+ command.params['name'] = name unless name.nil?
152
+ command.query['fields'] = fields unless fields.nil?
153
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
154
+ execute_or_queue_command(command, &block)
155
+ end
156
+
157
+ # List traffic statistics for all available days. Returns PERMISSION_DENIED if
158
+ # user does not have permission to access TrafficStats for the domain.
159
+ # @param [String] parent
160
+ # The resource name of the domain whose traffic statistics we'd like to list. It
161
+ # should have the form `domains/`domain_name``, where domain_name is the fully
162
+ # qualified domain name.
163
+ # @param [Fixnum] end_date_day
164
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
165
+ # specify a year by itself or a year and month where the day isn't significant.
166
+ # @param [Fixnum] end_date_month
167
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
168
+ # and day.
169
+ # @param [Fixnum] end_date_year
170
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
171
+ # year.
172
+ # @param [Fixnum] page_size
173
+ # Requested page size. Server may return fewer TrafficStats than requested. If
174
+ # unspecified, server will pick an appropriate default.
175
+ # @param [String] page_token
176
+ # The next_page_token value returned from a previous List request, if any. This
177
+ # is the value of ListTrafficStatsResponse.next_page_token returned from the
178
+ # previous call to `ListTrafficStats` method.
179
+ # @param [Fixnum] start_date_day
180
+ # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to
181
+ # specify a year by itself or a year and month where the day isn't significant.
182
+ # @param [Fixnum] start_date_month
183
+ # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month
184
+ # and day.
185
+ # @param [Fixnum] start_date_year
186
+ # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
187
+ # year.
188
+ # @param [String] fields
189
+ # Selector specifying which fields to include in a partial response.
190
+ # @param [String] quota_user
191
+ # Available to use for quota purposes for server-side applications. Can be any
192
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
193
+ # @param [Google::Apis::RequestOptions] options
194
+ # Request-specific options
195
+ #
196
+ # @yield [result, err] Result & error if block supplied
197
+ # @yieldparam result [Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse] parsed result object
198
+ # @yieldparam err [StandardError] error object if request failed
199
+ #
200
+ # @return [Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse]
201
+ #
202
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
203
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
204
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
205
+ def list_domain_traffic_stats(parent, end_date_day: nil, end_date_month: nil, end_date_year: nil, page_size: nil, page_token: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block)
206
+ command = make_simple_command(:get, 'v1beta1/{+parent}/trafficStats', options)
207
+ command.response_representation = Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse::Representation
208
+ command.response_class = Google::Apis::GmailpostmastertoolsV1beta1::ListTrafficStatsResponse
209
+ command.params['parent'] = parent unless parent.nil?
210
+ command.query['endDate.day'] = end_date_day unless end_date_day.nil?
211
+ command.query['endDate.month'] = end_date_month unless end_date_month.nil?
212
+ command.query['endDate.year'] = end_date_year unless end_date_year.nil?
213
+ command.query['pageSize'] = page_size unless page_size.nil?
214
+ command.query['pageToken'] = page_token unless page_token.nil?
215
+ command.query['startDate.day'] = start_date_day unless start_date_day.nil?
216
+ command.query['startDate.month'] = start_date_month unless start_date_month.nil?
217
+ command.query['startDate.year'] = start_date_year unless start_date_year.nil?
218
+ command.query['fields'] = fields unless fields.nil?
219
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
220
+ execute_or_queue_command(command, &block)
221
+ end
222
+
223
+ protected
224
+
225
+ def apply_command_defaults(command)
226
+ command.query['key'] = key unless key.nil?
227
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
228
+ end
229
+ end
230
+ end
231
+ end
232
+ end
metadata ADDED
@@ -0,0 +1,76 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: google-apis-gmailpostmastertools_v1beta1
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Google LLC
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-01-08 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: google-apis-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '0.1'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '0.1'
27
+ description: This is the simple REST client for Gmail Postmaster Tools API V1beta1.
28
+ Simple REST clients are Ruby client libraries that provide access to Google services
29
+ via their HTTP REST API endpoints. These libraries are generated and updated automatically
30
+ based on the discovery documents published by the service, and they handle most
31
+ concerns such as authentication, pagination, retry, timeouts, and logging. You can
32
+ use this client to access the Gmail Postmaster Tools API, but note that some services
33
+ may provide a separate modern client that is easier to use.
34
+ email: googleapis-packages@google.com
35
+ executables: []
36
+ extensions: []
37
+ extra_rdoc_files: []
38
+ files:
39
+ - ".yardopts"
40
+ - CHANGELOG.md
41
+ - LICENSE.md
42
+ - OVERVIEW.md
43
+ - lib/google-apis-gmailpostmastertools_v1beta1.rb
44
+ - lib/google/apis/gmailpostmastertools_v1beta1.rb
45
+ - lib/google/apis/gmailpostmastertools_v1beta1/classes.rb
46
+ - lib/google/apis/gmailpostmastertools_v1beta1/gem_version.rb
47
+ - lib/google/apis/gmailpostmastertools_v1beta1/representations.rb
48
+ - lib/google/apis/gmailpostmastertools_v1beta1/service.rb
49
+ homepage: https://github.com/google/google-api-ruby-client
50
+ licenses:
51
+ - Apache-2.0
52
+ metadata:
53
+ bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
54
+ changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-gmailpostmastertools_v1beta1/CHANGELOG.md
55
+ documentation_uri: https://googleapis.dev/ruby/google-apis-gmailpostmastertools_v1beta1/v0.1.0
56
+ source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/master/generated/google-apis-gmailpostmastertools_v1beta1
57
+ post_install_message:
58
+ rdoc_options: []
59
+ require_paths:
60
+ - lib
61
+ required_ruby_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: '2.4'
66
+ required_rubygems_version: !ruby/object:Gem::Requirement
67
+ requirements:
68
+ - - ">="
69
+ - !ruby/object:Gem::Version
70
+ version: '0'
71
+ requirements: []
72
+ rubygems_version: 3.1.4
73
+ signing_key:
74
+ specification_version: 4
75
+ summary: Simple REST client for Gmail Postmaster Tools API V1beta1
76
+ test_files: []