Class: Google::Apis::DfareportingV3_1::AdBlockingConfiguration

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

Overview

Campaign ad blocking settings.

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

Returns a new instance of AdBlockingConfiguration



956
957
958
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 956

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

Instance Attribute Details

#click_through_url ⇒ String

Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. Corresponds to the JSON property clickThroughUrl

Returns:

  • (String) 


930
931
932
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 930

def click_through_url
  @click_through_url
end

#creative_bundle_id ⇒ Fixnum

ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. Corresponds to the JSON property creativeBundleId

Returns:

  • (Fixnum) 


937
938
939
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 937

def creative_bundle_id
  @creative_bundle_id
end

#enabled ⇒ Boolean Also known as: enabled?

Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


945
946
947
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 945

def enabled
  @enabled
end

#override_click_through_url ⇒ Boolean Also known as: override_click_through_url?

Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. Corresponds to the JSON property overrideClickThroughUrl

Returns:

  • (Boolean) 


953
954
955
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 953

def override_click_through_url
  @override_click_through_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



961
962
963
964
965
966
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 961

def update!(**args)
  @click_through_url = args[:click_through_url] if args.key?(:click_through_url)
  @creative_bundle_id = args[:creative_bundle_id] if args.key?(:creative_bundle_id)
  @enabled = args[:enabled] if args.key?(:enabled)
  @override_click_through_url = args[:override_click_through_url] if args.key?(:override_click_through_url)
end