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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
|
<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> . <a href="tagmanager_v2.accounts.containers.workspaces.html">workspaces</a> . <a href="tagmanager_v2.accounts.containers.workspaces.templates.html">templates</a></h1>
<h2>Instance Methods</h2>
<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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a GTM Custom Template.</p>
<p class="toc_element">
<code><a href="#delete">delete(path, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a GTM Template.</p>
<p class="toc_element">
<code><a href="#get">get(path, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a GTM Template.</p>
<p class="toc_element">
<code><a href="#import_from_gallery">import_from_gallery(parent, acknowledgePermissions=None, galleryOwner=None, galleryRepository=None, gallerySha=None, x__xgafv=None)</a></code></p>
<p class="firstline">Imports a GTM Custom Template from Gallery.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all GTM Templates of a GTM container workspace.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#revert">revert(path, fingerprint=None, x__xgafv=None)</a></code></p>
<p class="firstline">Reverts changes to a GTM Template in a GTM Workspace.</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 Template.</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="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a GTM Custom Template.
Args:
parent: string, GTM Workspace's API relative path. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Google Tag Manager Custom Template's contents.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
"galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
"galleryTemplateId": "A String", # ID for the gallery template that is generated once during first sync and travels with the template redirects.
"host": "A String", # The name of the host for the community gallery template.
"isModified": True or False, # If a user has manually edited the community gallery template.
"owner": "A String", # The name of the owner for the community gallery template.
"repository": "A String", # The name of the repository for the community gallery template.
"signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
"templateDeveloperId": "A String", # The developer id of the community gallery template. This value is set whenever the template is created from the gallery.
"version": "A String", # The version of the community gallery template.
},
"name": "A String", # Custom Template display name.
"path": "A String", # GTM Custom Template's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"templateData": "A String", # The custom template in text format.
"templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
"workspaceId": "A String", # GTM Workspace ID.
}
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 Custom Template's contents.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
"galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
"galleryTemplateId": "A String", # ID for the gallery template that is generated once during first sync and travels with the template redirects.
"host": "A String", # The name of the host for the community gallery template.
"isModified": True or False, # If a user has manually edited the community gallery template.
"owner": "A String", # The name of the owner for the community gallery template.
"repository": "A String", # The name of the repository for the community gallery template.
"signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
"templateDeveloperId": "A String", # The developer id of the community gallery template. This value is set whenever the template is created from the gallery.
"version": "A String", # The version of the community gallery template.
},
"name": "A String", # Custom Template display name.
"path": "A String", # GTM Custom Template's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"templateData": "A String", # The custom template in text format.
"templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
"workspaceId": "A String", # GTM Workspace ID.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(path, x__xgafv=None)</code>
<pre>Deletes a GTM Template.
Args:
path: string, GTM Custom Template's API relative path. (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(path, x__xgafv=None)</code>
<pre>Gets a GTM Template.
Args:
path: string, GTM Custom Template's API relative path. (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 Custom Template's contents.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
"galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
"galleryTemplateId": "A String", # ID for the gallery template that is generated once during first sync and travels with the template redirects.
"host": "A String", # The name of the host for the community gallery template.
"isModified": True or False, # If a user has manually edited the community gallery template.
"owner": "A String", # The name of the owner for the community gallery template.
"repository": "A String", # The name of the repository for the community gallery template.
"signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
"templateDeveloperId": "A String", # The developer id of the community gallery template. This value is set whenever the template is created from the gallery.
"version": "A String", # The version of the community gallery template.
},
"name": "A String", # Custom Template display name.
"path": "A String", # GTM Custom Template's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"templateData": "A String", # The custom template in text format.
"templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
"workspaceId": "A String", # GTM Workspace ID.
}</pre>
</div>
<div class="method">
<code class="details" id="import_from_gallery">import_from_gallery(parent, acknowledgePermissions=None, galleryOwner=None, galleryRepository=None, gallerySha=None, x__xgafv=None)</code>
<pre>Imports a GTM Custom Template from Gallery.
Args:
parent: string, GTM Workspace's API relative path. (required)
acknowledgePermissions: boolean, Must be set to true to allow Gallery template to be imported into the workspace. If this bit is false, the import operation will fail.
galleryOwner: string, Owner of the Gallery template to import
galleryRepository: string, Repository of the Gallery template to import
gallerySha: string, SHA version of the Gallery template to import. Defaulted to the latest SHA version if not provided.
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 Custom Template's contents.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
"galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
"galleryTemplateId": "A String", # ID for the gallery template that is generated once during first sync and travels with the template redirects.
"host": "A String", # The name of the host for the community gallery template.
"isModified": True or False, # If a user has manually edited the community gallery template.
"owner": "A String", # The name of the owner for the community gallery template.
"repository": "A String", # The name of the repository for the community gallery template.
"signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
"templateDeveloperId": "A String", # The developer id of the community gallery template. This value is set whenever the template is created from the gallery.
"version": "A String", # The version of the community gallery template.
},
"name": "A String", # Custom Template display name.
"path": "A String", # GTM Custom Template's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"templateData": "A String", # The custom template in text format.
"templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
"workspaceId": "A String", # GTM Workspace ID.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageToken=None, x__xgafv=None)</code>
<pre>Lists all GTM Templates of a GTM container workspace.
Args:
parent: string, GTM Workspace's API relative path. (required)
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:
{
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
"template": [ # All GTM Custom Templates of a GTM Container.
{ # Represents a Google Tag Manager Custom Template's contents.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
"galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
"galleryTemplateId": "A String", # ID for the gallery template that is generated once during first sync and travels with the template redirects.
"host": "A String", # The name of the host for the community gallery template.
"isModified": True or False, # If a user has manually edited the community gallery template.
"owner": "A String", # The name of the owner for the community gallery template.
"repository": "A String", # The name of the repository for the community gallery template.
"signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
"templateDeveloperId": "A String", # The developer id of the community gallery template. This value is set whenever the template is created from the gallery.
"version": "A String", # The version of the community gallery template.
},
"name": "A String", # Custom Template display name.
"path": "A String", # GTM Custom Template's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"templateData": "A String", # The custom template in text format.
"templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
"workspaceId": "A String", # GTM Workspace ID.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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="revert">revert(path, fingerprint=None, x__xgafv=None)</code>
<pre>Reverts changes to a GTM Template in a GTM Workspace.
Args:
path: string, GTM Custom Template's API relative path. (required)
fingerprint: string, When provided, this fingerprint must match the fingerprint of the template in storage.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The result of reverting a template in a workspace.
"template": { # Represents a Google Tag Manager Custom Template's contents. # Template as it appears in the latest container version since the last workspace synchronization operation. If no template is present, that means the template was deleted in the latest container version.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
"galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
"galleryTemplateId": "A String", # ID for the gallery template that is generated once during first sync and travels with the template redirects.
"host": "A String", # The name of the host for the community gallery template.
"isModified": True or False, # If a user has manually edited the community gallery template.
"owner": "A String", # The name of the owner for the community gallery template.
"repository": "A String", # The name of the repository for the community gallery template.
"signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
"templateDeveloperId": "A String", # The developer id of the community gallery template. This value is set whenever the template is created from the gallery.
"version": "A String", # The version of the community gallery template.
},
"name": "A String", # Custom Template display name.
"path": "A String", # GTM Custom Template's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"templateData": "A String", # The custom template in text format.
"templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
"workspaceId": "A String", # GTM Workspace ID.
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(path, body=None, fingerprint=None, x__xgafv=None)</code>
<pre>Updates a GTM Template.
Args:
path: string, GTM Custom Template's API relative path. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Google Tag Manager Custom Template's contents.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
"galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
"galleryTemplateId": "A String", # ID for the gallery template that is generated once during first sync and travels with the template redirects.
"host": "A String", # The name of the host for the community gallery template.
"isModified": True or False, # If a user has manually edited the community gallery template.
"owner": "A String", # The name of the owner for the community gallery template.
"repository": "A String", # The name of the repository for the community gallery template.
"signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
"templateDeveloperId": "A String", # The developer id of the community gallery template. This value is set whenever the template is created from the gallery.
"version": "A String", # The version of the community gallery template.
},
"name": "A String", # Custom Template display name.
"path": "A String", # GTM Custom Template's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"templateData": "A String", # The custom template in text format.
"templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
"workspaceId": "A String", # GTM Workspace ID.
}
fingerprint: string, When provided, this fingerprint must match the fingerprint of the templates 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 Custom Template's contents.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Custom Template as computed at storage time. This value is recomputed whenever the template is modified.
"galleryReference": { # Represents the link between a custom template and an entry on the Community Template Gallery site. # A reference to the Community Template Gallery entry.
"galleryTemplateId": "A String", # ID for the gallery template that is generated once during first sync and travels with the template redirects.
"host": "A String", # The name of the host for the community gallery template.
"isModified": True or False, # If a user has manually edited the community gallery template.
"owner": "A String", # The name of the owner for the community gallery template.
"repository": "A String", # The name of the repository for the community gallery template.
"signature": "A String", # The signature of the community gallery template as computed at import time. This value is recomputed whenever the template is updated from the gallery.
"templateDeveloperId": "A String", # The developer id of the community gallery template. This value is set whenever the template is created from the gallery.
"version": "A String", # The version of the community gallery template.
},
"name": "A String", # Custom Template display name.
"path": "A String", # GTM Custom Template's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"templateData": "A String", # The custom template in text format.
"templateId": "A String", # The Custom Template ID uniquely identifies the GTM custom template.
"workspaceId": "A String", # GTM Workspace ID.
}</pre>
</div>
</body></html>
|
