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. The ad_group_criterion report only returns criteria that were explicitly added to the ad group.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ResourcesAdGroupCriterion

Returns a new instance of GoogleAdsSearchads360V0ResourcesAdGroupCriterion.



4642
4643
4644
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4642

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) 


4495
4496
4497
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4495

def ad_group
  @ad_group
end

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

An age range criterion. Corresponds to the JSON property ageRange

Returns:



4500
4501
4502
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4500

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) 


4506
4507
4508
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4506

def bid_modifier
  @bid_modifier
end

#cpc_bid_micros ⇒ Fixnum

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

Returns:

  • (Fixnum) 


4511
4512
4513
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4511

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) 


4517
4518
4519
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4517

def creation_time
  @creation_time
end

#criterion_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


4522
4523
4524
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4522

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) 


4527
4528
4529
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4527

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) 


4535
4536
4537
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4535

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) 


4540
4541
4542
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4540

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) 


4545
4546
4547
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4545

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


4550
4551
4552
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4550

def final_urls
  @final_urls
end

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

A gender criterion. Corresponds to the JSON property gender

Returns:



4555
4556
4557
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4555

def gender
  @gender
end

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

A keyword criterion. Corresponds to the JSON property keyword

Returns:



4560
4561
4562
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4560

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


4565
4566
4567
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4565

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) 


4572
4573
4574
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4572

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:



4577
4578
4579
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4577

def listing_group
  @listing_group
end

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

A location criterion. Corresponds to the JSON property location

Returns:



4582
4583
4584
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4582

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) 


4589
4590
4591
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4589

def negative
  @negative
end

#position_estimates ⇒ Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesAdGroupCriterionPositionEstimates

Estimates for criterion bids at various positions. Corresponds to the JSON property positionEstimates

Returns:



4595
4596
4597
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4595

def position_estimates
  @position_estimates
end

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

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

Returns:



4600
4601
4602
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4600

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) 


4607
4608
4609
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4607

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) 


4619
4620
4621
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4619

def status
  @status
end

#tracking_url_template ⇒ String

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

Returns:

  • (String) 


4624
4625
4626
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4624

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) 


4629
4630
4631
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4629

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:



4635
4636
4637
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4635

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:



4640
4641
4642
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4640

def webpage
  @webpage
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4647

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)
  @position_estimates = args[:position_estimates] if args.key?(:position_estimates)
  @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