Class: Google::Apis::DfareportingV2_1::ListPopulationTerm

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

Overview

Remarketing List Population Rule Term.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ListPopulationTerm

Returns a new instance of ListPopulationTerm.


6256
6257
6258
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6256

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)

6205
6206
6207
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6205

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)

6213
6214
6215
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6213

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)

6220
6221
6222
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6220

def operator
  @operator
end

#remarketing_list_idString

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)

6226
6227
6228
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6226

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)

6235
6236
6237
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6235

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)

6241
6242
6243
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6241

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)

6248
6249
6250
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6248

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)

6254
6255
6256
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6254

def variable_name
  @variable_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 6261

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