Class: Google::Apis::GamesV1::PlayerScoreResponse

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

Overview

This is a JSON template for a list of leaderboard entry resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PlayerScoreResponse

Returns a new instance of PlayerScoreResponse.



2620
2621
2622
 
# File 'generated/google/apis/games_v1/classes.rb', line 2620

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

Instance Attribute Details

#beaten_score_time_spans ⇒ Array<String>

The time spans where the submitted score is better than the existing score for that time span. Possible values are:

  • "ALL_TIME" - The score is an all-time score.
  • "WEEKLY" - The score is a weekly score.
  • "DAILY" - The score is a daily score. Corresponds to the JSON property beatenScoreTimeSpans

Returns:

  • (Array<String>) 


2589
2590
2591
 
# File 'generated/google/apis/games_v1/classes.rb', line 2589

def beaten_score_time_spans
  @beaten_score_time_spans
end

#formatted_score ⇒ String

The formatted value of the submitted score. Corresponds to the JSON property formattedScore

Returns:

  • (String) 


2594
2595
2596
 
# File 'generated/google/apis/games_v1/classes.rb', line 2594

def formatted_score
  @formatted_score
end

#kind ⇒ String

Uniquely identifies the type of this resource. Value is always the fixed string games#playerScoreResponse. Corresponds to the JSON property kind

Returns:

  • (String) 


2600
2601
2602
 
# File 'generated/google/apis/games_v1/classes.rb', line 2600

def kind
  @kind
end

#leaderboard_id ⇒ String

The leaderboard ID that this score was submitted to. Corresponds to the JSON property leaderboardId

Returns:

  • (String) 


2605
2606
2607
 
# File 'generated/google/apis/games_v1/classes.rb', line 2605

def leaderboard_id
  @leaderboard_id
end

#score_tag ⇒ String

Additional information about this score. Values will contain no more than 64 URI-safe characters as defined by section 2.3 of RFC 3986. Corresponds to the JSON property scoreTag

Returns:

  • (String) 


2611
2612
2613
 
# File 'generated/google/apis/games_v1/classes.rb', line 2611

def score_tag
  @score_tag
end

#unbeaten_scores ⇒ Array<Google::Apis::GamesV1::PlayerScore>

The scores in time spans that have not been beaten. As an example, the submitted score may be better than the player's DAILY score, but not better than the player's scores for the WEEKLY or ALL_TIME time spans. Corresponds to the JSON property unbeatenScores

Returns:



2618
2619
2620
 
# File 'generated/google/apis/games_v1/classes.rb', line 2618

def unbeaten_scores
  @unbeaten_scores
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2625
2626
2627
2628
2629
2630
2631
2632
 
# File 'generated/google/apis/games_v1/classes.rb', line 2625

def update!(**args)
  @beaten_score_time_spans = args[:beaten_score_time_spans] if args.key?(:beaten_score_time_spans)
  @formatted_score = args[:formatted_score] if args.key?(:formatted_score)
  @kind = args[:kind] if args.key?(:kind)
  @leaderboard_id = args[:leaderboard_id] if args.key?(:leaderboard_id)
  @score_tag = args[:score_tag] if args.key?(:score_tag)
  @unbeaten_scores = args[:unbeaten_scores] if args.key?(:unbeaten_scores)
end