Class: Google::Apis::DisplayvideoV3::PoiAssignedTargetingOptionDetails

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

Overview

Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is TARGETING_TYPE_POI.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PoiAssignedTargetingOptionDetails

Returns a new instance of PoiAssignedTargetingOptionDetails.



10606
10607
10608
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10606

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

Instance Attribute Details

#display_name ⇒ String

Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available. Corresponds to the JSON property displayName

Returns:

  • (String) 


10566
10567
10568
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10566

def display_name
  @display_name
end

#latitude ⇒ Float

Output only. Latitude of the POI rounding to 6th decimal place. Corresponds to the JSON property latitude

Returns:

  • (Float) 


10571
10572
10573
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10571

def latitude
  @latitude
end

#longitude ⇒ Float

Output only. Longitude of the POI rounding to 6th decimal place. Corresponds to the JSON property longitude

Returns:

  • (Float) 


10576
10577
10578
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10576

def longitude
  @longitude
end

#proximity_radius_amount ⇒ Float

Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is DISTANCE_UNIT_KILOMETERS and 1 to 500 if unit is DISTANCE_UNIT_MILES. Corresponds to the JSON property proximityRadiusAmount

Returns:

  • (Float) 


10584
10585
10586
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10584

def proximity_radius_amount
  @proximity_radius_amount
end

#proximity_radius_unit ⇒ String

Required. The unit of distance by which the targeting radius is measured. Corresponds to the JSON property proximityRadiusUnit

Returns:

  • (String) 


10589
10590
10591
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10589

def proximity_radius_unit
  @proximity_radius_unit
end

#targeting_option_id ⇒ String

Required. The targeting_option_id of a TargetingOption of type TARGETING_TYPE_POI. Accepted POI targeting option IDs can be retrieved using targetingTypes.targetingOptions.search. If targeting a specific latitude/ longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;- 74003387". Upon creation, this field value will be updated to append a semicolon and alphanumerical hash value if only latitude/longitude coordinates are provided. Corresponds to the JSON property targetingOptionId

Returns:

  • (String) 


10604
10605
10606
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10604

def targeting_option_id
  @targeting_option_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10611
10612
10613
10614
10615
10616
10617
10618
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10611

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @latitude = args[:latitude] if args.key?(:latitude)
  @longitude = args[:longitude] if args.key?(:longitude)
  @proximity_radius_amount = args[:proximity_radius_amount] if args.key?(:proximity_radius_amount)
  @proximity_radius_unit = args[:proximity_radius_unit] if args.key?(:proximity_radius_unit)
  @targeting_option_id = args[:targeting_option_id] if args.key?(:targeting_option_id)
end