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.


2451
2452
2453
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2451

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

Instance Attribute Details

#billing_idString

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)

2320
2321
2322
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2320

def billing_id
  @billing_id
end

#config_idString

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

Returns:

  • (String)

2326
2327
2328
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2326

def config_id
  @config_id
end

#config_nameString

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

Returns:

  • (String)

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

def config_name
  @config_name
end

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

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

def creative_type
  @creative_type
end

#dimensionsArray<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


2343
2344
2345
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2343

def dimensions
  @dimensions
end

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

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

def 
  @excluded_content_labels
end

#excluded_geo_criteria_idsArray<String>

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

Returns:

  • (Array<String>)

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

def excluded_geo_criteria_ids
  @excluded_geo_criteria_ids
end

#excluded_placementsArray<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::ExcludedPlacement>

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


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

def excluded_placements
  @excluded_placements
end

#excluded_user_listsArray<String>

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

Returns:

  • (Array<String>)

2364
2365
2366
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2364

def excluded_user_lists
  @excluded_user_lists
end

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

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

def excluded_verticals
  @excluded_verticals
end

#geo_criteria_idsArray<String>

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

Returns:

  • (Array<String>)

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

def geo_criteria_ids
  @geo_criteria_ids
end

#is_activeBoolean Also known as: is_active?

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

Returns:

  • (Boolean)

2380
2381
2382
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2380

def is_active
  @is_active
end

#kindString

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

Returns:

  • (String)

2386
2387
2388
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2386

def kind
  @kind
end

#languagesArray<String>

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

Returns:

  • (Array<String>)

2391
2392
2393
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2391

def languages
  @languages
end

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

2397
2398
2399
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2397

def mobile_carriers
  @mobile_carriers
end

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

2403
2404
2405
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2403

def mobile_devices
  @mobile_devices
end

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

2409
2410
2411
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2409

def mobile_operating_system_versions
  @mobile_operating_system_versions
end

#placementsArray<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::Placement>

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


2414
2415
2416
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2414

def placements
  @placements
end

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

2421
2422
2423
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2421

def platforms
  @platforms
end

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

2428
2429
2430
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2428

def supported_creative_attributes
  @supported_creative_attributes
end

#user_listsArray<String>

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

Returns:

  • (Array<String>)

2433
2434
2435
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2433

def user_lists
  @user_lists
end

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

2439
2440
2441
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2439

def vendor_types
  @vendor_types
end

#verticalsArray<String>

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

Returns:

  • (Array<String>)

2444
2445
2446
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2444

def verticals
  @verticals
end

#video_player_sizesArray<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::VideoPlayerSize>

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


2449
2450
2451
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2449

def video_player_sizes
  @video_player_sizes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2456

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