Class: Google::Apis::TagmanagerV1::Tag

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 Tag.

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

Returns a new instance of Tag



1170
1171
1172
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1170

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1066
1067
1068
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1066

def 
  @account_id
end

#blocking_rule_id ⇒ Array<String>

Blocking rule IDs. If any of the listed rules evaluate to true, the tag will not fire. Corresponds to the JSON property blockingRuleId

Returns:

  • (Array<String>) 


1072
1073
1074
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1072

def blocking_rule_id
  @blocking_rule_id
end

#blocking_trigger_id ⇒ Array<String>

Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire. Corresponds to the JSON property blockingTriggerId

Returns:

  • (Array<String>) 


1078
1079
1080
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1078

def blocking_trigger_id
  @blocking_trigger_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


1083
1084
1085
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1083

def container_id
  @container_id
end

#fingerprint ⇒ String

The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified. Corresponds to the JSON property fingerprint

Returns:

  • (String) 


1089
1090
1091
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1089

def fingerprint
  @fingerprint
end

#firing_rule_id ⇒ Array<String>

Firing rule IDs. A tag will fire when any of the listed rules are true and all of its blockingRuleIds (if any specified) are false. Corresponds to the JSON property firingRuleId

Returns:

  • (Array<String>) 


1095
1096
1097
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1095

def firing_rule_id
  @firing_rule_id
end

#firing_trigger_id ⇒ Array<String>

Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false. Corresponds to the JSON property firingTriggerId

Returns:

  • (Array<String>) 


1101
1102
1103
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1101

def firing_trigger_id
  @firing_trigger_id
end

#live_only ⇒ Boolean Also known as: live_only?

If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode). Corresponds to the JSON property liveOnly

Returns:

  • (Boolean) 


1107
1108
1109
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1107

def live_only
  @live_only
end

#name ⇒ String

Tag display name. Corresponds to the JSON property name

Returns:

  • (String) 


1113
1114
1115
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1113

def name
  @name
end

#notes ⇒ String

User notes on how to apply this tag in the container. Corresponds to the JSON property notes

Returns:

  • (String) 


1118
1119
1120
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1118

def notes
  @notes
end

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

The tag's parameters. Corresponds to the JSON property parameter

Returns:



1123
1124
1125
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1123

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


1128
1129
1130
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1128

def parent_folder_id
  @parent_folder_id
end

#priority ⇒ Google::Apis::TagmanagerV1::Parameter

Represents a Google Tag Manager Parameter. Corresponds to the JSON property priority

Returns:



1133
1134
1135
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1133

def priority
  @priority
end

#schedule_end_ms ⇒ Fixnum

The end timestamp in milliseconds to schedule a tag. Corresponds to the JSON property scheduleEndMs

Returns:

  • (Fixnum) 


1138
1139
1140
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1138

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

The start timestamp in milliseconds to schedule a tag. Corresponds to the JSON property scheduleStartMs

Returns:

  • (Fixnum) 


1143
1144
1145
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1143

def schedule_start_ms
  @schedule_start_ms
end

#setup_tag ⇒ Array<Google::Apis::TagmanagerV1::SetupTag>

The list of setup tags. Currently we only allow one. Corresponds to the JSON property setupTag

Returns:



1148
1149
1150
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1148

def setup_tag
  @setup_tag
end

#tag_firing_option ⇒ String

Option to fire this tag. Corresponds to the JSON property tagFiringOption

Returns:

  • (String) 


1153
1154
1155
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1153

def tag_firing_option
  @tag_firing_option
end

#tag_id ⇒ String

The Tag ID uniquely identifies the GTM Tag. Corresponds to the JSON property tagId

Returns:

  • (String) 


1158
1159
1160
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1158

def tag_id
  @tag_id
end

#teardown_tag ⇒ Array<Google::Apis::TagmanagerV1::TeardownTag>

The list of teardown tags. Currently we only allow one. Corresponds to the JSON property teardownTag

Returns:



1163
1164
1165
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1163

def teardown_tag
  @teardown_tag
end

#type ⇒ String

GTM Tag Type. Corresponds to the JSON property type

Returns:

  • (String) 


1168
1169
1170
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1168

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 1175

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @blocking_rule_id = args[:blocking_rule_id] if args.key?(:blocking_rule_id)
  @blocking_trigger_id = args[:blocking_trigger_id] if args.key?(:blocking_trigger_id)
  @container_id = args[:container_id] if args.key?(:container_id)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @firing_rule_id = args[:firing_rule_id] if args.key?(:firing_rule_id)
  @firing_trigger_id = args[:firing_trigger_id] if args.key?(:firing_trigger_id)
  @live_only = args[:live_only] if args.key?(:live_only)
  @name = args[:name] if args.key?(:name)
  @notes = args[:notes] if args.key?(:notes)
  @parameter = args[:parameter] if args.key?(:parameter)
  @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id)
  @priority = args[:priority] if args.key?(:priority)
  @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms)
  @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms)
  @setup_tag = args[:setup_tag] if args.key?(:setup_tag)
  @tag_firing_option = args[:tag_firing_option] if args.key?(:tag_firing_option)
  @tag_id = args[:tag_id] if args.key?(:tag_id)
  @teardown_tag = args[:teardown_tag] if args.key?(:teardown_tag)
  @type = args[:type] if args.key?(:type)
end