Class: Google::Apis::DfareportingV2_3::GeoTargeting

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_3/classes.rb,
generated/google/apis/dfareporting_v2_3/representations.rb,
generated/google/apis/dfareporting_v2_3/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.



5922
5923
5924
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 5922

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

Instance Attribute Details

#cities ⇒ Array<Google::Apis::DfareportingV2_3::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:



5881
5882
5883
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 5881

def cities
  @cities
end

#countries ⇒ Array<Google::Apis::DfareportingV2_3::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:



5890
5891
5892
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 5890

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) 


5897
5898
5899
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 5897

def exclude_countries
  @exclude_countries
end

#metros ⇒ Array<Google::Apis::DfareportingV2_3::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:



5905
5906
5907
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 5905

def metros
  @metros
end

#postal_codes ⇒ Array<Google::Apis::DfareportingV2_3::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:



5913
5914
5915
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 5913

def postal_codes
  @postal_codes
end

#regions ⇒ Array<Google::Apis::DfareportingV2_3::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:



5920
5921
5922
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 5920

def regions
  @regions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5927
5928
5929
5930
5931
5932
5933
5934
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 5927

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