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.



2521
2522
2523
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2521

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) 


2379
2380
2381
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2379

def ad_group
  @ad_group
end

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

An age range criterion. Corresponds to the JSON property ageRange

Returns:



2384
2385
2386
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2384

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) 


2390
2391
2392
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2390

def bid_modifier
  @bid_modifier
end

#cpc_bid_micros ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2395
2396
2397
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2395

def cpc_bid_micros
  @cpc_bid_micros
end

#creation_time ⇒ String

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


2401
2402
2403
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2401

def creation_time
  @creation_time
end

#criterion_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2406
2407
2408
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2406

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) 


2411
2412
2413
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2411

def effective_cpc_bid_micros
  @effective_cpc_bid_micros
end

#engine_id ⇒ String

Output only. ID of the ad group criterion 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_criterion.criterion_id" instead. Corresponds to the JSON property engineId

Returns:

  • (String) 


2419
2420
2421
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2419

def engine_id
  @engine_id
end

#engine_status ⇒ String

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

Returns:

  • (String) 


2424
2425
2426
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2424

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) 


2429
2430
2431
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2429

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


2434
2435
2436
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2434

def final_urls
  @final_urls
end

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

A gender criterion. Corresponds to the JSON property gender

Returns:



2439
2440
2441
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2439

def gender
  @gender
end

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

A keyword criterion. Corresponds to the JSON property keyword

Returns:



2444
2445
2446
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2444

def keyword
  @keyword
end

#labels ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2449
2450
2451
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2449

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


2456
2457
2458
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2456

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:



2461
2462
2463
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2461

def listing_group
  @listing_group
end

#location ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonLocationInfo

A location criterion. Corresponds to the JSON property location

Returns:



2466
2467
2468
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2466

def location
  @location
end

#negative ⇒ Boolean Also known as: negative?

Immutable. Whether to target (false) or exclude (true) the criterion. This field is immutable. To switch a criterion from positive to negative, remove then re-add it. Corresponds to the JSON property negative

Returns:

  • (Boolean) 


2473
2474
2475
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2473

def negative
  @negative
end

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

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

Returns:



2479
2480
2481
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2479

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) 


2486
2487
2488
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2486

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) 


2498
2499
2500
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2498

def status
  @status
end

#tracking_url_template ⇒ String

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

Returns:

  • (String) 


2503
2504
2505
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2503

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) 


2508
2509
2510
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2508

def type
  @type
end

#user_list ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0CommonUserListInfo

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

Returns:



2514
2515
2516
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2514

def user_list
  @user_list
end

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

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

Returns:



2519
2520
2521
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2519

def webpage
  @webpage
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2526

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)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @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_id = args[:engine_id] if args.key?(:engine_id)
  @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)
  @labels = args[:labels] if args.key?(:labels)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @listing_group = args[:listing_group] if args.key?(:listing_group)
  @location = args[:location] if args.key?(:location)
  @negative = args[:negative] if args.key?(:negative)
  @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)
  @user_list = args[:user_list] if args.key?(:user_list)
  @webpage = args[:webpage] if args.key?(:webpage)
end