com.google.api.services.tagmanager.model

Class Macro

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.tagmanager.model.Macro

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Macro
extends com.google.api.client.json.GenericJson

Represents a Google Tag Manager Macro.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Tag Manager API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Macro()

Method Summary

Modifier and Type	Method and Description
Macro	clone()
java.lang.String	getAccountId() GTM Account ID.
java.lang.String	getContainerId() GTM Container ID.
java.util.List<java.lang.String>	getDisablingRuleId() 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.
java.util.List<java.lang.String>	getEnablingRuleId() 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.
java.lang.String	getFingerprint() The fingerprint of the GTM Macro as computed at storage time.
java.lang.String	getMacroId() The Macro ID uniquely identifies the GTM Macro.
java.lang.String	getName() Macro display name.
java.lang.String	getNotes() User notes on how to apply this macro in the container.
java.util.List<Parameter>	getParameter() The macro's parameters.
java.lang.String	getParentFolderId() Parent folder id.
java.lang.Long	getScheduleEndMs() The end timestamp in milliseconds to schedule a macro.
java.lang.Long	getScheduleStartMs() The start timestamp in milliseconds to schedule a macro.
java.lang.String	getType() GTM Macro Type.
Macro	set(java.lang.String fieldName, java.lang.Object value)
Macro	setAccountId(java.lang.String accountId) GTM Account ID.
Macro	setContainerId(java.lang.String containerId) GTM Container ID.
Macro	setDisablingRuleId(java.util.List<java.lang.String> disablingRuleId) 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.
Macro	setEnablingRuleId(java.util.List<java.lang.String> enablingRuleId) 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.
Macro	setFingerprint(java.lang.String fingerprint) The fingerprint of the GTM Macro as computed at storage time.
Macro	setMacroId(java.lang.String macroId) The Macro ID uniquely identifies the GTM Macro.
Macro	setName(java.lang.String name) Macro display name.
Macro	setNotes(java.lang.String notes) User notes on how to apply this macro in the container.
Macro	setParameter(java.util.List<Parameter> parameter) The macro's parameters.
Macro	setParentFolderId(java.lang.String parentFolderId) Parent folder id.
Macro	setScheduleEndMs(java.lang.Long scheduleEndMs) The end timestamp in milliseconds to schedule a macro.
Macro	setScheduleStartMs(java.lang.Long scheduleStartMs) The start timestamp in milliseconds to schedule a macro.
Macro	setType(java.lang.String type) GTM Macro Type.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Macro

public Macro()

Method Detail

getAccountId

public java.lang.String getAccountId()

GTM Account ID.

Returns:

value or null for none

setAccountId

public Macro setAccountId(java.lang.String accountId)

GTM Account ID.

Parameters:

accountId - accountId or null for none

getContainerId

public java.lang.String getContainerId()

GTM Container ID.

Returns:

value or null for none

setContainerId

public Macro setContainerId(java.lang.String containerId)

GTM Container ID.

Parameters:

containerId - containerId or null for none

getDisablingRuleId

public java.util.List<java.lang.String> getDisablingRuleId()

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

Returns:

value or null for none

setDisablingRuleId

public Macro setDisablingRuleId(java.util.List<java.lang.String> disablingRuleId)

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

Parameters:

disablingRuleId - disablingRuleId or null for none

getEnablingRuleId

public java.util.List<java.lang.String> getEnablingRuleId()

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

Returns:

value or null for none

setEnablingRuleId

public Macro setEnablingRuleId(java.util.List<java.lang.String> enablingRuleId)

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

Parameters:

enablingRuleId - enablingRuleId or null for none

getFingerprint

public java.lang.String getFingerprint()

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

Returns:

value or null for none

setFingerprint

public Macro setFingerprint(java.lang.String fingerprint)

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

Parameters:

fingerprint - fingerprint or null for none

getMacroId

public java.lang.String getMacroId()

The Macro ID uniquely identifies the GTM Macro.

Returns:

value or null for none

setMacroId

public Macro setMacroId(java.lang.String macroId)

The Macro ID uniquely identifies the GTM Macro.

Parameters:

macroId - macroId or null for none

getName

public java.lang.String getName()

Macro display name. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Returns:

value or null for none

setName

public Macro setName(java.lang.String name)

Macro display name. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Parameters:

name - name or null for none

getNotes

public java.lang.String getNotes()

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

Returns:

value or null for none

setNotes

public Macro setNotes(java.lang.String notes)

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

Parameters:

notes - notes or null for none

getParameter

public java.util.List<Parameter> getParameter()

The macro's parameters. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Returns:

value or null for none

setParameter

public Macro setParameter(java.util.List<Parameter> parameter)

The macro's parameters. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Parameters:

parameter - parameter or null for none

getParentFolderId

public java.lang.String getParentFolderId()

Parent folder id.

Returns:

value or null for none

setParentFolderId

public Macro setParentFolderId(java.lang.String parentFolderId)

Parent folder id.

Parameters:

parentFolderId - parentFolderId or null for none

getScheduleEndMs

public java.lang.Long getScheduleEndMs()

The end timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Returns:

value or null for none

setScheduleEndMs

public Macro setScheduleEndMs(java.lang.Long scheduleEndMs)

The end timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Parameters:

scheduleEndMs - scheduleEndMs or null for none

getScheduleStartMs

public java.lang.Long getScheduleStartMs()

The start timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Returns:

value or null for none

setScheduleStartMs

public Macro setScheduleStartMs(java.lang.Long scheduleStartMs)

The start timestamp in milliseconds to schedule a macro. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Parameters:

scheduleStartMs - scheduleStartMs or null for none

getType

public java.lang.String getType()

GTM Macro Type. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Returns:

value or null for none

setType

public Macro setType(java.lang.String type)

GTM Macro Type. @mutable tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts.containers.macros.update

Parameters:

type - type or null for none

set

public Macro set(java.lang.String fieldName,
                 java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Macro clone()

Overrides:

clone in class com.google.api.client.json.GenericJson