Class: Google::Apis::AdexchangebuyerV1_4::PretargetingConfig
- Inherits:
-
Object
- Object
- Google::Apis::AdexchangebuyerV1_4::PretargetingConfig
- 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
-
#billing_id ⇒ Fixnum
The id for billing purposes, provided for reference.
-
#config_id ⇒ Fixnum
The config id; generated automatically.
-
#config_name ⇒ String
The name of the config.
-
#creative_type ⇒ Array<String>
List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.
-
#dimensions ⇒ Array<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::Dimension>
Requests which allow one of these (width, height) pairs will match.
-
#excluded_content_labels ⇒ Array<Fixnum>
Requests with any of these content labels will not match.
-
#excluded_geo_criteria_ids ⇒ Array<Fixnum>
Requests containing any of these geo criteria ids will not match.
-
#excluded_placements ⇒ Array<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::ExcludedPlacement>
Requests containing any of these placements will not match.
-
#excluded_user_lists ⇒ Array<Fixnum>
Requests containing any of these users list ids will not match.
-
#excluded_verticals ⇒ Array<Fixnum>
Requests containing any of these vertical ids will not match.
-
#geo_criteria_ids ⇒ Array<Fixnum>
Requests containing any of these geo criteria ids will match.
-
#is_active ⇒ Boolean
(also: #is_active?)
Whether this config is active.
-
#kind ⇒ String
The kind of the resource, i.e.
-
#languages ⇒ Array<String>
Request containing any of these language codes will match.
-
#maximum_qps ⇒ Fixnum
The maximum QPS allocated to this pretargeting configuration, used for pretargeting-level QPS limits.
-
#minimum_viewability_decile ⇒ Fixnum
Requests where the predicted viewability is below the specified decile will not match.
-
#mobile_carriers ⇒ Array<Fixnum>
Requests containing any of these mobile carrier ids will match.
-
#mobile_devices ⇒ Array<Fixnum>
Requests containing any of these mobile device ids will match.
-
#mobile_operating_system_versions ⇒ Array<Fixnum>
Requests containing any of these mobile operating system version ids will match.
-
#placements ⇒ Array<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::Placement>
Requests containing any of these placements will match.
-
#platforms ⇒ Array<String>
Requests matching any of these platforms will match.
-
#supported_creative_attributes ⇒ Array<Fixnum>
Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute.
-
#user_identifier_data_required ⇒ Array<String>
Requests containing the specified type of user data will match.
-
#user_lists ⇒ Array<Fixnum>
Requests containing any of these user list ids will match.
-
#vendor_types ⇒ Array<Fixnum>
Requests that allow any of these vendor ids will match.
-
#verticals ⇒ Array<Fixnum>
Requests containing any of these vertical ids will match.
-
#video_player_sizes ⇒ Array<Google::Apis::AdexchangebuyerV1_4::PretargetingConfig::VideoPlayerSize>
Video requests satisfying any of these player size constraints will match.
Instance Method Summary collapse
-
#initialize(**args) ⇒ PretargetingConfig
constructor
A new instance of PretargetingConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ PretargetingConfig
Returns a new instance of PretargetingConfig.
2582 2583 2584 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2582 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
2427 2428 2429 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2427 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
2433 2434 2435 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2433 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
2438 2439 2440 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2438 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
2444 2445 2446 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2444 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
2450 2451 2452 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2450 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
2456 2457 2458 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2456 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
2461 2462 2463 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2461 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
2466 2467 2468 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2466 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
2471 2472 2473 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2471 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
2477 2478 2479 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2477 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
2482 2483 2484 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2482 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
2487 2488 2489 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2487 def is_active @is_active end |
#kind ⇒ String
The kind of the resource, i.e. "adexchangebuyer#pretargetingConfig".
Corresponds to the JSON property kind
2493 2494 2495 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2493 def kind @kind end |
#languages ⇒ Array<String>
Request containing any of these language codes will match.
Corresponds to the JSON property languages
2498 2499 2500 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2498 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
2506 2507 2508 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2506 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
2514 2515 2516 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2514 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
2520 2521 2522 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2520 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
2526 2527 2528 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2526 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
2532 2533 2534 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2532 def @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
2537 2538 2539 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2537 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
2544 2545 2546 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2544 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
2551 2552 2553 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2551 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
2559 2560 2561 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2559 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
2564 2565 2566 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2564 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
2570 2571 2572 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2570 def vendor_types @vendor_types end |
#verticals ⇒ Array<Fixnum>
Requests containing any of these vertical ids will match.
Corresponds to the JSON property verticals
2575 2576 2577 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2575 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
2580 2581 2582 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2580 def video_player_sizes @video_player_sizes end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 |
# File 'generated/google/apis/adexchangebuyer_v1_4/classes.rb', line 2587 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 |