File: tagmanager_v2.accounts.html

package info (click to toggle)
python-googleapi 1.7.11-4
  • links: PTS
  • area: main
  • in suites: bullseye
  • size: 110,952 kB
  • sloc: python: 7,784; javascript: 249; makefile: 59; sh: 53; xml: 5
file content (192 lines) | stat: -rw-r--r-- 7,102 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
<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="#get">get(path)</a></code></p>
<p class="firstline">Gets a GTM Account.</p>
<p class="toc_element">
  <code><a href="#list">list(pageToken=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, fingerprint=None)</a></code></p>
<p class="firstline">Updates a GTM Account.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="get">get(path)</code>
  <pre>Gets a GTM Account.

Args:
  path: string, GTM Accounts's API relative path. Example: accounts/{account_id} (required)

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Account.
    "name": "A String", # Account display name.
    "shareData": 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.
    "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
    "fingerprint": "A String", # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
    "path": "A String", # GTM Account's API relative path.
    "accountId": "A String", # The Account ID uniquely identifies the GTM Account.
  }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(pageToken=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.

Returns:
  An object of the form:

    { # List Accounts Response.
    "nextPageToken": "A String", # Continuation token for fetching the next page of results.
    "account": [ # List of GTM Accounts that a user has access to.
      { # Represents a Google Tag Manager Account.
        "name": "A String", # Account display name.
        "shareData": 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.
        "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
        "fingerprint": "A String", # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
        "path": "A String", # GTM Account's API relative path.
        "accountId": "A String", # The Account ID uniquely identifies the GTM Account.
      },
    ],
  }</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 'execute()' 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, fingerprint=None)</code>
  <pre>Updates a GTM Account.

Args:
  path: string, GTM Accounts's API relative path. Example: accounts/{account_id} (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Represents a Google Tag Manager Account.
  "name": "A String", # Account display name.
  "shareData": 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.
  "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
  "fingerprint": "A String", # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
  "path": "A String", # GTM Account's API relative path.
  "accountId": "A String", # The Account ID uniquely identifies the GTM Account.
}

  fingerprint: string, When provided, this fingerprint must match the fingerprint of the account in storage.

Returns:
  An object of the form:

    { # Represents a Google Tag Manager Account.
    "name": "A String", # Account display name.
    "shareData": 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.
    "tagManagerUrl": "A String", # Auto generated link to the tag manager UI
    "fingerprint": "A String", # The fingerprint of the GTM Account as computed at storage time. This value is recomputed whenever the account is modified.
    "path": "A String", # GTM Account's API relative path.
    "accountId": "A String", # The Account ID uniquely identifies the GTM Account.
  }</pre>
</div>

</body></html>