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

Constructor Details

#initialize(**args) ⇒ Macro

Returns a new instance of Macro.



914
915
916
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 914

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


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

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


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

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. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts. containers.macros.update Corresponds to the JSON property disablingRuleId

Returns:

  • (Array<String>) 


848
849
850
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 848

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. @mutable tagmanager. accounts.containers.macros.create @mutable tagmanager.accounts.containers. macros.update Corresponds to the JSON property enablingRuleId

Returns:

  • (Array<String>) 


857
858
859
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 857

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) 


863
864
865
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 863

def fingerprint
  @fingerprint
end

#macro_id ⇒ String

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

Returns:

  • (String) 


868
869
870
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 868

def macro_id
  @macro_id
end

#name ⇒ String

Macro display name. @mutable tagmanager.accounts.containers.macros.create @ mutable tagmanager.accounts.containers.macros.update Corresponds to the JSON property name

Returns:

  • (String) 


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

def name
  @name
end

#notes ⇒ String

User notes on how to apply this macro in the container. @mutable tagmanager. accounts.containers.macros.create @mutable tagmanager.accounts.containers. macros.update Corresponds to the JSON property notes

Returns:

  • (String) 


881
882
883
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 881

def notes
  @notes
end

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

The macro's parameters. @mutable tagmanager.accounts.containers.macros.create @ mutable tagmanager.accounts.containers.macros.update Corresponds to the JSON property parameter

Returns:



887
888
889
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 887

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


892
893
894
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 892

def parent_folder_id
  @parent_folder_id
end

#schedule_end_ms ⇒ Fixnum

The end timestamp in milliseconds to schedule a macro. @mutable tagmanager. accounts.containers.macros.create @mutable tagmanager.accounts.containers. macros.update Corresponds to the JSON property scheduleEndMs

Returns:

  • (Fixnum) 


899
900
901
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 899

def schedule_end_ms
  @schedule_end_ms
end

#schedule_start_ms ⇒ Fixnum

The start timestamp in milliseconds to schedule a macro. @mutable tagmanager. accounts.containers.macros.create @mutable tagmanager.accounts.containers. macros.update Corresponds to the JSON property scheduleStartMs

Returns:

  • (Fixnum) 


906
907
908
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 906

def schedule_start_ms
  @schedule_start_ms
end

#type ⇒ String

GTM Macro Type. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update Corresponds to the JSON property type

Returns:

  • (String) 


912
913
914
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 912

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 919

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