Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesAdGroup

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

Overview

An ad group.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ResourcesAdGroup

Returns a new instance of GoogleAdsSearchads360V0ResourcesAdGroup.



4216
4217
4218
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4216

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

Instance Attribute Details

#ad_rotation_mode ⇒ String

The ad rotation mode of the ad group. Corresponds to the JSON property adRotationMode

Returns:

  • (String) 


4111
4112
4113
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4111

def ad_rotation_mode
  @ad_rotation_mode
end

#cpc_bid_micros ⇒ Fixnum

The maximum CPC (cost-per-click) bid. Corresponds to the JSON property cpcBidMicros

Returns:

  • (Fixnum) 


4116
4117
4118
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4116

def cpc_bid_micros
  @cpc_bid_micros
end

#creation_time ⇒ String

Output only. The timestamp when this ad_group was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. Corresponds to the JSON property creationTime

Returns:

  • (String) 


4122
4123
4124
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4122

def creation_time
  @creation_time
end

#effective_labels ⇒ Array<String>

Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group. Corresponds to the JSON property effectiveLabels

Returns:

  • (Array<String>) 


4128
4129
4130
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4128

def effective_labels
  @effective_labels
end

#end_date ⇒ String

Output only. Date when the ad group ends serving ads. By default, the ad group ends on the ad group's end date. If this field is set, then the ad group ends at the end of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14 Corresponds to the JSON property endDate

Returns:

  • (String) 


4137
4138
4139
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4137

def end_date
  @end_date
end

#engine_id ⇒ String

Output only. ID of the ad group in the external engine account. This field is for non-Google Ads account only, for example, Yahoo Japan, Microsoft, Baidu etc. For Google Ads entity, use "ad_group.id" instead. Corresponds to the JSON property engineId

Returns:

  • (String) 


4144
4145
4146
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4144

def engine_id
  @engine_id
end

#engine_status ⇒ String

Output only. The Engine Status for ad group. Corresponds to the JSON property engineStatus

Returns:

  • (String) 


4149
4150
4151
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4149

def engine_status
  @engine_status
end

#id ⇒ Fixnum

Output only. The ID of the ad group. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


4154
4155
4156
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4154

def id
  @id
end

#labels ⇒ Array<String>

Output only. The resource names of labels attached to this ad group. Corresponds to the JSON property labels

Returns:

  • (Array<String>) 


4159
4160
4161
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4159

def labels
  @labels
end

#language_code ⇒ String

Output only. The language of the ads and keywords in an ad group. This field is only available for Microsoft Advertising accounts. More details: https:// docs.microsoft.com/en-us/advertising/guides/ad-languages?view=bingads-13# adlanguage Corresponds to the JSON property languageCode

Returns:

  • (String) 


4167
4168
4169
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4167

def language_code
  @language_code
end

#last_modified_time ⇒ String

Output only. The datetime when this ad group was last modified. The datetime is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss.ssssss" format. Corresponds to the JSON property lastModifiedTime

Returns:

  • (String) 


4173
4174
4175
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4173

def last_modified_time
  @last_modified_time
end

#name ⇒ String

The name of the ad group. This field is required and should not be empty when creating new ad groups. It must contain fewer than 255 UTF-8 full-width characters. It must not contain any null (code point 0x0), NL line feed (code point 0xA) or carriage return (code point 0xD) characters. Corresponds to the JSON property name

Returns:

  • (String) 


4181
4182
4183
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4181

def name
  @name
end

#resource_name ⇒ String

Immutable. The resource name of the ad group. Ad group resource names have the form: customers/customer_id/adGroups/ad_group_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


4187
4188
4189
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4187

def resource_name
  @resource_name
end

#start_date ⇒ String

Output only. Date when this ad group starts serving ads. By default, the ad group starts now or the ad group's start date, whichever is later. If this field is set, then the ad group starts at the beginning of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03- 14 Corresponds to the JSON property startDate

Returns:

  • (String) 


4197
4198
4199
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4197

def start_date
  @start_date
end

#status ⇒ String

The status of the ad group. Corresponds to the JSON property status

Returns:

  • (String) 


4202
4203
4204
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4202

def status
  @status
end

#targeting_setting ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonTargetingSetting

Settings for the targeting-related features, at the campaign and ad group levels. For more details about the targeting setting, visit https://support. google.com/google-ads/answer/7365594 Corresponds to the JSON property targetingSetting

Returns:



4209
4210
4211
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4209

def targeting_setting
  @targeting_setting
end

#type ⇒ String

Immutable. The type of the ad group. Corresponds to the JSON property type

Returns:

  • (String) 


4214
4215
4216
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4214

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4221

def update!(**args)
  @ad_rotation_mode = args[:ad_rotation_mode] if args.key?(:ad_rotation_mode)
  @cpc_bid_micros = args[:cpc_bid_micros] if args.key?(:cpc_bid_micros)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @effective_labels = args[:effective_labels] if args.key?(:effective_labels)
  @end_date = args[:end_date] if args.key?(:end_date)
  @engine_id = args[:engine_id] if args.key?(:engine_id)
  @engine_status = args[:engine_status] if args.key?(:engine_status)
  @id = args[:id] if args.key?(:id)
  @labels = args[:labels] if args.key?(:labels)
  @language_code = args[:language_code] if args.key?(:language_code)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @name = args[:name] if args.key?(:name)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @start_date = args[:start_date] if args.key?(:start_date)
  @status = args[:status] if args.key?(:status)
  @targeting_setting = args[:targeting_setting] if args.key?(:targeting_setting)
  @type = args[:type] if args.key?(:type)
end