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.



2906
2907
2908
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2906

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) 


2807
2808
2809
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2807

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) 


2812
2813
2814
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2812

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) 


2818
2819
2820
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2818

def creation_time
  @creation_time
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) 


2827
2828
2829
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2827

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) 


2834
2835
2836
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2834

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) 


2839
2840
2841
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2839

def engine_status
  @engine_status
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2844
2845
2846
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2844

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


2849
2850
2851
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2849

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) 


2857
2858
2859
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2857

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) 


2863
2864
2865
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2863

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) 


2871
2872
2873
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2871

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) 


2877
2878
2879
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2877

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) 


2887
2888
2889
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2887

def start_date
  @start_date
end

#status ⇒ String

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

Returns:

  • (String) 


2892
2893
2894
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2892

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:



2899
2900
2901
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2899

def targeting_setting
  @targeting_setting
end

#type ⇒ String

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

Returns:

  • (String) 


2904
2905
2906
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2904

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2911

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)
  @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