Class: Google::Apis::DisplayvideoV4::AdGroup

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

Overview

A single ad group associated with a line item.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AdGroup

Returns a new instance of AdGroup.



184
185
186
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 184

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

Instance Attribute Details

#ad_group_format ⇒ String

Required. Immutable. The format of the ads in the ad group. Corresponds to the JSON property adGroupFormat

Returns:

  • (String) 


127
128
129
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 127

def ad_group_format
  @ad_group_format
end

#ad_group_id ⇒ Fixnum

Output only. The unique ID of the ad group. Assigned by the system. Corresponds to the JSON property adGroupId

Returns:

  • (Fixnum) 


132
133
134
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 132

def ad_group_id
  @ad_group_id
end

#ad_group_inventory_control ⇒ Google::Apis::DisplayvideoV4::AdGroupInventoryControl

The inventory control of the ad group. Corresponds to the JSON property adGroupInventoryControl

Returns:



137
138
139
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 137

def ad_group_inventory_control
  @ad_group_inventory_control
end

#advertiser_id ⇒ Fixnum

Output only. The unique ID of the advertiser the ad group belongs to. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


142
143
144
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 142

def advertiser_id
  @advertiser_id
end

#bid_strategy ⇒ Google::Apis::DisplayvideoV4::BiddingStrategy

Settings that control the bid strategy. Bid strategy determines the bid price. Corresponds to the JSON property bidStrategy

Returns:



147
148
149
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 147

def bid_strategy
  @bid_strategy
end

#display_name ⇒ String

Required. The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes. Corresponds to the JSON property displayName

Returns:

  • (String) 


153
154
155
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 153

def display_name
  @display_name
end

#entity_status ⇒ String

Required. Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can' t spend its budget even if its own status is ENTITY_STATUS_ACTIVE. Corresponds to the JSON property entityStatus

Returns:

  • (String) 


160
161
162
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 160

def entity_status
  @entity_status
end

#line_item_id ⇒ Fixnum

Required. Immutable. The unique ID of the line item that the ad group belongs to. Corresponds to the JSON property lineItemId

Returns:

  • (Fixnum) 


166
167
168
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 166

def line_item_id
  @line_item_id
end

#name ⇒ String

Output only. Identifier. The resource name of the ad group. Corresponds to the JSON property name

Returns:

  • (String) 


171
172
173
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 171

def name
  @name
end

#product_feed_data ⇒ Google::Apis::DisplayvideoV4::ProductFeedData

The details of product feed. Corresponds to the JSON property productFeedData

Returns:



176
177
178
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 176

def product_feed_data
  @product_feed_data
end

#targeting_expansion ⇒ Google::Apis::DisplayvideoV4::TargetingExpansionConfig

Settings that control the optimized targeting settings of the line item. Corresponds to the JSON property targetingExpansion

Returns:



182
183
184
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 182

def targeting_expansion
  @targeting_expansion
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/google/apis/displayvideo_v4/classes.rb', line 189

def update!(**args)
  @ad_group_format = args[:ad_group_format] if args.key?(:ad_group_format)
  @ad_group_id = args[:ad_group_id] if args.key?(:ad_group_id)
  @ad_group_inventory_control = args[:ad_group_inventory_control] if args.key?(:ad_group_inventory_control)
  @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id)
  @bid_strategy = args[:bid_strategy] if args.key?(:bid_strategy)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_status = args[:entity_status] if args.key?(:entity_status)
  @line_item_id = args[:line_item_id] if args.key?(:line_item_id)
  @name = args[:name] if args.key?(:name)
  @product_feed_data = args[:product_feed_data] if args.key?(:product_feed_data)
  @targeting_expansion = args[:targeting_expansion] if args.key?(:targeting_expansion)
end