com.google.api.services.dfareporting.model

Class GeoTargeting

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dfareporting.model.GeoTargeting

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GeoTargeting
extends com.google.api.client.json.GenericJson

Geographical Targeting.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Campaign Manager 360 API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GeoTargeting()

Method Summary

Modifier and Type	Method and Description
GeoTargeting	clone()
List<City>	getCities() Cities to be targeted.
List<Country>	getCountries() Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field.
Boolean	getExcludeCountries() Whether or not to exclude the countries in the countries field from targeting.
List<Metro>	getMetros() Metros to be targeted.
List<PostalCode>	getPostalCodes() Postal codes to be targeted.
List<Region>	getRegions() Regions to be targeted.
GeoTargeting	set(String fieldName, Object value)
GeoTargeting	setCities(List<City> cities) Cities to be targeted.
GeoTargeting	setCountries(List<Country> countries) Countries to be targeted or excluded from targeting, depending on the setting of the excludeCountries field.
GeoTargeting	setExcludeCountries(Boolean excludeCountries) Whether or not to exclude the countries in the countries field from targeting.
GeoTargeting	setMetros(List<Metro> metros) Metros to be targeted.
GeoTargeting	setPostalCodes(List<PostalCode> postalCodes) Postal codes to be targeted.
GeoTargeting	setRegions(List<Region> regions) Regions to be targeted.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GeoTargeting

public GeoTargeting()

Method Detail

getCities

public List<City> getCities()

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.

Returns:

value or null for none

setCities

public GeoTargeting setCities(List<City> cities)

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.

Parameters:

cities - cities or null for none

getCountries

public List<Country> getCountries()

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.

Returns:

value or null for none

setCountries

public GeoTargeting setCountries(List<Country> countries)

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.

Parameters:

countries - countries or null for none

getExcludeCountries

public Boolean getExcludeCountries()

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.

Returns:

value or null for none

setExcludeCountries

public GeoTargeting setExcludeCountries(Boolean excludeCountries)

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.

Parameters:

excludeCountries - excludeCountries or null for none

getMetros

public List<Metro> getMetros()

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.

Returns:

value or null for none

setMetros

public GeoTargeting setMetros(List<Metro> metros)

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.

Parameters:

metros - metros or null for none

getPostalCodes

public List<PostalCode> getPostalCodes()

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.

Returns:

value or null for none

setPostalCodes

public GeoTargeting setPostalCodes(List<PostalCode> postalCodes)

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.

Parameters:

postalCodes - postalCodes or null for none

getRegions

public List<Region> getRegions()

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.

Returns:

value or null for none

setRegions

public GeoTargeting setRegions(List<Region> regions)

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.

Parameters:

regions - regions or null for none

set

public GeoTargeting set(String fieldName,
                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GeoTargeting clone()

Overrides:

clone in class com.google.api.client.json.GenericJson