blob: fd2a1a1fc51ebb23eb07292c2d74713556eb6f99 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="tagmanager_v1.html">Tag Manager API</a> . <a href="tagmanager_v1.accounts.html">accounts</a> . <a href="tagmanager_v1.accounts.containers.html">containers</a> . <a href="tagmanager_v1.accounts.containers.macros.html">macros</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(accountId, containerId, body)</a></code></p>
<p class="firstline">Creates a GTM Macro.</p>
<p class="toc_element">
<code><a href="#delete">delete(accountId, containerId, macroId)</a></code></p>
<p class="firstline">Deletes a GTM Macro.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, containerId, macroId)</a></code></p>
<p class="firstline">Gets a GTM Macro.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, containerId)</a></code></p>
<p class="firstline">Lists all GTM Macros of a Container.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, containerId, macroId, body, fingerprint=None)</a></code></p>
<p class="firstline">Updates a GTM Macro.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(accountId, containerId, body)</code>
<pre>Creates a GTM Macro.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a Google Tag Manager Macro.
"scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
"scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
"macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
"containerId": "A String", # GTM Container ID.
"type": "A String", # GTM Macro Type.
"notes": "A String", # User notes on how to apply this macro in the container.
"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.
"A String",
],
"name": "A String", # Macro display name.
"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.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
"parameter": [ # The macro's parameters.
{ # Represents a Google Tag Manager Parameter.
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"type": "A String", # The parameter type. Valid values are:
# - boolean: The value represents a boolean, represented as 'true' or 'false'
# - integer: The value represents a 64-bit signed integer value, in base 10
# - list: A list of parameters should be specified
# - map: A map of parameters should be specified
# - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
},
],
"parentFolderId": "A String", # Parent folder id.
"accountId": "A String", # GTM Account ID.
}
Returns:
An object of the form:
{ # Represents a Google Tag Manager Macro.
"scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
"scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
"macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
"containerId": "A String", # GTM Container ID.
"type": "A String", # GTM Macro Type.
"notes": "A String", # User notes on how to apply this macro in the container.
"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.
"A String",
],
"name": "A String", # Macro display name.
"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.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
"parameter": [ # The macro's parameters.
{ # Represents a Google Tag Manager Parameter.
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"type": "A String", # The parameter type. Valid values are:
# - boolean: The value represents a boolean, represented as 'true' or 'false'
# - integer: The value represents a 64-bit signed integer value, in base 10
# - list: A list of parameters should be specified
# - map: A map of parameters should be specified
# - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
},
],
"parentFolderId": "A String", # Parent folder id.
"accountId": "A String", # GTM Account ID.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(accountId, containerId, macroId)</code>
<pre>Deletes a GTM Macro.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
macroId: string, The GTM Macro ID. (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, containerId, macroId)</code>
<pre>Gets a GTM Macro.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
macroId: string, The GTM Macro ID. (required)
Returns:
An object of the form:
{ # Represents a Google Tag Manager Macro.
"scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
"scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
"macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
"containerId": "A String", # GTM Container ID.
"type": "A String", # GTM Macro Type.
"notes": "A String", # User notes on how to apply this macro in the container.
"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.
"A String",
],
"name": "A String", # Macro display name.
"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.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
"parameter": [ # The macro's parameters.
{ # Represents a Google Tag Manager Parameter.
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"type": "A String", # The parameter type. Valid values are:
# - boolean: The value represents a boolean, represented as 'true' or 'false'
# - integer: The value represents a 64-bit signed integer value, in base 10
# - list: A list of parameters should be specified
# - map: A map of parameters should be specified
# - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
},
],
"parentFolderId": "A String", # Parent folder id.
"accountId": "A String", # GTM Account ID.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, containerId)</code>
<pre>Lists all GTM Macros of a Container.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
Returns:
An object of the form:
{ # List Macros Response.
"macros": [ # All GTM Macros of a GTM Container.
{ # Represents a Google Tag Manager Macro.
"scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
"scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
"macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
"containerId": "A String", # GTM Container ID.
"type": "A String", # GTM Macro Type.
"notes": "A String", # User notes on how to apply this macro in the container.
"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.
"A String",
],
"name": "A String", # Macro display name.
"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.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
"parameter": [ # The macro's parameters.
{ # Represents a Google Tag Manager Parameter.
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"type": "A String", # The parameter type. Valid values are:
# - boolean: The value represents a boolean, represented as 'true' or 'false'
# - integer: The value represents a 64-bit signed integer value, in base 10
# - list: A list of parameters should be specified
# - map: A map of parameters should be specified
# - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
},
],
"parentFolderId": "A String", # Parent folder id.
"accountId": "A String", # GTM Account ID.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(accountId, containerId, macroId, body, fingerprint=None)</code>
<pre>Updates a GTM Macro.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
macroId: string, The GTM Macro ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a Google Tag Manager Macro.
"scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
"scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
"macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
"containerId": "A String", # GTM Container ID.
"type": "A String", # GTM Macro Type.
"notes": "A String", # User notes on how to apply this macro in the container.
"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.
"A String",
],
"name": "A String", # Macro display name.
"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.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
"parameter": [ # The macro's parameters.
{ # Represents a Google Tag Manager Parameter.
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"type": "A String", # The parameter type. Valid values are:
# - boolean: The value represents a boolean, represented as 'true' or 'false'
# - integer: The value represents a 64-bit signed integer value, in base 10
# - list: A list of parameters should be specified
# - map: A map of parameters should be specified
# - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
},
],
"parentFolderId": "A String", # Parent folder id.
"accountId": "A String", # GTM Account ID.
}
fingerprint: string, When provided, this fingerprint must match the fingerprint of the macro in storage.
Returns:
An object of the form:
{ # Represents a Google Tag Manager Macro.
"scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a macro.
"scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a macro.
"macroId": "A String", # The Macro ID uniquely identifies the GTM Macro.
"containerId": "A String", # GTM Container ID.
"type": "A String", # GTM Macro Type.
"notes": "A String", # User notes on how to apply this macro in the container.
"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.
"A String",
],
"name": "A String", # Macro display name.
"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.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Macro as computed at storage time. This value is recomputed whenever the macro is modified.
"parameter": [ # The macro's parameters.
{ # Represents a Google Tag Manager Parameter.
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"value": "A String", # A parameter's value (may contain macro references such as "{{myMacro}}") as appropriate to the specified type.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"type": "A String", # The parameter type. Valid values are:
# - boolean: The value represents a boolean, represented as 'true' or 'false'
# - integer: The value represents a 64-bit signed integer value, in base 10
# - list: A list of parameters should be specified
# - map: A map of parameters should be specified
# - template: The value represents any text; this can include macro references (even macro references that might return non-string types)
},
],
"parentFolderId": "A String", # Parent folder id.
"accountId": "A String", # GTM Account ID.
}</pre>
</div>
</body></html>