Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesAdGroupCriterion

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 criterion.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ResourcesAdGroupCriterion

Returns a new instance of GoogleAdsSearchads360V0ResourcesAdGroupCriterion.



2119
2120
2121
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2119

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

Instance Attribute Details

#ad_group ⇒ String

Immutable. The ad group to which the criterion belongs. Corresponds to the JSON property adGroup

Returns:

  • (String) 


2015
2016
2017
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2015

def ad_group
  @ad_group
end

#age_range ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonAgeRangeInfo

An age range criterion. Corresponds to the JSON property ageRange

Returns:



2020
2021
2022
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2020

def age_range
  @age_range
end

#bid_modifier ⇒ Float

The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Corresponds to the JSON property bidModifier

Returns:

  • (Float) 


2026
2027
2028
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2026

def bid_modifier
  @bid_modifier
end

#cpc_bid_micros ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2031
2032
2033
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2031

def cpc_bid_micros
  @cpc_bid_micros
end

#criterion_id ⇒ Fixnum

Output only. The ID of the criterion. Corresponds to the JSON property criterionId

Returns:

  • (Fixnum) 


2036
2037
2038
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2036

def criterion_id
  @criterion_id
end

#effective_cpc_bid_micros ⇒ Fixnum

Output only. The effective CPC (cost-per-click) bid. Corresponds to the JSON property effectiveCpcBidMicros

Returns:

  • (Fixnum) 


2041
2042
2043
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2041

def effective_cpc_bid_micros
  @effective_cpc_bid_micros
end

#engine_status ⇒ String

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

Returns:

  • (String) 


2046
2047
2048
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2046

def engine_status
  @engine_status
end

#final_url_suffix ⇒ String

URL template for appending params to final URL. Corresponds to the JSON property finalUrlSuffix

Returns:

  • (String) 


2051
2052
2053
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2051

def final_url_suffix
  @final_url_suffix
end

#final_urls ⇒ Array<String>

The list of possible final URLs after all cross-domain redirects for the ad. Corresponds to the JSON property finalUrls

Returns:

  • (Array<String>) 


2056
2057
2058
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2056

def final_urls
  @final_urls
end

#gender ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonGenderInfo

A gender criterion. Corresponds to the JSON property gender

Returns:



2061
2062
2063
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2061

def gender
  @gender
end

#keyword ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonKeywordInfo

A keyword criterion. Corresponds to the JSON property keyword

Returns:



2066
2067
2068
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2066

def keyword
  @keyword
end

#last_modified_time ⇒ String

Output only. The datetime when this ad group criterion 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) 


2073
2074
2075
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2073

def last_modified_time
  @last_modified_time
end

#listing_group ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonListingGroupInfo

A listing group criterion. Corresponds to the JSON property listingGroup

Returns:



2078
2079
2080
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2078

def listing_group
  @listing_group
end

#quality_info ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesAdGroupCriterionQualityInfo

A container for ad group criterion quality information. Corresponds to the JSON property qualityInfo

Returns:



2083
2084
2085
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2083

def quality_info
  @quality_info
end

#resource_name ⇒ String

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

Returns:

  • (String) 


2090
2091
2092
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2090

def resource_name
  @resource_name
end

#status ⇒ String

The status of the criterion. This is the status of the ad group criterion entity, set by the client. Note: UI reports may incorporate additional information that affects whether a criterion is eligible to run. In some cases a criterion that's REMOVED in the API can still show as enabled in the UI. For example, campaigns by default show to users of all age ranges unless excluded. The UI will show each age range as "enabled", since they're eligible to see the ads; but AdGroupCriterion.status will show "removed", since no positive criterion was added. Corresponds to the JSON property status

Returns:

  • (String) 


2102
2103
2104
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2102

def status
  @status
end

#tracking_url_template ⇒ String

The URL template for constructing a tracking URL. Corresponds to the JSON property trackingUrlTemplate

Returns:

  • (String) 


2107
2108
2109
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2107

def tracking_url_template
  @tracking_url_template
end

#type ⇒ String

Output only. The type of the criterion. Corresponds to the JSON property type

Returns:

  • (String) 


2112
2113
2114
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2112

def type
  @type
end

#webpage ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonWebpageInfo

Represents a criterion for targeting webpages of an advertiser's website. Corresponds to the JSON property webpage

Returns:



2117
2118
2119
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2117

def webpage
  @webpage
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2124

def update!(**args)
  @ad_group = args[:ad_group] if args.key?(:ad_group)
  @age_range = args[:age_range] if args.key?(:age_range)
  @bid_modifier = args[:bid_modifier] if args.key?(:bid_modifier)
  @cpc_bid_micros = args[:cpc_bid_micros] if args.key?(:cpc_bid_micros)
  @criterion_id = args[:criterion_id] if args.key?(:criterion_id)
  @effective_cpc_bid_micros = args[:effective_cpc_bid_micros] if args.key?(:effective_cpc_bid_micros)
  @engine_status = args[:engine_status] if args.key?(:engine_status)
  @final_url_suffix = args[:final_url_suffix] if args.key?(:final_url_suffix)
  @final_urls = args[:final_urls] if args.key?(:final_urls)
  @gender = args[:gender] if args.key?(:gender)
  @keyword = args[:keyword] if args.key?(:keyword)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @listing_group = args[:listing_group] if args.key?(:listing_group)
  @quality_info = args[:quality_info] if args.key?(:quality_info)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @status = args[:status] if args.key?(:status)
  @tracking_url_template = args[:tracking_url_template] if args.key?(:tracking_url_template)
  @type = args[:type] if args.key?(:type)
  @webpage = args[:webpage] if args.key?(:webpage)
end