Class: Google::Apis::DfareportingV3_4::GeoTargeting

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

Overview

Geographical Targeting.

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) ⇒ GeoTargeting

Returns a new instance of GeoTargeting.



7009
7010
7011
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 7009

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

Instance Attribute Details

#cities ⇒ Array<Google::Apis::DfareportingV3_4::City>

Cities to be targeted. For each city only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a city, do not target or exclude the country of the city, and do not target the metro or region of the city. Corresponds to the JSON property cities

Returns:



6968
6969
6970
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6968

def cities
  @cities
end

#countries ⇒ Array<Google::Apis::DfareportingV3_4::Country>

Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field. For each country only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting or excluding a country, do not target regions, cities, metros, or postal codes in the same country. Corresponds to the JSON property countries

Returns:



6977
6978
6979
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6977

def countries
  @countries
end

#exclude_countries ⇒ Boolean Also known as: exclude_countries?

Whether or not to exclude the countries in the countries field from targeting. If false, the countries field refers to countries which will be targeted by the ad. Corresponds to the JSON property excludeCountries

Returns:

  • (Boolean) 


6984
6985
6986
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6984

def exclude_countries
  @exclude_countries
end

#metros ⇒ Array<Google::Apis::DfareportingV3_4::Metro>

Metros to be targeted. For each metro only dmaId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a metro, do not target or exclude the country of the metro. Corresponds to the JSON property metros

Returns:



6992
6993
6994
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 6992

def metros
  @metros
end

#postal_codes ⇒ Array<Google::Apis::DfareportingV3_4::PostalCode>

Postal codes to be targeted. For each postal code only id is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a postal code, do not target or exclude the country of the postal code. Corresponds to the JSON property postalCodes

Returns:



7000
7001
7002
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 7000

def postal_codes
  @postal_codes
end

#regions ⇒ Array<Google::Apis::DfareportingV3_4::Region>

Regions to be targeted. For each region only dartId is required. The other fields are populated automatically when the ad is inserted or updated. If targeting a region, do not target or exclude the country of the region. Corresponds to the JSON property regions

Returns:



7007
7008
7009
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 7007

def regions
  @regions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7014
7015
7016
7017
7018
7019
7020
7021
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 7014

def update!(**args)
  @cities = args[:cities] if args.key?(:cities)
  @countries = args[:countries] if args.key?(:countries)
  @exclude_countries = args[:exclude_countries] if args.key?(:exclude_countries)
  @metros = args[:metros] if args.key?(:metros)
  @postal_codes = args[:postal_codes] if args.key?(:postal_codes)
  @regions = args[:regions] if args.key?(:regions)
end