Class: Google::Ads::AdManager::V1::AdUnit

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/ads/admanager/v1/ad_unit_messages.rb

Overview

The AdUnit resource.

Instance Attribute Summary collapse

Instance Attribute Details

#ad_unit_code ⇒ ::String

Returns Immutable. A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based on the ad unit ID.

Returns:

  • (::String) —

    Immutable. A string used to uniquely identify the ad unit for the purposes of serving the ad. This attribute is optional and can be set during ad unit creation. If it is not provided, it will be assigned by Google based on the ad unit ID.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#ad_unit_id ⇒ ::Integer (readonly)

Returns Output only. AdUnit ID.

Returns:

  • (::Integer) —

    Output only. AdUnit ID.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#ad_unit_sizes ⇒ ::Array<::Google::Ads::AdManager::V1::AdUnitSize>

Returns Optional. The sizes that can be served inside this ad unit.

Returns:



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#applied_adsense_enabled ⇒ ::Boolean

Returns Optional. The value of AdSense enabled directly applied to this ad unit. This attribute is optional and if not specified this ad unit will inherit the value of effectiveAdsenseEnabled from its ancestors.

Returns:

  • (::Boolean) —

    Optional. The value of AdSense enabled directly applied to this ad unit. This attribute is optional and if not specified this ad unit will inherit the value of effectiveAdsenseEnabled from its ancestors.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#applied_label_frequency_caps ⇒ ::Array<::Google::Ads::AdManager::V1::LabelFrequencyCap>

Returns Optional. The set of label frequency caps applied directly to this ad unit. There is a limit of 10 label frequency caps per ad unit.

Returns:



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#applied_labels ⇒ ::Array<::Google::Ads::AdManager::V1::AppliedLabel>

Returns Optional. The set of labels applied directly to this ad unit.

Returns:



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#applied_target_window ⇒ ::Google::Ads::AdManager::V1::TargetWindowEnum::TargetWindow

Returns Optional. The target window directly applied to this AdUnit. If this field is not set, this AdUnit uses the target window specified in effectiveTargetWindow.

Returns:



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#applied_teams ⇒ ::Array<::String>

Returns Optional. The resource names of Teams directly applied to this AdUnit. Format: "networks/{network_code}/teams/{team_id}".

Returns:

  • (::Array<::String>) —

    Optional. The resource names of Teams directly applied to this AdUnit. Format: "networks/{network_code}/teams/{team_id}"



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#description ⇒ ::String

Returns Optional. A description of the ad unit. The maximum length is 65,535 characters.

Returns:

  • (::String) —

    Optional. A description of the ad unit. The maximum length is 65,535 characters.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#display_name ⇒ ::String

Returns Required. The display name of the ad unit. Its maximum length is 255 characters.

Returns:

  • (::String) —

    Required. The display name of the ad unit. Its maximum length is 255 characters.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#effective_adsense_enabled ⇒ ::Boolean (readonly)

Returns Output only. Specifies whether or not the AdUnit is enabled for serving ads from the AdSense content network. This attribute defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set appliedAdsenseEnabled, the attribute is defaulted to true.

Returns:

  • (::Boolean) —

    Output only. Specifies whether or not the AdUnit is enabled for serving ads from the AdSense content network. This attribute defaults to the ad unit's parent or ancestor's setting if one has been set. If no ancestor of the ad unit has set appliedAdsenseEnabled, the attribute is defaulted to true.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#effective_applied_labels ⇒ ::Array<::Google::Ads::AdManager::V1::AppliedLabel> (readonly)

Returns Output only. Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.

Returns:

  • (::Array<::Google::Ads::AdManager::V1::AppliedLabel>) —

    Output only. Contains the set of labels applied directly to the ad unit as well as those inherited from the parent ad units. If a label has been negated, only the negated label is returned. This field is readonly and is assigned by Google.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#effective_label_frequency_caps ⇒ ::Array<::Google::Ads::AdManager::V1::LabelFrequencyCap> (readonly)

Returns Output only. The label frequency caps applied directly to the ad unit as well as those inherited from parent ad units.

Returns:



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#effective_target_window ⇒ ::Google::Ads::AdManager::V1::TargetWindowEnum::TargetWindow (readonly)

Returns Output only. Non-empty default. The target window of this AdUnit. This value is inherited from ancestor AdUnits and defaults to TOP if no AdUnit in the hierarchy specifies it.

Returns:



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#explicitly_targeted ⇒ ::Boolean

Returns Optional. If this field is set to true, then the AdUnit will not be implicitly targeted when its parent is. Traffickers must explicitly target such an AdUnit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.

Returns:

  • (::Boolean) —

    Optional. If this field is set to true, then the AdUnit will not be implicitly targeted when its parent is. Traffickers must explicitly target such an AdUnit or else no line items will serve to it. This feature is only available for Ad Manager 360 accounts.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#external_set_top_box_channel_id ⇒ ::String

Returns Optional. Determines what set top box video on demand channel this ad unit corresponds to in an external set top box ad campaign system.

Returns:

  • (::String) —

    Optional. Determines what set top box video on demand channel this ad unit corresponds to in an external set top box ad campaign system.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#has_children ⇒ ::Boolean (readonly)

Returns Output only. This field is set to true if the ad unit has any children.

Returns:

  • (::Boolean) —

    Output only. This field is set to true if the ad unit has any children.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#name ⇒ ::String

Returns Identifier. The resource name of the AdUnit. Format: networks/{network_code}/adUnits/{ad_unit_id}.

Returns:

  • (::String) —

    Identifier. The resource name of the AdUnit. Format: networks/{network_code}/adUnits/{ad_unit_id}



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent_ad_unit ⇒ ::String

Returns Required. Immutable. The AdUnit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. Format: "networks/{network_code}/adUnits/{ad_unit_id}".

Returns:

  • (::String) —

    Required. Immutable. The AdUnit's parent. Every ad unit has a parent except for the root ad unit, which is created by Google. Format: "networks/{network_code}/adUnits/{ad_unit_id}"



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent_path ⇒ ::Array<::Google::Ads::AdManager::V1::AdUnitParent> (readonly)

Returns Output only. The path to this AdUnit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty.

Returns:

  • (::Array<::Google::Ads::AdManager::V1::AdUnitParent>) —

    Output only. The path to this AdUnit in the ad unit hierarchy represented as a list from the root to this ad unit's parent. For root ad units, this list is empty.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#refresh_delay ⇒ ::Google::Protobuf::Duration

Returns Optional. The duration after which an Ad Unit will automatically refresh. This is only valid for ad units in mobile apps. If not set, the ad unit will not refresh.

Returns:

  • (::Google::Protobuf::Duration) —

    Optional. The duration after which an Ad Unit will automatically refresh. This is only valid for ad units in mobile apps. If not set, the ad unit will not refresh.



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#smart_size_mode ⇒ ::Google::Ads::AdManager::V1::SmartSizeModeEnum::SmartSizeMode

Returns Optional. The smart size mode for this ad unit. This attribute is optional and defaults to SmartSizeMode.NONE for fixed sizes.

Returns:



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#status ⇒ ::Google::Ads::AdManager::V1::AdUnitStatusEnum::AdUnitStatus (readonly)

Returns Output only. The status of this ad unit. It defaults to ACTIVE.

Returns:



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#teams ⇒ ::Array<::String> (readonly)

Returns Output only. The resource names of all Teams that this AdUnit is on as well as those inherited from parent AdUnits. Format: "networks/{network_code}/teams/{team_id}".

Returns:

  • (::Array<::String>) —

    Output only. The resource names of all Teams that this AdUnit is on as well as those inherited from parent AdUnits. Format: "networks/{network_code}/teams/{team_id}"



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The time this AdUnit was last modified.

Returns:



134
135
136
137
 
# File 'proto_docs/google/ads/admanager/v1/ad_unit_messages.rb', line 134

class AdUnit
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end