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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
<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> . <a href="tagmanager_v2.accounts.containers.html">containers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="tagmanager_v2.accounts.containers.environments.html">environments()</a></code>
</p>
<p class="firstline">Returns the environments Resource.</p>
<p class="toc_element">
<code><a href="tagmanager_v2.accounts.containers.version_headers.html">version_headers()</a></code>
</p>
<p class="firstline">Returns the version_headers Resource.</p>
<p class="toc_element">
<code><a href="tagmanager_v2.accounts.containers.versions.html">versions()</a></code>
</p>
<p class="firstline">Returns the versions Resource.</p>
<p class="toc_element">
<code><a href="tagmanager_v2.accounts.containers.workspaces.html">workspaces()</a></code>
</p>
<p class="firstline">Returns the workspaces Resource.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body)</a></code></p>
<p class="firstline">Creates a Container.</p>
<p class="toc_element">
<code><a href="#delete">delete(path)</a></code></p>
<p class="firstline">Deletes a Container.</p>
<p class="toc_element">
<code><a href="#get">get(path)</a></code></p>
<p class="firstline">Gets a Container.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageToken=None)</a></code></p>
<p class="firstline">Lists all Containers that belongs to a GTM Account.</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 Container.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body)</code>
<pre>Creates a Container.
Args:
parent: string, GTM Account'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 Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
"publicId": "A String", # Container Public ID.
"containerId": "A String", # The Container ID uniquely identifies the GTM Container.
"domainName": [ # List of domain names associated with the Container.
"A String",
],
"notes": "A String", # Container Notes.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
"path": "A String", # GTM Container's API relative path.
"accountId": "A String", # GTM Account ID.
"name": "A String", # Container display name.
}
Returns:
An object of the form:
{ # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
"publicId": "A String", # Container Public ID.
"containerId": "A String", # The Container ID uniquely identifies the GTM Container.
"domainName": [ # List of domain names associated with the Container.
"A String",
],
"notes": "A String", # Container Notes.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
"path": "A String", # GTM Container's API relative path.
"accountId": "A String", # GTM Account ID.
"name": "A String", # Container display name.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(path)</code>
<pre>Deletes a Container.
Args:
path: string, GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} (required)
</pre>
</div>
<div class="method">
<code class="details" id="get">get(path)</code>
<pre>Gets a Container.
Args:
path: string, GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} (required)
Returns:
An object of the form:
{ # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
"publicId": "A String", # Container Public ID.
"containerId": "A String", # The Container ID uniquely identifies the GTM Container.
"domainName": [ # List of domain names associated with the Container.
"A String",
],
"notes": "A String", # Container Notes.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
"path": "A String", # GTM Container's API relative path.
"accountId": "A String", # GTM Account ID.
"name": "A String", # Container display name.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageToken=None)</code>
<pre>Lists all Containers that belongs to a GTM Account.
Args:
parent: string, GTM Accounts's API relative path. Example: accounts/{account_id}. (required)
pageToken: string, Continuation token for fetching the next page of results.
Returns:
An object of the form:
{ # List Containers Response.
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
"container": [ # All Containers of a GTM Account.
{ # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
"publicId": "A String", # Container Public ID.
"containerId": "A String", # The Container ID uniquely identifies the GTM Container.
"domainName": [ # List of domain names associated with the Container.
"A String",
],
"notes": "A String", # Container Notes.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
"path": "A String", # GTM Container's API relative path.
"accountId": "A String", # GTM Account ID.
"name": "A String", # Container display name.
},
],
}</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 Container.
Args:
path: string, GTM Container's API relative path. Example: accounts/{account_id}/containers/{container_id} (required)
body: object, The request body. (required)
The object takes the form of:
{ # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
"publicId": "A String", # Container Public ID.
"containerId": "A String", # The Container ID uniquely identifies the GTM Container.
"domainName": [ # List of domain names associated with the Container.
"A String",
],
"notes": "A String", # Container Notes.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
"path": "A String", # GTM Container's API relative path.
"accountId": "A String", # GTM Account ID.
"name": "A String", # Container display name.
}
fingerprint: string, When provided, this fingerprint must match the fingerprint of the container in storage.
Returns:
An object of the form:
{ # Represents a Google Tag Manager Container, which specifies the platform tags will run on, manages workspaces, and retains container versions.
"publicId": "A String", # Container Public ID.
"containerId": "A String", # The Container ID uniquely identifies the GTM Container.
"domainName": [ # List of domain names associated with the Container.
"A String",
],
"notes": "A String", # Container Notes.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"usageContext": [ # List of Usage Contexts for the Container. Valid values include: web, android, or ios.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Container as computed at storage time. This value is recomputed whenever the account is modified.
"path": "A String", # GTM Container's API relative path.
"accountId": "A String", # GTM Account ID.
"name": "A String", # Container display name.
}</pre>
</div>
</body></html>
|
