blob: c1641e61941ea77543259ef21ccde4c00988b18a [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_v2.html">Tag Manager API</a> . <a href="tagmanager_v2.accounts.html">accounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="tagmanager_v2.accounts.containers.html">containers()</a></code>
</p>
<p class="firstline">Returns the containers Resource.</p>
<p class="toc_element">
<code><a href="tagmanager_v2.accounts.user_permissions.html">user_permissions()</a></code>
</p>
<p class="firstline">Returns the user_permissions Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(path, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a GTM Account.</p>
<p class="toc_element">
<code><a href="#list">list(pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all GTM Accounts that a user has access to.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(path, body=None, fingerprint=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a GTM Account.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(path, x__xgafv=None)</code>
<pre>Gets a GTM Account.
Args:
path: string, GTM Accounts&#x27;s API relative path. Example: accounts/{account_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 Account.
&quot;accountId&quot;: &quot;A String&quot;, # The Account ID uniquely identifies the GTM Account.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
&quot;name&quot;: &quot;A String&quot;, # Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
&quot;path&quot;: &quot;A String&quot;, # GTM Account&#x27;s API relative path.
&quot;shareData&quot;: True or False, # Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
&quot;tagManagerUrl&quot;: &quot;A String&quot;, # Auto generated link to the tag manager UI
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageToken=None, x__xgafv=None)</code>
<pre>Lists all GTM Accounts that a user has access to.
Args:
pageToken: string, Continuation token for fetching the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # List Accounts Response.
&quot;account&quot;: [ # List of GTM Accounts that a user has access to.
{ # Represents a Google Tag Manager Account.
&quot;accountId&quot;: &quot;A String&quot;, # The Account ID uniquely identifies the GTM Account.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
&quot;name&quot;: &quot;A String&quot;, # Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
&quot;path&quot;: &quot;A String&quot;, # GTM Account&#x27;s API relative path.
&quot;shareData&quot;: True or False, # Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
&quot;tagManagerUrl&quot;: &quot;A String&quot;, # Auto generated link to the tag manager UI
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token for fetching the next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(path, body=None, fingerprint=None, x__xgafv=None)</code>
<pre>Updates a GTM Account.
Args:
path: string, GTM Accounts&#x27;s API relative path. Example: accounts/{account_id} (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Google Tag Manager Account.
&quot;accountId&quot;: &quot;A String&quot;, # The Account ID uniquely identifies the GTM Account.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
&quot;name&quot;: &quot;A String&quot;, # Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
&quot;path&quot;: &quot;A String&quot;, # GTM Account&#x27;s API relative path.
&quot;shareData&quot;: True or False, # Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
&quot;tagManagerUrl&quot;: &quot;A String&quot;, # Auto generated link to the tag manager UI
}
fingerprint: string, When provided, this fingerprint must match the fingerprint of the account 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 Account.
&quot;accountId&quot;: &quot;A String&quot;, # The Account ID uniquely identifies the GTM Account.
&quot;fingerprint&quot;: &quot;A String&quot;, # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
&quot;name&quot;: &quot;A String&quot;, # Account display name. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
&quot;path&quot;: &quot;A String&quot;, # GTM Account&#x27;s API relative path.
&quot;shareData&quot;: True or False, # Whether the account shares data anonymously with Google and others. This flag enables benchmarking by sharing your data in an anonymous form. Google will remove all identifiable information about your website, combine the data with hundreds of other anonymous sites and report aggregate trends in the benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager.accounts.update
&quot;tagManagerUrl&quot;: &quot;A String&quot;, # Auto generated link to the tag manager UI
}</pre>
</div>
</body></html>