Class: Google::Apis::AdexchangebuyerV1_4::PretargetingConfig

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

Defined Under Namespace

Classes: Dimension, ExcludedPlacement, Placement, VideoPlayerSize

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) ⇒ PretargetingConfig

Returns a new instance of PretargetingConfig.



2378
2379
2380
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2378

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

Instance Attribute Details

#billing_id ⇒ String

The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically. Corresponds to the JSON property billingId

Returns:

  • (String) 


2247
2248
2249
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2247

def billing_id
  @billing_id
end

#config_id ⇒ String

The config id; generated automatically. Leave this field blank for insert requests. Corresponds to the JSON property configId

Returns:

  • (String) 


2253
2254
2255
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2253

def config_id
  @config_id
end

#config_name ⇒ String

The name of the config. Must be unique. Required for all requests. Corresponds to the JSON property configName

Returns:

  • (String) 


2258
2259
2260
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2258

def config_name
  @config_name
end

#creative_type ⇒ Array<String>

List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO. Corresponds to the JSON property creativeType

Returns:

  • (Array<String>) 


2264
2265
2266
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2264

def creative_type
  @creative_type
end

#dimensions ⇒ Array<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::Dimension>

Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions. Corresponds to the JSON property dimensions

Returns:



2270
2271
2272
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2270

def dimensions
  @dimensions
end

#excluded_content_labels ⇒ Array<String>

Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section. Corresponds to the JSON property excludedContentLabels

Returns:

  • (Array<String>) 


2276
2277
2278
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2276

def excluded_content_labels
  @excluded_content_labels
end

#excluded_geo_criteria_ids ⇒ Array<String>

Requests containing any of these geo criteria ids will not match. Corresponds to the JSON property excludedGeoCriteriaIds

Returns:

  • (Array<String>) 


2281
2282
2283
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2281

def excluded_geo_criteria_ids
  @excluded_geo_criteria_ids
end

#excluded_placements ⇒ Array<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::ExcludedPlacement>

Requests containing any of these placements will not match. Corresponds to the JSON property excludedPlacements

Returns:



2286
2287
2288
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2286

def excluded_placements
  @excluded_placements
end

#excluded_user_lists ⇒ Array<String>

Requests containing any of these users list ids will not match. Corresponds to the JSON property excludedUserLists

Returns:

  • (Array<String>) 


2291
2292
2293
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2291

def excluded_user_lists
  @excluded_user_lists
end

#excluded_verticals ⇒ Array<String>

Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section. Corresponds to the JSON property excludedVerticals

Returns:

  • (Array<String>) 


2297
2298
2299
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2297

def excluded_verticals
  @excluded_verticals
end

#geo_criteria_ids ⇒ Array<String>

Requests containing any of these geo criteria ids will match. Corresponds to the JSON property geoCriteriaIds

Returns:

  • (Array<String>) 


2302
2303
2304
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2302

def geo_criteria_ids
  @geo_criteria_ids
end

#is_active ⇒ Boolean Also known as: is_active?

Whether this config is active. Required for all requests. Corresponds to the JSON property isActive

Returns:

  • (Boolean) 


2307
2308
2309
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2307

def is_active
  @is_active
end

#kind ⇒ String

The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig". Corresponds to the JSON property kind

Returns:

  • (String) 


2313
2314
2315
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2313

def kind
  @kind
end

#languages ⇒ Array<String>

Request containing any of these language codes will match. Corresponds to the JSON property languages

Returns:

  • (Array<String>) 


2318
2319
2320
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2318

def languages
  @languages
end

#mobile_carriers ⇒ Array<String>

Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section. Corresponds to the JSON property mobileCarriers

Returns:

  • (Array<String>) 


2324
2325
2326
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2324

def mobile_carriers
  @mobile_carriers
end

#mobile_devices ⇒ Array<String>

Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section. Corresponds to the JSON property mobileDevices

Returns:

  • (Array<String>) 


2330
2331
2332
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2330

def mobile_devices
  @mobile_devices
end

#mobile_operating_system_versions ⇒ Array<String>

Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section. Corresponds to the JSON property mobileOperatingSystemVersions

Returns:

  • (Array<String>) 


2336
2337
2338
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2336

def mobile_operating_system_versions
  @mobile_operating_system_versions
end

#placements ⇒ Array<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::Placement>

Requests containing any of these placements will match. Corresponds to the JSON property placements

Returns:



2341
2342
2343
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2341

def placements
  @placements
end

#platforms ⇒ Array<String>

Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET. Corresponds to the JSON property platforms

Returns:

  • (Array<String>) 


2348
2349
2350
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2348

def platforms
  @platforms
end

#supported_creative_attributes ⇒ Array<String>

Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section. Corresponds to the JSON property supportedCreativeAttributes

Returns:

  • (Array<String>) 


2355
2356
2357
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2355

def supported_creative_attributes
  @supported_creative_attributes
end

#user_lists ⇒ Array<String>

Requests containing any of these user list ids will match. Corresponds to the JSON property userLists

Returns:

  • (Array<String>) 


2360
2361
2362
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2360

def user_lists
  @user_lists
end

#vendor_types ⇒ Array<String>

Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section. Corresponds to the JSON property vendorTypes

Returns:

  • (Array<String>) 


2366
2367
2368
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2366

def vendor_types
  @vendor_types
end

#verticals ⇒ Array<String>

Requests containing any of these vertical ids will match. Corresponds to the JSON property verticals

Returns:

  • (Array<String>) 


2371
2372
2373
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2371

def verticals
  @verticals
end

#video_player_sizes ⇒ Array<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::VideoPlayerSize>

Video requests satisfying any of these player size constraints will match. Corresponds to the JSON property videoPlayerSizes

Returns:



2376
2377
2378
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2376

def video_player_sizes
  @video_player_sizes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2383

def update!(**args)
  @billing_id = args[:billing_id] if args.key?(:billing_id)
  @config_id = args[:config_id] if args.key?(:config_id)
  @config_name = args[:config_name] if args.key?(:config_name)
  @creative_type = args[:creative_type] if args.key?(:creative_type)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @excluded_content_labels = args[:excluded_content_labels] if args.key?(:excluded_content_labels)
  @excluded_geo_criteria_ids = args[:excluded_geo_criteria_ids] if args.key?(:excluded_geo_criteria_ids)
  @excluded_placements = args[:excluded_placements] if args.key?(:excluded_placements)
  @excluded_user_lists = args[:excluded_user_lists] if args.key?(:excluded_user_lists)
  @excluded_verticals = args[:excluded_verticals] if args.key?(:excluded_verticals)
  @geo_criteria_ids = args[:geo_criteria_ids] if args.key?(:geo_criteria_ids)
  @is_active = args[:is_active] if args.key?(:is_active)
  @kind = args[:kind] if args.key?(:kind)
  @languages = args[:languages] if args.key?(:languages)
  @mobile_carriers = args[:mobile_carriers] if args.key?(:mobile_carriers)
  @mobile_devices = args[:mobile_devices] if args.key?(:mobile_devices)
  @mobile_operating_system_versions = args[:mobile_operating_system_versions] if args.key?(:mobile_operating_system_versions)
  @placements = args[:placements] if args.key?(:placements)
  @platforms = args[:platforms] if args.key?(:platforms)
  @supported_creative_attributes = args[:supported_creative_attributes] if args.key?(:supported_creative_attributes)
  @user_lists = args[:user_lists] if args.key?(:user_lists)
  @vendor_types = args[:vendor_types] if args.key?(:vendor_types)
  @verticals = args[:verticals] if args.key?(:verticals)
  @video_player_sizes = args[:video_player_sizes] if args.key?(:video_player_sizes)
end