Class: Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats
- Inherits:
-
Object
- Object
- Google::Apis::GmailpostmastertoolsV1beta1::TrafficStats
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/gmailpostmastertools_v1beta1/classes.rb,
lib/google/apis/gmailpostmastertools_v1beta1/representations.rb,
lib/google/apis/gmailpostmastertools_v1beta1/representations.rb
Overview
Email traffic statistics pertaining to a specific date.
Instance Attribute Summary collapse
-
#delivery_errors ⇒ Array<Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError>
Delivery errors for the domain.
-
#dkim_success_ratio ⇒ Float
The ratio of mail that successfully authenticated with DKIM vs.
- #dmarc_success_ratio ⇒ Float
-
#domain_reputation ⇒ String
Reputation of the domain.
-
#inbound_encryption_ratio ⇒ Float
The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain.
-
#ip_reputations ⇒ Array<Google::Apis::GmailpostmastertoolsV1beta1::IpReputation>
Reputation information pertaining to the IP addresses of the email servers for the domain.
-
#name ⇒ String
The resource name of the traffic statistics.
-
#outbound_encryption_ratio ⇒ Float
The ratio of outgoing mail (from Gmail) that was accepted over secure transport (TLS).
-
#spammy_feedback_loops ⇒ Array<Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop>
Spammy Feedback loop identifiers with their individual spam rates.
-
#spf_success_ratio ⇒ Float
The ratio of mail that successfully authenticated with SPF vs.
-
#user_reported_spam_ratio ⇒ Float
The ratio of user-report spam vs.
-
#user_reported_spam_ratio_lower_bound ⇒ Float
The lower bound of the confidence interval for the user reported spam ratio.
-
#user_reported_spam_ratio_upper_bound ⇒ Float
The upper bound of the confidence interval for the user reported spam ratio.
Instance Method Summary collapse
-
#initialize(**args) ⇒ TrafficStats
constructor
A new instance of TrafficStats.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ TrafficStats
Returns a new instance of TrafficStats.
312 313 314 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 312 def initialize(**args) update!(**args) end |
Instance Attribute Details
#delivery_errors ⇒ Array<Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError>
218 219 220 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 218 def delivery_errors @delivery_errors end |
#dkim_success_ratio ⇒ Float
The ratio of mail that successfully authenticated with DKIM vs. all mail that
attempted to authenticate with DKIM. Spoofed mail is
excluded.
Corresponds to the JSON property dkimSuccessRatio
225 226 227 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 225 def dkim_success_ratio @dkim_success_ratio end |
#dmarc_success_ratio ⇒ Float
232 233 234 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 232 def dmarc_success_ratio @dmarc_success_ratio end |
#domain_reputation ⇒ String
Reputation of the domain.
Corresponds to the JSON property domainReputation
237 238 239 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 237 def domain_reputation @domain_reputation end |
#inbound_encryption_ratio ⇒ Float
244 245 246 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 244 def inbound_encryption_ratio @inbound_encryption_ratio end |
#ip_reputations ⇒ Array<Google::Apis::GmailpostmastertoolsV1beta1::IpReputation>
Reputation information pertaining to the IP addresses of the email servers for
the domain. There is exactly one entry for each reputation category except
REPUTATION_CATEGORY_UNSPECIFIED.
Corresponds to the JSON property ipReputations
251 252 253 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 251 def ip_reputations @ip_reputations end |
#name ⇒ String
The resource name of the traffic statistics. Traffic statistic names have the
form domains/
domain/trafficStats/
date`, where domain_name is the fully
qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic
statistics pertains to and date is the date in yyyymmdd format that these
statistics corresponds to. For example: domains/mymail.mydomain.com/
trafficStats/20160807
Corresponds to the JSON property
name`
261 262 263 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 261 def name @name end |
#outbound_encryption_ratio ⇒ Float
The ratio of outgoing mail (from Gmail) that was accepted over secure
transport (TLS).
Corresponds to the JSON property outboundEncryptionRatio
267 268 269 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 267 def outbound_encryption_ratio @outbound_encryption_ratio end |
#spammy_feedback_loops ⇒ Array<Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop>
Spammy Feedback loop identifiers with their individual spam rates. This metric only pertains to
traffic that is authenticated by DKIM.
Corresponds to the JSON property spammyFeedbackLoops
274 275 276 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 274 def spammy_feedback_loops @spammy_feedback_loops end |
#spf_success_ratio ⇒ Float
The ratio of mail that successfully authenticated with SPF vs. all mail that
attempted to authenticate with SPF. Spoofed mail is
excluded.
Corresponds to the JSON property spfSuccessRatio
281 282 283 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 281 def spf_success_ratio @spf_success_ratio end |
#user_reported_spam_ratio ⇒ Float
The ratio of user-report spam vs. email that was sent to the inbox. This is
potentially inexact -- users may want to refer to the description of the
interval fields userReportedSpamRatioLowerBound and
userReportedSpamRatioUpperBound for more explicit accuracy guarantees. This
metric only pertains to emails authenticated by DKIM.
Corresponds to the JSON property userReportedSpamRatio
290 291 292 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 290 def user_reported_spam_ratio @user_reported_spam_ratio end |
#user_reported_spam_ratio_lower_bound ⇒ Float
The lower bound of the confidence interval for the user reported spam ratio.
If this field is set, then the value of userReportedSpamRatio is set to the
midpoint of this interval and is thus inexact. However, the true ratio is
guaranteed to be in between this lower bound and the corresponding upper bound
95% of the time. This metric only pertains to emails authenticated by DKIM.
Corresponds to the JSON property userReportedSpamRatioLowerBound
300 301 302 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 300 def user_reported_spam_ratio_lower_bound @user_reported_spam_ratio_lower_bound end |
#user_reported_spam_ratio_upper_bound ⇒ Float
The upper bound of the confidence interval for the user reported spam ratio.
If this field is set, then the value of userReportedSpamRatio is set to the
midpoint of this interval and is thus inexact. However, the true ratio is
guaranteed to be in between this upper bound and the corresponding lower bound
95% of the time. This metric only pertains to emails authenticated by DKIM.
Corresponds to the JSON property userReportedSpamRatioUpperBound
310 311 312 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 310 def user_reported_spam_ratio_upper_bound @user_reported_spam_ratio_upper_bound end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/google/apis/gmailpostmastertools_v1beta1/classes.rb', line 317 def update!(**args) @delivery_errors = args[:delivery_errors] if args.key?(:delivery_errors) @dkim_success_ratio = args[:dkim_success_ratio] if args.key?(:dkim_success_ratio) @dmarc_success_ratio = args[:dmarc_success_ratio] if args.key?(:dmarc_success_ratio) @domain_reputation = args[:domain_reputation] if args.key?(:domain_reputation) @inbound_encryption_ratio = args[:inbound_encryption_ratio] if args.key?(:inbound_encryption_ratio) @ip_reputations = args[:ip_reputations] if args.key?(:ip_reputations) @name = args[:name] if args.key?(:name) @outbound_encryption_ratio = args[:outbound_encryption_ratio] if args.key?(:outbound_encryption_ratio) @spammy_feedback_loops = args[:spammy_feedback_loops] if args.key?(:spammy_feedback_loops) @spf_success_ratio = args[:spf_success_ratio] if args.key?(:spf_success_ratio) @user_reported_spam_ratio = args[:user_reported_spam_ratio] if args.key?(:user_reported_spam_ratio) @user_reported_spam_ratio_lower_bound = args[:user_reported_spam_ratio_lower_bound] if args.key?(:user_reported_spam_ratio_lower_bound) @user_reported_spam_ratio_upper_bound = args[:user_reported_spam_ratio_upper_bound] if args.key?(:user_reported_spam_ratio_upper_bound) end |