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
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
|
<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.folders.html">folders</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 Folder.</p>
<p class="toc_element">
<code><a href="#delete">delete(path, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a GTM Folder.</p>
<p class="toc_element">
<code><a href="#entities">entities(path, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all entities in a GTM Folder.</p>
<p class="toc_element">
<code><a href="#entities_next">entities_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#get">get(path, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a GTM Folder.</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 Folders of a Container.</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="#move_entities_to_folder">move_entities_to_folder(path, body=None, tagId=None, triggerId=None, variableId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Moves entities to a GTM Folder. If {folder_id} in the request path equals 0, this will instead move entities out of the folder they currently belong to.</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 Folder 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 Folder.</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 Folder.
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 Folder.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
"folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
"name": "A String", # Folder display name.
"notes": "A String", # User notes on how to apply this folder in the container.
"path": "A String", # GTM Folder's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"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 Folder.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
"folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
"name": "A String", # Folder display name.
"notes": "A String", # User notes on how to apply this folder in the container.
"path": "A String", # GTM Folder's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"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 Folder.
Args:
path: string, GTM Folder'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="entities">entities(path, pageToken=None, x__xgafv=None)</code>
<pre>List all entities in a GTM Folder.
Args:
path: string, GTM Folder'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:
{ # Represents a Google Tag Manager Folder's contents.
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
"tag": [ # The list of tags inside the folder.
{ # Represents a Google Tag Manager Tag.
"accountId": "A String", # GTM Account ID.
"blockingTriggerId": [ # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag will not fire.
"A String",
],
"consentSettings": { # Consent settings of a tag.
"consentStatus": "A String", # The tag's consent status. If set to NEEDED, the runtime will check that the consent types specified by the consent_type field have been granted.
"consentType": { # Represents a Google Tag Manager Parameter. # The type of consents to check for during tag firing if in the consent NEEDED state. This parameter must be of type LIST where each list item is of type STRING.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
},
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Tag as computed at storage time. This value is recomputed whenever the tag is modified.
"firingTriggerId": [ # Firing trigger IDs. A tag will fire when any of the listed triggers are true and all of its blockingTriggerIds (if any specified) are false.
"A String",
],
"liveOnly": True or False, # If set to true, this tag will only fire in the live environment (e.g. not in preview or debug mode).
"monitoringMetadata": { # Represents a Google Tag Manager Parameter. # A map of key-value pairs of tag metadata to be included in the event data for tag monitoring. Notes: - This parameter must be type MAP. - Each parameter in the map are type TEMPLATE, however cannot contain variable references.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"monitoringMetadataTagNameKey": "A String", # If non-empty, then the tag display name will be included in the monitoring metadata map using the key specified.
"name": "A String", # Tag display name.
"notes": "A String", # User notes on how to apply this tag in the container.
"parameter": [ # The tag's parameters.
{ # Represents a Google Tag Manager Parameter.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
],
"parentFolderId": "A String", # Parent folder id.
"path": "A String", # GTM Tag's API relative path.
"paused": True or False, # Indicates whether the tag is paused, which prevents the tag from firing.
"priority": { # Represents a Google Tag Manager Parameter. # User defined numeric priority of the tag. Tags are fired asynchronously in order of priority. Tags with higher numeric value fire first. A tag's priority can be a positive or negative value. The default value is 0.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a tag.
"scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a tag.
"setupTag": [ # The list of setup tags. Currently we only allow one.
{ # Represents a reference to atag that fires before another tag in order to set up dependencies.
"stopOnSetupFailure": True or False, # If true, fire the main tag if and only if the setup tag fires successfully. If false, fire the main tag regardless of setup tag firing status.
"tagName": "A String", # The name of the setup tag.
},
],
"tagFiringOption": "A String", # Option to fire this tag.
"tagId": "A String", # The Tag ID uniquely identifies the GTM Tag.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"teardownTag": [ # The list of teardown tags. Currently we only allow one.
{ # Represents a tag that fires after another tag in order to tear down dependencies.
"stopTeardownOnFailure": True or False, # If true, fire the teardown tag if and only if the main tag fires successfully. If false, fire the teardown tag regardless of main tag firing status.
"tagName": "A String", # The name of the teardown tag.
},
],
"type": "A String", # GTM Tag Type.
"workspaceId": "A String", # GTM Workspace ID.
},
],
"trigger": [ # The list of triggers inside the folder.
{ # Represents a Google Tag Manager Trigger
"accountId": "A String", # GTM Account ID.
"autoEventFilter": [ # Used in the case of auto event tracking.
{ # Represents a predicate.
"parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
{ # Represents a Google Tag Manager Parameter.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
],
"type": "A String", # The type of operator for this condition.
},
],
"checkValidation": { # Represents a Google Tag Manager Parameter. # Whether or not we should only fire tags if the form submit or link click event is not cancelled by some other event handler (e.g. because of validation). Only valid for Form Submission and Link Click triggers.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"containerId": "A String", # GTM Container ID.
"continuousTimeMinMilliseconds": { # Represents a Google Tag Manager Parameter. # A visibility trigger minimum continuous visible time (in milliseconds). Only valid for AMP Visibility trigger.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"customEventFilter": [ # Used in the case of custom event, which is fired iff all Conditions are true.
{ # Represents a predicate.
"parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
{ # Represents a Google Tag Manager Parameter.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
],
"type": "A String", # The type of operator for this condition.
},
],
"eventName": { # Represents a Google Tag Manager Parameter. # Name of the GTM event that is fired. Only valid for Timer triggers.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"filter": [ # The trigger will only fire iff all Conditions are true.
{ # Represents a predicate.
"parameter": [ # A list of named parameters (key/value), depending on the condition's type. Notes: - For binary operators, include parameters named arg0 and arg1 for specifying the left and right operands, respectively. - At this time, the left operand (arg0) must be a reference to a variable. - For case-insensitive Regex matching, include a boolean parameter named ignore_case that is set to true. If not specified or set to any other value, the matching will be case sensitive. - To negate an operator, include a boolean parameter named negate boolean parameter that is set to true.
{ # Represents a Google Tag Manager Parameter.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
],
"type": "A String", # The type of operator for this condition.
},
],
"fingerprint": "A String", # The fingerprint of the GTM Trigger as computed at storage time. This value is recomputed whenever the trigger is modified.
"horizontalScrollPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled horizontally. Only valid for AMP scroll triggers.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"interval": { # Represents a Google Tag Manager Parameter. # Time between triggering recurring Timer Events (in milliseconds). Only valid for Timer triggers.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"intervalSeconds": { # Represents a Google Tag Manager Parameter. # Time between Timer Events to fire (in seconds). Only valid for AMP Timer trigger.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"limit": { # Represents a Google Tag Manager Parameter. # Limit of the number of GTM events this Timer Trigger will fire. If no limit is set, we will continue to fire GTM events until the user leaves the page. Only valid for Timer triggers.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"maxTimerLengthSeconds": { # Represents a Google Tag Manager Parameter. # Max time to fire Timer Events (in seconds). Only valid for AMP Timer trigger.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"name": "A String", # Trigger display name.
"notes": "A String", # User notes on how to apply this trigger in the container.
"parameter": [ # Additional parameters.
{ # Represents a Google Tag Manager Parameter.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
],
"parentFolderId": "A String", # Parent folder id.
"path": "A String", # GTM Trigger's API relative path.
"selector": { # Represents a Google Tag Manager Parameter. # A click trigger CSS selector (i.e. "a", "button" etc.). Only valid for AMP Click trigger.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"totalTimeMinMilliseconds": { # Represents a Google Tag Manager Parameter. # A visibility trigger minimum total visible time (in milliseconds). Only valid for AMP Visibility trigger.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"triggerId": "A String", # The Trigger ID uniquely identifies the GTM Trigger.
"type": "A String", # Defines the data layer event that causes this trigger.
"uniqueTriggerId": { # Represents a Google Tag Manager Parameter. # Globally unique id of the trigger that auto-generates this (a Form Submit, Link Click or Timer listener) if any. Used to make incompatible auto-events work together with trigger filtering based on trigger ids. This value is populated during output generation since the tags implied by triggers don't exist until then. Only valid for Form Submit, Link Click and Timer triggers.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"verticalScrollPercentageList": { # Represents a Google Tag Manager Parameter. # List of integer percentage values for scroll triggers. The trigger will fire when each percentage is reached when the view is scrolled vertically. Only valid for AMP scroll triggers.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"visibilitySelector": { # Represents a Google Tag Manager Parameter. # A visibility trigger CSS selector (i.e. "#id"). Only valid for AMP Visibility trigger.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"visiblePercentageMax": { # Represents a Google Tag Manager Parameter. # A visibility trigger maximum percent visibility. Only valid for AMP Visibility trigger.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"visiblePercentageMin": { # Represents a Google Tag Manager Parameter. # A visibility trigger minimum percent visibility. Only valid for AMP Visibility trigger.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"waitForTags": { # Represents a Google Tag Manager Parameter. # Whether or not we should delay the form submissions or link opening until all of the tags have fired (by preventing the default action and later simulating the default action). Only valid for Form Submission and Link Click triggers.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"waitForTagsTimeout": { # Represents a Google Tag Manager Parameter. # How long to wait (in milliseconds) for tags to fire when 'waits_for_tags' above evaluates to true. Only valid for Form Submission and Link Click triggers.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"workspaceId": "A String", # GTM Workspace ID.
},
],
"variable": [ # The list of variables inside the folder.
{ # Represents a Google Tag Manager Variable.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"disablingTriggerId": [ # For mobile containers only: A list of trigger IDs for disabling conditional variables; the variable is enabled if one of the enabling trigger is true while all the disabling trigger are false. Treated as an unordered set.
"A String",
],
"enablingTriggerId": [ # For mobile containers only: A list of trigger IDs for enabling conditional variables; the variable is enabled if one of the enabling triggers is true while all the disabling triggers are false. Treated as an unordered set.
"A String",
],
"fingerprint": "A String", # The fingerprint of the GTM Variable as computed at storage time. This value is recomputed whenever the variable is modified.
"formatValue": { # Option to convert a variable value to other value.
"caseConversionType": "A String", # The option to convert a string-type variable value to either lowercase or uppercase.
"convertFalseToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is false.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"convertNullToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is null.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"convertTrueToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is true.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
"convertUndefinedToValue": { # Represents a Google Tag Manager Parameter. # The value to convert if a variable value is undefined.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
},
"name": "A String", # Variable display name.
"notes": "A String", # User notes on how to apply this variable in the container.
"parameter": [ # The variable's parameters.
{ # Represents a Google Tag Manager Parameter.
"isWeakReference": True or False, # Whether or not a reference type parameter is strongly or weakly referenced. Only used by Transformations.
"key": "A String", # The named key that uniquely identifies a parameter. Required for top-level parameters, as well as map values. Ignored for list values.
"list": [ # This list parameter's parameters (keys will be ignored).
# Object with schema name: Parameter
],
"map": [ # This map parameter's parameters (must have keys; keys must be unique).
# Object with schema name: Parameter
],
"type": "A String", # The parameter type. Valid values are: - boolean: The value represents a boolean, represented as 'true' or 'false' - integer: The value represents a 64-bit signed integer value, in base 10 - list: A list of parameters should be specified - map: A map of parameters should be specified - template: The value represents any text; this can include variable references (even variable references that might return non-string types) - trigger_reference: The value represents a trigger, represented as the trigger id - tag_reference: The value represents a tag, represented as the tag name
"value": "A String", # A parameter's value (may contain variable references). as appropriate to the specified type.
},
],
"parentFolderId": "A String", # Parent folder id.
"path": "A String", # GTM Variable's API relative path.
"scheduleEndMs": "A String", # The end timestamp in milliseconds to schedule a variable.
"scheduleStartMs": "A String", # The start timestamp in milliseconds to schedule a variable.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"type": "A String", # GTM Variable Type.
"variableId": "A String", # The Variable ID uniquely identifies the GTM Variable.
"workspaceId": "A String", # GTM Workspace ID.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="entities_next">entities_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="get">get(path, x__xgafv=None)</code>
<pre>Gets a GTM Folder.
Args:
path: string, GTM Folder'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 Folder.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
"folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
"name": "A String", # Folder display name.
"notes": "A String", # User notes on how to apply this folder in the container.
"path": "A String", # GTM Folder's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"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 Folders of a Container.
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:
{ # List Folders Response.
"folder": [ # All GTM Folders of a GTM Container.
{ # Represents a Google Tag Manager Folder.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
"folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
"name": "A String", # Folder display name.
"notes": "A String", # User notes on how to apply this folder in the container.
"path": "A String", # GTM Folder's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"workspaceId": "A String", # GTM Workspace ID.
},
],
"nextPageToken": "A String", # Continuation token for fetching the next page of results.
}</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="move_entities_to_folder">move_entities_to_folder(path, body=None, tagId=None, triggerId=None, variableId=None, x__xgafv=None)</code>
<pre>Moves entities to a GTM Folder. If {folder_id} in the request path equals 0, this will instead move entities out of the folder they currently belong to.
Args:
path: string, GTM Folder's API relative path. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Google Tag Manager Folder.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
"folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
"name": "A String", # Folder display name.
"notes": "A String", # User notes on how to apply this folder in the container.
"path": "A String", # GTM Folder's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"workspaceId": "A String", # GTM Workspace ID.
}
tagId: string, The tags to be moved to the folder. (repeated)
triggerId: string, The triggers to be moved to the folder. (repeated)
variableId: string, The variables to be moved to the folder. (repeated)
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="revert">revert(path, fingerprint=None, x__xgafv=None)</code>
<pre>Reverts changes to a GTM Folder in a GTM Workspace.
Args:
path: string, GTM Folder's API relative path. (required)
fingerprint: string, When provided, this fingerprint must match the fingerprint of the tag 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 folder changes in a workspace.
"folder": { # Represents a Google Tag Manager Folder. # Folder as it appears in the latest container version since the last workspace synchronization operation. If no folder is present, that means the folder 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 Folder as computed at storage time. This value is recomputed whenever the folder is modified.
"folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
"name": "A String", # Folder display name.
"notes": "A String", # User notes on how to apply this folder in the container.
"path": "A String", # GTM Folder's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"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 Folder.
Args:
path: string, GTM Folder's API relative path. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a Google Tag Manager Folder.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
"folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
"name": "A String", # Folder display name.
"notes": "A String", # User notes on how to apply this folder in the container.
"path": "A String", # GTM Folder's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"workspaceId": "A String", # GTM Workspace ID.
}
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.
"accountId": "A String", # GTM Account ID.
"containerId": "A String", # GTM Container ID.
"fingerprint": "A String", # The fingerprint of the GTM Folder as computed at storage time. This value is recomputed whenever the folder is modified.
"folderId": "A String", # The Folder ID uniquely identifies the GTM Folder.
"name": "A String", # Folder display name.
"notes": "A String", # User notes on how to apply this folder in the container.
"path": "A String", # GTM Folder's API relative path.
"tagManagerUrl": "A String", # Auto generated link to the tag manager UI
"workspaceId": "A String", # GTM Workspace ID.
}</pre>
</div>
</body></html>
|
