com.google.api.services.displayvideo.v4.model

Class SearchTargetingOptionsRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.displayvideo.v4.model.SearchTargetingOptionsRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Request message for SearchTargetingOptions.

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 Display & Video 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
SearchTargetingOptionsRequest()

Method Summary

Modifier and Type	Method and Description
SearchTargetingOptionsRequest	clone()
Long	getAdvertiserId() Required.
BusinessChainSearchTerms	getBusinessChainSearchTerms() Search terms for Business Chain targeting options.
GeoRegionSearchTerms	getGeoRegionSearchTerms() Search terms for geo region targeting options.
Integer	getPageSize() Requested page size.
String	getPageToken() A token identifying a page of results the server should return.
PoiSearchTerms	getPoiSearchTerms() Search terms for POI targeting options.
SearchTargetingOptionsRequest	set(String fieldName, Object value)
SearchTargetingOptionsRequest	setAdvertiserId(Long advertiserId) Required.
SearchTargetingOptionsRequest	setBusinessChainSearchTerms(BusinessChainSearchTerms businessChainSearchTerms) Search terms for Business Chain targeting options.
SearchTargetingOptionsRequest	setGeoRegionSearchTerms(GeoRegionSearchTerms geoRegionSearchTerms) Search terms for geo region targeting options.
SearchTargetingOptionsRequest	setPageSize(Integer pageSize) Requested page size.
SearchTargetingOptionsRequest	setPageToken(String pageToken) A token identifying a page of results the server should return.
SearchTargetingOptionsRequest	setPoiSearchTerms(PoiSearchTerms poiSearchTerms) Search terms for POI targeting options.

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

SearchTargetingOptionsRequest

public SearchTargetingOptionsRequest()

Method Detail

getAdvertiserId

public Long getAdvertiserId()

Required. The Advertiser this request is being made in the context of.

Returns:

value or null for none

setAdvertiserId

public SearchTargetingOptionsRequest setAdvertiserId(Long advertiserId)

Required. The Advertiser this request is being made in the context of.

Parameters:

advertiserId - advertiserId or null for none

getBusinessChainSearchTerms

public BusinessChainSearchTerms getBusinessChainSearchTerms()

Search terms for Business Chain targeting options. Can only be used when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.

Returns:

value or null for none

setBusinessChainSearchTerms

public SearchTargetingOptionsRequest setBusinessChainSearchTerms(BusinessChainSearchTerms businessChainSearchTerms)

Search terms for Business Chain targeting options. Can only be used when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.

Parameters:

businessChainSearchTerms - businessChainSearchTerms or null for none

getGeoRegionSearchTerms

public GeoRegionSearchTerms getGeoRegionSearchTerms()

Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`.

Returns:

value or null for none

setGeoRegionSearchTerms

public SearchTargetingOptionsRequest setGeoRegionSearchTerms(GeoRegionSearchTerms geoRegionSearchTerms)

Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`.

Parameters:

geoRegionSearchTerms - geoRegionSearchTerms or null for none

getPageSize

public Integer getPageSize()

Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

Returns:

value or null for none

setPageSize

public SearchTargetingOptionsRequest setPageSize(Integer pageSize)

Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.

Parameters:

pageSize - pageSize or null for none

getPageToken

public String getPageToken()

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned.

Returns:

value or null for none

setPageToken

public SearchTargetingOptionsRequest setPageToken(String pageToken)

A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned.

Parameters:

pageToken - pageToken or null for none

getPoiSearchTerms

public PoiSearchTerms getPoiSearchTerms()

Search terms for POI targeting options. Can only be used when targeting_type is `TARGETING_TYPE_POI`.

Returns:

value or null for none

setPoiSearchTerms

public SearchTargetingOptionsRequest setPoiSearchTerms(PoiSearchTerms poiSearchTerms)

Search terms for POI targeting options. Can only be used when targeting_type is `TARGETING_TYPE_POI`.

Parameters:

poiSearchTerms - poiSearchTerms or null for none

set

public SearchTargetingOptionsRequest set(String fieldName,
                                         Object value)

Overrides:

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

clone

public SearchTargetingOptionsRequest clone()

Overrides:

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