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.



943
944
945
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 943

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

Instance Attribute Details

#account_id ⇒ String

GTM Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


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

def 
  @account_id
end

#container_id ⇒ String

GTM Container ID. Corresponds to the JSON property containerId

Returns:

  • (String) 


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

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


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

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


883
884
885
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 883

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) 


889
890
891
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 889

def fingerprint
  @fingerprint
end

#macro_id ⇒ String

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

Returns:

  • (String) 


894
895
896
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 894

def macro_id
  @macro_id
end

#name ⇒ String

Macro display name. Corresponds to the JSON property name

Returns:

  • (String) 


901
902
903
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 901

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) 


908
909
910
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 908

def notes
  @notes
end

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

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

Returns:



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

def parameter
  @parameter
end

#parent_folder_id ⇒ String

Parent folder id. Corresponds to the JSON property parentFolderId

Returns:

  • (String) 


920
921
922
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 920

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) 


927
928
929
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 927

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) 


934
935
936
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 934

def schedule_start_ms
  @schedule_start_ms
end

#type ⇒ String

GTM Macro Type. Corresponds to the JSON property type

Returns:

  • (String) 


941
942
943
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 941

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'generated/google/apis/tagmanager_v1/classes.rb', line 948

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