Class: Google::Apis::DisplayvideoV3::SearchTargetingOptionsRequest

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

Overview

Request message for SearchTargetingOptions.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchTargetingOptionsRequest

Returns a new instance of SearchTargetingOptionsRequest.



11284
11285
11286
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11284

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

Instance Attribute Details

#advertiser_id ⇒ Fixnum

Required. The Advertiser this request is being made in the context of. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


11251
11252
11253
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11251

def advertiser_id
  @advertiser_id
end

#business_chain_search_terms ⇒ Google::Apis::DisplayvideoV3::BusinessChainSearchTerms

Search terms for Business Chain targeting options. At least one of the field should be populated. Corresponds to the JSON property businessChainSearchTerms

Returns:



11257
11258
11259
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11257

def business_chain_search_terms
  @business_chain_search_terms
end

#geo_region_search_terms ⇒ Google::Apis::DisplayvideoV3::GeoRegionSearchTerms

Search terms for geo region targeting options. Corresponds to the JSON property geoRegionSearchTerms

Returns:



11262
11263
11264
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11262

def geo_region_search_terms
  @geo_region_search_terms
end

#page_size ⇒ Fixnum

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. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


11269
11270
11271
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11269

def page_size
  @page_size
end

#page_token ⇒ String

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. Corresponds to the JSON property pageToken

Returns:

  • (String) 


11277
11278
11279
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11277

def page_token
  @page_token
end

#poi_search_terms ⇒ Google::Apis::DisplayvideoV3::PoiSearchTerms

Search terms for POI targeting options. Corresponds to the JSON property poiSearchTerms

Returns:



11282
11283
11284
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11282

def poi_search_terms
  @poi_search_terms
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11289
11290
11291
11292
11293
11294
11295
11296
 
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 11289

def update!(**args)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @business_chain_search_terms = args[:business_chain_search_terms] if args.key?(:business_chain_search_terms)
  @geo_region_search_terms = args[:geo_region_search_terms] if args.key?(:geo_region_search_terms)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @poi_search_terms = args[:poi_search_terms] if args.key?(:poi_search_terms)
end