Class: Google::Apis::DfareportingV3_3::GeoTargeting

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



6607
6608
6609
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 6607

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

Instance Attribute Details

#citiesArray<Google::Apis::DfareportingV3_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



6566
6567
6568
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 6566

def cities
  @cities
end

#countriesArray<Google::Apis::DfareportingV3_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



6575
6576
6577
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 6575

def countries
  @countries
end

#exclude_countriesBoolean 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)


6582
6583
6584
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 6582

def exclude_countries
  @exclude_countries
end

#metrosArray<Google::Apis::DfareportingV3_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



6590
6591
6592
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 6590

def metros
  @metros
end

#postal_codesArray<Google::Apis::DfareportingV3_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



6598
6599
6600
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 6598

def postal_codes
  @postal_codes
end

#regionsArray<Google::Apis::DfareportingV3_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



6605
6606
6607
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 6605

def regions
  @regions
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6612
6613
6614
6615
6616
6617
6618
6619
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 6612

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