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

Constructor Details

#initialize(**args) ⇒ PretargetingConfig

Returns a new instance of PretargetingConfig.



2613
2614
2615
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2613

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

Instance Attribute Details

#billing_id ⇒ Fixnum

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:

  • (Fixnum) 


2458
2459
2460
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2458

def billing_id
  @billing_id
end

#config_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2464
2465
2466
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2464

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) 


2469
2470
2471
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2469

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


2475
2476
2477
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2475

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:



2481
2482
2483
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2481

def dimensions
  @dimensions
end

#excluded_content_labels ⇒ Array<Fixnum>

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<Fixnum>) 


2487
2488
2489
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2487

def excluded_content_labels
  @excluded_content_labels
end

#excluded_geo_criteria_ids ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


2492
2493
2494
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2492

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:



2497
2498
2499
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2497

def excluded_placements
  @excluded_placements
end

#excluded_user_lists ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


2502
2503
2504
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2502

def excluded_user_lists
  @excluded_user_lists
end

#excluded_verticals ⇒ Array<Fixnum>

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<Fixnum>) 


2508
2509
2510
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2508

def excluded_verticals
  @excluded_verticals
end

#geo_criteria_ids ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


2513
2514
2515
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2513

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) 


2518
2519
2520
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2518

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) 


2524
2525
2526
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2524

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


2529
2530
2531
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2529

def languages
  @languages
end

#maximum_qps ⇒ Fixnum

The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits. By default, this is not set, which indicates that there is no QPS limit at the configuration level (a global or account- level limit may still be imposed). Corresponds to the JSON property maximumQps

Returns:

  • (Fixnum) 


2537
2538
2539
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2537

def maximum_qps
  @maximum_qps
end

#minimum_viewability_decile ⇒ Fixnum

Requests where the predicted viewability is below the specified decile will not match. E.g. if the buyer sets this value to 5, requests from slots where the predicted viewability is below 50% will not match. If the predicted viewability is unknown this field will be ignored. Corresponds to the JSON property minimumViewabilityDecile

Returns:

  • (Fixnum) 


2545
2546
2547
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2545

def minimum_viewability_decile
  @minimum_viewability_decile
end

#mobile_carriers ⇒ Array<Fixnum>

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<Fixnum>) 


2551
2552
2553
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2551

def mobile_carriers
  @mobile_carriers
end

#mobile_devices ⇒ Array<Fixnum>

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<Fixnum>) 


2557
2558
2559
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2557

def mobile_devices
  @mobile_devices
end

#mobile_operating_system_versions ⇒ Array<Fixnum>

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<Fixnum>) 


2563
2564
2565
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2563

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:



2568
2569
2570
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2568

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


2575
2576
2577
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2575

def platforms
  @platforms
end

#supported_creative_attributes ⇒ Array<Fixnum>

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<Fixnum>) 


2582
2583
2584
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2582

def supported_creative_attributes
  @supported_creative_attributes
end

#user_identifier_data_required ⇒ Array<String>

Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA. Corresponds to the JSON property userIdentifierDataRequired

Returns:

  • (Array<String>) 


2590
2591
2592
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2590

def user_identifier_data_required
  @user_identifier_data_required
end

#user_lists ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


2595
2596
2597
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2595

def user_lists
  @user_lists
end

#vendor_types ⇒ Array<Fixnum>

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<Fixnum>) 


2601
2602
2603
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2601

def vendor_types
  @vendor_types
end

#verticals ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


2606
2607
2608
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2606

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:



2611
2612
2613
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2611

def video_player_sizes
  @video_player_sizes
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
 
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2618

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)
  @maximum_qps = args[:maximum_qps] if args.key?(:maximum_qps)
  @minimum_viewability_decile = args[:minimum_viewability_decile] if args.key?(:minimum_viewability_decile)
  @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_identifier_data_required = args[:user_identifier_data_required] if args.key?(:user_identifier_data_required)
  @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