blob: a10b8f4d3641374ff2994e6ae129936c369e58e3 [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.folders.html">folders</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="tagmanager_v1.accounts.containers.folders.entities.html">entities()</a></code>
</p>
<p class="firstline">Returns the entities Resource.</p>
<p class="toc_element">
<code><a href="#create">create(accountId, containerId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a GTM Folder.</p>
<p class="toc_element">
<code><a href="#delete">delete(accountId, containerId, folderId, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a GTM Folder.</p>
<p class="toc_element">
<code><a href="#get">get(accountId, containerId, folderId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a GTM Folder.</p>
<p class="toc_element">
<code><a href="#list">list(accountId, containerId, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all GTM Folders of a Container.</p>
<p class="toc_element">
<code><a href="#update">update(accountId, containerId, folderId, body=None, fingerprint=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a GTM Folder.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(accountId, containerId, body=None, x__xgafv=None)</code>
<pre>Creates a GTM Folder.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Google Tag Manager Folder.
&quot;accountId&quot;: &quot;A String&quot;, # GTM Account ID.
&quot;name&quot;: &quot;A String&quot;, # Folder display name.
# @mutable tagmanager.accounts.containers.folders.create
# @mutable tagmanager.accounts.containers.folders.update
&quot;containerId&quot;: &quot;A String&quot;, # GTM Container ID.
&quot;folderId&quot;: &quot;A String&quot;, # The Folder ID uniquely identifies the GTM Folder.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Folder as computed at storage time.
# This value is recomputed whenever the folder is modified.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a Google Tag Manager Folder.
&quot;accountId&quot;: &quot;A String&quot;, # GTM Account ID.
&quot;name&quot;: &quot;A String&quot;, # Folder display name.
# @mutable tagmanager.accounts.containers.folders.create
# @mutable tagmanager.accounts.containers.folders.update
&quot;containerId&quot;: &quot;A String&quot;, # GTM Container ID.
&quot;folderId&quot;: &quot;A String&quot;, # The Folder ID uniquely identifies the GTM Folder.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Folder as computed at storage time.
# This value is recomputed whenever the folder is modified.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(accountId, containerId, folderId, x__xgafv=None)</code>
<pre>Deletes a GTM Folder.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
folderId: string, The GTM Folder ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
</pre>
</div>
<div class="method">
<code class="details" id="get">get(accountId, containerId, folderId, x__xgafv=None)</code>
<pre>Gets a GTM Folder.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
folderId: string, The GTM Folder ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a Google Tag Manager Folder.
&quot;accountId&quot;: &quot;A String&quot;, # GTM Account ID.
&quot;name&quot;: &quot;A String&quot;, # Folder display name.
# @mutable tagmanager.accounts.containers.folders.create
# @mutable tagmanager.accounts.containers.folders.update
&quot;containerId&quot;: &quot;A String&quot;, # GTM Container ID.
&quot;folderId&quot;: &quot;A String&quot;, # The Folder ID uniquely identifies the GTM Folder.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Folder as computed at storage time.
# This value is recomputed whenever the folder is modified.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId, containerId, x__xgafv=None)</code>
<pre>Lists all GTM Folders of a Container.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # List Folders Response.
&quot;folders&quot;: [ # All GTM Folders of a GTM Container.
{ # Represents a Google Tag Manager Folder.
&quot;accountId&quot;: &quot;A String&quot;, # GTM Account ID.
&quot;name&quot;: &quot;A String&quot;, # Folder display name.
# @mutable tagmanager.accounts.containers.folders.create
# @mutable tagmanager.accounts.containers.folders.update
&quot;containerId&quot;: &quot;A String&quot;, # GTM Container ID.
&quot;folderId&quot;: &quot;A String&quot;, # The Folder ID uniquely identifies the GTM Folder.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Folder as computed at storage time.
# This value is recomputed whenever the folder is modified.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(accountId, containerId, folderId, body=None, fingerprint=None, x__xgafv=None)</code>
<pre>Updates a GTM Folder.
Args:
accountId: string, The GTM Account ID. (required)
containerId: string, The GTM Container ID. (required)
folderId: string, The GTM Folder ID. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Google Tag Manager Folder.
&quot;accountId&quot;: &quot;A String&quot;, # GTM Account ID.
&quot;name&quot;: &quot;A String&quot;, # Folder display name.
# @mutable tagmanager.accounts.containers.folders.create
# @mutable tagmanager.accounts.containers.folders.update
&quot;containerId&quot;: &quot;A String&quot;, # GTM Container ID.
&quot;folderId&quot;: &quot;A String&quot;, # The Folder ID uniquely identifies the GTM Folder.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Folder as computed at storage time.
# This value is recomputed whenever the folder is modified.
}
fingerprint: string, When provided, this fingerprint must match the fingerprint of the folder in
storage.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a Google Tag Manager Folder.
&quot;accountId&quot;: &quot;A String&quot;, # GTM Account ID.
&quot;name&quot;: &quot;A String&quot;, # Folder display name.
# @mutable tagmanager.accounts.containers.folders.create
# @mutable tagmanager.accounts.containers.folders.update
&quot;containerId&quot;: &quot;A String&quot;, # GTM Container ID.
&quot;folderId&quot;: &quot;A String&quot;, # The Folder ID uniquely identifies the GTM Folder.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Folder as computed at storage time.
# This value is recomputed whenever the folder is modified.
}</pre>
</div>
</body></html>