Class: Google::Apis::DfareportingV2_7::ListPopulationTerm

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_7/classes.rb,
generated/google/apis/dfareporting_v2_7/representations.rb,
generated/google/apis/dfareporting_v2_7/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



6967
6968
6969
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6967

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

Instance Attribute Details

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


6916
6917
6918
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6916

def contains
  @contains
end

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


6924
6925
6926
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6924

def negation
  @negation
end

#operatorString

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)


6931
6932
6933
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6931

def operator
  @operator
end

#remarketing_list_idFixnum

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:

  • (Fixnum)


6937
6938
6939
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6937

def remarketing_list_id
  @remarketing_list_id
end

#typeString

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)


6946
6947
6948
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6946

def type
  @type
end

#valueString

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)


6952
6953
6954
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6952

def value
  @value
end

#variable_friendly_nameString

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)


6959
6960
6961
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6959

def variable_friendly_name
  @variable_friendly_name
end

#variable_nameString

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)


6965
6966
6967
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6965

def variable_name
  @variable_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 6972

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