Class: Google::Apis::DfareportingV2_5::ListPopulationTerm

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

Overview

Remarketing List Population Rule Term.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ListPopulationTerm

Returns a new instance of ListPopulationTerm



6716
6717
6718
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6716

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

Instance Attribute Details

#contains ⇒ Boolean Also known as: contains?

Will be true if the term should check if the user is in the list and false if the term should check if the user is not in the list. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. False by default. Corresponds to the JSON property contains

Returns:

  • (Boolean) 


6665
6666
6667
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6665

def contains
  @contains
end

#negation ⇒ Boolean Also known as: negation?

Whether to negate the comparison result of this term during rule evaluation. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. Corresponds to the JSON property negation

Returns:

  • (Boolean) 


6673
6674
6675
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6673

def negation
  @negation
end

#operator ⇒ String

Comparison operator of this term. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. Corresponds to the JSON property operator

Returns:

  • (String) 


6680
6681
6682
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6680

def operator
  @operator
end

#remarketing_list_id ⇒ String

ID of the list in question. This field is only relevant when type is set to LIST_MEMBERSHIP_TERM. Corresponds to the JSON property remarketingListId

Returns:

  • (String) 


6686
6687
6688
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6686

def remarketing_list_id
  @remarketing_list_id
end

#type ⇒ String

List population term type determines the applicable fields in this object. If left unset or set to CUSTOM_VARIABLE_TERM, then variableName, variableFriendlyName, operator, value, and negation are applicable. If set to LIST_MEMBERSHIP_TERM then remarketingListId and contains are applicable. If set to REFERRER_TERM then operator, value, and negation are applicable. Corresponds to the JSON property type

Returns:

  • (String) 


6695
6696
6697
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6695

def type
  @type
end

#value ⇒ String

Literal to compare the variable to. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM or REFERRER_TERM. Corresponds to the JSON property value

Returns:

  • (String) 


6701
6702
6703
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6701

def value
  @value
end

#variable_friendly_name ⇒ String

Friendly name of this term's variable. This is a read-only, auto-generated field. This field is only relevant when type is left unset or set to CUSTOM_VARIABLE_TERM. Corresponds to the JSON property variableFriendlyName

Returns:

  • (String) 


6708
6709
6710
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6708

def variable_friendly_name
  @variable_friendly_name
end

#variable_name ⇒ String

Name of the variable (U1, U2, etc.) being compared in this term. This field is only relevant when type is set to null, CUSTOM_VARIABLE_TERM or REFERRER_TERM. Corresponds to the JSON property variableName

Returns:

  • (String) 


6714
6715
6716
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6714

def variable_name
  @variable_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 6721

def update!(**args)
  @contains = args[:contains] if args.key?(:contains)
  @negation = args[:negation] if args.key?(:negation)
  @operator = args[:operator] if args.key?(:operator)
  @remarketing_list_id = args[:remarketing_list_id] if args.key?(:remarketing_list_id)
  @type = args[:type] if args.key?(:type)
  @value = args[:value] if args.key?(:value)
  @variable_friendly_name = args[:variable_friendly_name] if args.key?(:variable_friendly_name)
  @variable_name = args[:variable_name] if args.key?(:variable_name)
end