Class: Google::Apis::DfareportingV3_4::AdBlockingConfiguration

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_4/classes.rb,
generated/google/apis/dfareporting_v3_4/representations.rb,
generated/google/apis/dfareporting_v3_4/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.


887
888
889
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 887

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

Instance Attribute Details

#click_through_urlString

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)

861
862
863
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 861

def click_through_url
  @click_through_url
end

#creative_bundle_idFixnum

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)

868
869
870
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 868

def creative_bundle_id
  @creative_bundle_id
end

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

876
877
878
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 876

def enabled
  @enabled
end

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

884
885
886
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 884

def override_click_through_url
  @override_click_through_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


892
893
894
895
896
897
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 892

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