Class: Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleCriterion

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

Overview

Encapsulates a filter criterion for searching for a set of playable locations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleMapsPlayablelocationsV3SampleCriterion

Returns a new instance of GoogleMapsPlayablelocationsV3SampleCriterion.



256
257
258
 
# File 'generated/google/apis/playablelocations_v3/classes.rb', line 256

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

Instance Attribute Details

#fields_to_return ⇒ String

Specifies which PlayableLocation fields are returned. name (which is used for logging impressions), center_point and place_id (or plus_code) are always returned. The following fields are omitted unless you specify them here:

  • snapped_point * types Note: The more fields you include, the more expensive in terms of data and associated latency your query will be. Corresponds to the JSON property fieldsToReturn

Returns:

  • (String) 


239
240
241
 
# File 'generated/google/apis/playablelocations_v3/classes.rb', line 239

def fields_to_return
  @fields_to_return
end

#filter ⇒ Google::Apis::PlayablelocationsV3::GoogleMapsPlayablelocationsV3SampleFilter

Specifies the filters to use when searching for playable locations. Corresponds to the JSON property filter

Returns:



244
245
246
 
# File 'generated/google/apis/playablelocations_v3/classes.rb', line 244

def filter
  @filter
end

#game_object_type ⇒ Fixnum

Required. An arbitrary, developer-defined identifier of the type of game object that the playable location is used for. This field allows you to specify criteria per game object type when searching for playable locations. You should assign a unique game_object_type ID across all request_criteria to represent a distinct type of game object. For example, 1=monster location, 2=powerup location. The response contains a map. Corresponds to the JSON property gameObjectType

Returns:

  • (Fixnum) 


254
255
256
 
# File 'generated/google/apis/playablelocations_v3/classes.rb', line 254

def game_object_type
  @game_object_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



261
262
263
264
265
 
# File 'generated/google/apis/playablelocations_v3/classes.rb', line 261

def update!(**args)
  @fields_to_return = args[:fields_to_return] if args.key?(:fields_to_return)
  @filter = args[:filter] if args.key?(:filter)
  @game_object_type = args[:game_object_type] if args.key?(:game_object_type)
end