Class: Google::Apis::TagmanagerV1::Parameter

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

Overview

Represents a Google Tag Manager Parameter.

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

Returns a new instance of Parameter.



1041
1042
1043
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1041

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

Instance Attribute Details

#key ⇒ String

The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values. Corresponds to the JSON property key

Returns:

  • (String) 


979
980
981
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 979

def key
  @key
end

#list ⇒ Array<Google::Apis::TagmanagerV1::Parameter>

This list parameter's parameters (keys will be ignored). Corresponds to the JSON property list

Returns:



990
991
992
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 990

def list
  @list
end

#map ⇒ Array<Google::Apis::TagmanagerV1::Parameter>

This map parameter's parameters (must have keys; keys must be unique). Corresponds to the JSON property map

Returns:



1001
1002
1003
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1001

def map
  @map
end

#type ⇒ String

The parameter type. Valid values are:

  • boolean: The value represents a boolean, represented as 'true' or 'false'
  • integer: The value represents a 64-bit signed integer value, in base 10
  • list: A list of parameters should be specified
  • map: A map of parameters should be specified
  • template: The value represents any text; this can include variable references (even variable references that might return non-string types)
  • trigger_reference: The value represents a trigger, represented as the trigger id
  • tag_reference: The value represents a tag, represented as the tag name
Corresponds to the JSON property type

Returns:

  • (String) 


1026
1027
1028
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1026

def type
  @type
end

#value ⇒ String

A parameter's value (may contain variable references such as "myVariable") as appropriate to the specified type. Corresponds to the JSON property value

Returns:

  • (String) 


1039
1040
1041
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1039

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1046
1047
1048
1049
1050
1051
1052
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1046

def update!(**args)
  @key = args[:key] if args.key?(:key)
  @list = args[:list] if args.key?(:list)
  @map = args[:map] if args.key?(:map)
  @type = args[:type] if args.key?(:type)
  @value = args[:value] if args.key?(:value)
end