Class: Google::Apis::TagmanagerV1::Macro

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

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

Returns a new instance of Macro



877
878
879
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 877

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


810
811
812
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 810

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


815
816
817
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 815

def container_id
  @container_id
end

#disabling_rule_id ⇒ Array<String>

For mobile containers only: A list of rule IDs for disabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. Corresponds to the JSON property disablingRuleId

Returns:

  • (Array<String>) 


822
823
824
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 822

def disabling_rule_id
  @disabling_rule_id
end

#enabling_rule_id ⇒ Array<String>

For mobile containers only: A list of rule IDs for enabling conditional macros; the macro is enabled if one of the enabling rules is true while all the disabling rules are false. Treated as an unordered set. Corresponds to the JSON property enablingRuleId

Returns:

  • (Array<String>) 


829
830
831
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 829

def enabling_rule_id
  @enabling_rule_id
end

#fingerprint ⇒ String

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

Returns:

  • (String) 


835
836
837
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 835

def fingerprint
  @fingerprint
end

#macro_id ⇒ String

The Macro ID uniquely identifies the GTM Macro. Corresponds to the JSON property macroId

Returns:

  • (String) 


840
841
842
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 840

def macro_id
  @macro_id
end

#name ⇒ String

Macro display name. Corresponds to the JSON property name

Returns:

  • (String) 


845
846
847
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 845

def name
  @name
end

#notes ⇒ String

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

Returns:

  • (String) 


850
851
852
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 850

def notes
  @notes
end

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

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

Returns:



855
856
857
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 855

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


860
861
862
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 860

def parent_folder_id
  @parent_folder_id
end

#schedule_end_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


865
866
867
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 865

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

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

Returns:

  • (Fixnum) 


870
871
872
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 870

def schedule_start_ms
  @schedule_start_ms
end

#type ⇒ String

GTM Macro Type. Corresponds to the JSON property type

Returns:

  • (String) 


875
876
877
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 875

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 882

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @container_id = args[:container_id] if args.key?(:container_id)
  @disabling_rule_id = args[:disabling_rule_id] if args.key?(:disabling_rule_id)
  @enabling_rule_id = args[:enabling_rule_id] if args.key?(:enabling_rule_id)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @macro_id = args[:macro_id] if args.key?(:macro_id)
  @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)
  @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)
  @type = args[:type] if args.key?(:type)
end