Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesCampaignCriterion

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

Overview

A campaign criterion.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ResourcesCampaignCriterion

Returns a new instance of GoogleAdsSearchads360V23ResourcesCampaignCriterion.



25283
25284
25285
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25283

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

Instance Attribute Details

#ad_schedule ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonAdScheduleInfo

Represents an AdSchedule criterion. AdSchedule is specified as the day of the week and a time interval within which ads will be shown. No more than six AdSchedules can be added for the same day. Corresponds to the JSON property adSchedule

Returns:



25043
25044
25045
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25043

def ad_schedule
  @ad_schedule
end

#age_range ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonAgeRangeInfo

An age range criterion. Corresponds to the JSON property ageRange

Returns:



25048
25049
25050
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25048

def age_range
  @age_range
end

#bid_modifier ⇒ Float

The modifier for the bids when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Most targetable criteria types support modifiers. Use 0 to opt out of a Device type. Corresponds to the JSON property bidModifier

Returns:

  • (Float) 


25055
25056
25057
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25055

def bid_modifier
  @bid_modifier
end

#brand_list ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonBrandListInfo

A Brand List Criterion is used to specify a list of brands. The list is represented as a SharedSet id type BRAND_HINT. A criterion of this type can be either targeted or excluded. Corresponds to the JSON property brandList

Returns:



25062
25063
25064
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25062

def brand_list
  @brand_list
end

#campaign ⇒ String

Immutable. The campaign to which the criterion belongs. Corresponds to the JSON property campaign

Returns:

  • (String) 


25067
25068
25069
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25067

def campaign
  @campaign
end

#carrier ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonCarrierInfo

Represents a Carrier Criterion. Corresponds to the JSON property carrier

Returns:



25072
25073
25074
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25072

def carrier
  @carrier
end

#combined_audience ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonCombinedAudienceInfo

A combined audience criterion. Corresponds to the JSON property combinedAudience

Returns:



25077
25078
25079
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25077

def combined_audience
  @combined_audience
end

#content_label ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonContentLabelInfo

Content Label for category exclusion. Corresponds to the JSON property contentLabel

Returns:



25082
25083
25084
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25082

def content_label
  @content_label
end

#criterion_id ⇒ Fixnum

Output only. The ID of the criterion. This field is ignored during mutate. Corresponds to the JSON property criterionId

Returns:

  • (Fixnum) 


25087
25088
25089
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25087

def criterion_id
  @criterion_id
end

#device ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonDeviceInfo

A device criterion. Corresponds to the JSON property device

Returns:



25092
25093
25094
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25092

def device
  @device
end

#display_name ⇒ String

Output only. The display name of the criterion. This field is ignored for mutates. Corresponds to the JSON property displayName

Returns:

  • (String) 


25098
25099
25100
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25098

def display_name
  @display_name
end

#extended_demographic ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonExtendedDemographicInfo

Represents an extended demographic criterion. Corresponds to the JSON property extendedDemographic

Returns:



25103
25104
25105
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25103

def extended_demographic
  @extended_demographic
end

#gender ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonGenderInfo

A gender criterion. Corresponds to the JSON property gender

Returns:



25108
25109
25110
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25108

def gender
  @gender
end

#income_range ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonIncomeRangeInfo

An income range criterion. Corresponds to the JSON property incomeRange

Returns:



25113
25114
25115
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25113

def income_range
  @income_range
end

#ip_block ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonIpBlockInfo

An IpBlock criterion used for excluding IP addresses. We support excluding individual IP addresses or CIDR blocks. Create one IpBlockInfo criterion for each individual IP address or CIDR block you want to exclude. You can exclude up to 500 IP addresses per campaign. For more details, see Exclude IP addresses. IPv4 examples: * Individual address: 192.168.0.1 * Individual address as CIDR block: 192.168.0. 1/32 * CIDR block: 192.168.0.0/24 IPv6 examples: * Individual address: 2001: db8:a0b:12f0::1 * Individual address as CIDR block: 2001:db8:a0b:12f0::1/128 * CIDR block: 2001:db8::/48 Corresponds to the JSON property ipBlock

Returns:



25126
25127
25128
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25126

def ip_block
  @ip_block
end

#keyword ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonKeywordInfo

A keyword criterion. Corresponds to the JSON property keyword

Returns:



25131
25132
25133
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25131

def keyword
  @keyword
end

#keyword_theme ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonKeywordThemeInfo

A Smart Campaign keyword theme. Corresponds to the JSON property keywordTheme

Returns:



25136
25137
25138
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25136

def keyword_theme
  @keyword_theme
end

#language ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLanguageInfo

A language criterion. Corresponds to the JSON property language

Returns:



25141
25142
25143
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25141

def language
  @language
end

#last_modified_time ⇒ String

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


25148
25149
25150
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25148

def last_modified_time
  @last_modified_time
end

#life_event ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLifeEventInfo

Represents a life event criterion. Corresponds to the JSON property lifeEvent

Returns:



25153
25154
25155
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25153

def life_event
  @life_event
end

#listing_scope ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonListingScopeInfo

A listing scope criterion. Corresponds to the JSON property listingScope

Returns:



25158
25159
25160
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25158

def listing_scope
  @listing_scope
end

#local_service_id ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLocalServiceIdInfo

A Local Services Ads service ID. Represents a service type (such as install_faucet) that a Local Services Campaign can target. Corresponds to the JSON property localServiceId

Returns:



25164
25165
25166
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25164

def local_service_id
  @local_service_id
end

#location ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLocationInfo

A location criterion. Corresponds to the JSON property location

Returns:



25169
25170
25171
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25169

def location
  @location
end

#location_group ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonLocationGroupInfo

A radius around a list of locations specified through a feed. Corresponds to the JSON property locationGroup

Returns:



25174
25175
25176
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25174

def location_group
  @location_group
end

#mobile_app_category ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonMobileAppCategoryInfo

A mobile app category criterion. Corresponds to the JSON property mobileAppCategory

Returns:



25179
25180
25181
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25179

def mobile_app_category
  @mobile_app_category
end

#mobile_application ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonMobileApplicationInfo

A mobile application criterion. Corresponds to the JSON property mobileApplication

Returns:



25184
25185
25186
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25184

def mobile_application
  @mobile_application
end

#mobile_device ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonMobileDeviceInfo

A mobile device criterion. Corresponds to the JSON property mobileDevice

Returns:



25189
25190
25191
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25189

def mobile_device
  @mobile_device
end

#negative ⇒ Boolean Also known as: negative?

Immutable. Whether to target (false) or exclude (true) the criterion. Corresponds to the JSON property negative

Returns:

  • (Boolean) 


25194
25195
25196
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25194

def negative
  @negative
end

#operating_system_version ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonOperatingSystemVersionInfo

Represents an operating system version to be targeted. Corresponds to the JSON property operatingSystemVersion

Returns:



25200
25201
25202
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25200

def operating_system_version
  @operating_system_version
end

#parental_status ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonParentalStatusInfo

A parental status criterion. Corresponds to the JSON property parentalStatus

Returns:



25205
25206
25207
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25205

def parental_status
  @parental_status
end

#placement ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonPlacementInfo

A placement criterion. This can be used to modify bids for sites when targeting the content network. Corresponds to the JSON property placement

Returns:



25211
25212
25213
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25211

def placement
  @placement
end

#proximity ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonProximityInfo

A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving. There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated. Corresponds to the JSON property proximity

Returns:



25221
25222
25223
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25221

def proximity
  @proximity
end

#resource_name ⇒ String

Immutable. The resource name of the campaign criterion. Campaign criterion resource names have the form: customers/customer_id/campaignCriteria/ campaign_id~criterion_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


25228
25229
25230
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25228

def resource_name
  @resource_name
end

#status ⇒ String

The status of the criterion. Corresponds to the JSON property status

Returns:

  • (String) 


25233
25234
25235
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25233

def status
  @status
end

#topic ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonTopicInfo

A topic criterion. Use topics to target or exclude placements in the Google Display Network based on the category into which the placement falls (for example, "Pets & Animals/Pets/Dogs"). Corresponds to the JSON property topic

Returns:



25240
25241
25242
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25240

def topic
  @topic
end

#type ⇒ String

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

Returns:

  • (String) 


25245
25246
25247
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25245

def type
  @type
end

#user_interest ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonUserInterestInfo

Represents a particular interest-based topic to be targeted. Corresponds to the JSON property userInterest

Returns:



25250
25251
25252
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25250

def user_interest
  @user_interest
end

#user_list ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonUserListInfo

A User List criterion. Represents a user list that is defined by the advertiser to be targeted. Corresponds to the JSON property userList

Returns:



25256
25257
25258
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25256

def user_list
  @user_list
end

#video_lineup ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonVideoLineupInfo

A Video lineup criterion. Corresponds to the JSON property videoLineup

Returns:



25261
25262
25263
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25261

def video_lineup
  @video_lineup
end

#webpage ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonWebpageInfo

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

Returns:



25266
25267
25268
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25266

def webpage
  @webpage
end

#webpage_list ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonWebpageListInfo

Represents a list of webpage criteria. Corresponds to the JSON property webpageList

Returns:



25271
25272
25273
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25271

def webpage_list
  @webpage_list
end

#youtube_channel ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonYouTubeChannelInfo

A YouTube Channel criterion. Corresponds to the JSON property youtubeChannel

Returns:



25276
25277
25278
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25276

def youtube_channel
  @youtube_channel
end

#youtube_video ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23CommonYouTubeVideoInfo

A YouTube Video criterion. Corresponds to the JSON property youtubeVideo

Returns:



25281
25282
25283
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25281

def youtube_video
  @youtube_video
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



25288
25289
25290
25291
25292
25293
25294
25295
25296
25297
25298
25299
25300
25301
25302
25303
25304
25305
25306
25307
25308
25309
25310
25311
25312
25313
25314
25315
25316
25317
25318
25319
25320
25321
25322
25323
25324
25325
25326
25327
25328
25329
25330
25331
25332
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 25288

def update!(**args)
  @ad_schedule = args[:ad_schedule] if args.key?(:ad_schedule)
  @age_range = args[:age_range] if args.key?(:age_range)
  @bid_modifier = args[:bid_modifier] if args.key?(:bid_modifier)
  @brand_list = args[:brand_list] if args.key?(:brand_list)
  @campaign = args[:campaign] if args.key?(:campaign)
  @carrier = args[:carrier] if args.key?(:carrier)
  @combined_audience = args[:combined_audience] if args.key?(:combined_audience)
  @content_label = args[:content_label] if args.key?(:content_label)
  @criterion_id = args[:criterion_id] if args.key?(:criterion_id)
  @device = args[:device] if args.key?(:device)
  @display_name = args[:display_name] if args.key?(:display_name)
  @extended_demographic = args[:extended_demographic] if args.key?(:extended_demographic)
  @gender = args[:gender] if args.key?(:gender)
  @income_range = args[:income_range] if args.key?(:income_range)
  @ip_block = args[:ip_block] if args.key?(:ip_block)
  @keyword = args[:keyword] if args.key?(:keyword)
  @keyword_theme = args[:keyword_theme] if args.key?(:keyword_theme)
  @language = args[:language] if args.key?(:language)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @life_event = args[:life_event] if args.key?(:life_event)
  @listing_scope = args[:listing_scope] if args.key?(:listing_scope)
  @local_service_id = args[:local_service_id] if args.key?(:local_service_id)
  @location = args[:location] if args.key?(:location)
  @location_group = args[:location_group] if args.key?(:location_group)
  @mobile_app_category = args[:mobile_app_category] if args.key?(:mobile_app_category)
  @mobile_application = args[:mobile_application] if args.key?(:mobile_application)
  @mobile_device = args[:mobile_device] if args.key?(:mobile_device)
  @negative = args[:negative] if args.key?(:negative)
  @operating_system_version = args[:operating_system_version] if args.key?(:operating_system_version)
  @parental_status = args[:parental_status] if args.key?(:parental_status)
  @placement = args[:placement] if args.key?(:placement)
  @proximity = args[:proximity] if args.key?(:proximity)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @status = args[:status] if args.key?(:status)
  @topic = args[:topic] if args.key?(:topic)
  @type = args[:type] if args.key?(:type)
  @user_interest = args[:user_interest] if args.key?(:user_interest)
  @user_list = args[:user_list] if args.key?(:user_list)
  @video_lineup = args[:video_lineup] if args.key?(:video_lineup)
  @webpage = args[:webpage] if args.key?(:webpage)
  @webpage_list = args[:webpage_list] if args.key?(:webpage_list)
  @youtube_channel = args[:youtube_channel] if args.key?(:youtube_channel)
  @youtube_video = args[:youtube_video] if args.key?(:youtube_video)
end