Class: Google::Apis::GmailpostmastertoolsV1::TrafficStats

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/gmailpostmastertools_v1/classes.rb,
lib/google/apis/gmailpostmastertools_v1/representations.rb,
lib/google/apis/gmailpostmastertools_v1/representations.rb

Overview

Email traffic statistics pertaining to a specific date.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TrafficStats

Returns a new instance of TrafficStats.



303
304
305
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 303

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#delivery_errors ⇒ Array<Google::Apis::GmailpostmastertoolsV1::DeliveryError>

Delivery errors for the domain. This metric only pertains to traffic that passed SPF or DKIM. Corresponds to the JSON property deliveryErrors

Returns:



209
210
211
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 209

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

Returns:

  • (Float) 


216
217
218
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 216

def dkim_success_ratio
  @dkim_success_ratio
end

#dmarc_success_ratio ⇒ Float

The ratio of mail that passed DMARC alignment checks vs all mail received from the domain that successfully authenticated with either of SPF or DKIM. Corresponds to the JSON property dmarcSuccessRatio

Returns:

  • (Float) 


223
224
225
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 223

def dmarc_success_ratio
  @dmarc_success_ratio
end

#domain_reputation ⇒ String

Reputation of the domain. Corresponds to the JSON property domainReputation

Returns:

  • (String) 


228
229
230
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 228

def domain_reputation
  @domain_reputation
end

#inbound_encryption_ratio ⇒ Float

The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs all mail received from that domain. This metric only pertains to traffic that passed SPF or DKIM. Corresponds to the JSON property inboundEncryptionRatio

Returns:

  • (Float) 


235
236
237
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 235

def inbound_encryption_ratio
  @inbound_encryption_ratio
end

#ip_reputations ⇒ Array<Google::Apis::GmailpostmastertoolsV1::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

Returns:



242
243
244
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 242

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 propertyname`

Returns:

  • (String) 


252
253
254
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 252

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

Returns:

  • (Float) 


258
259
260
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 258

def outbound_encryption_ratio
  @outbound_encryption_ratio
end

#spammy_feedback_loops ⇒ Array<Google::Apis::GmailpostmastertoolsV1::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

Returns:



265
266
267
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 265

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

Returns:

  • (Float) 


272
273
274
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 272

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

Returns:

  • (Float) 


281
282
283
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 281

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

Returns:

  • (Float) 


291
292
293
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 291

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

Returns:

  • (Float) 


301
302
303
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 301

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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/google/apis/gmailpostmastertools_v1/classes.rb', line 308

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