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
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
|
<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="dfareporting_v3_5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_5.sites.html">sites</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="#get">get(profileId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Gets one site by ID.</p>
<p class="toc_element">
<code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Inserts a new site.</p>
<p class="toc_element">
<code><a href="#list">list(profileId, acceptsInStreamVideoPlacements=None, acceptsInterstitialPlacements=None, acceptsPublisherPaidPlacements=None, adWordsSite=None, approved=None, campaignIds=None, directorySiteIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, unmappedSite=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a list of sites, possibly filtered. This method supports paging.</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="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing site. This method supports patch semantics.</p>
<p class="toc_element">
<code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates an existing site.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
<pre>Gets one site by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Site ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a site.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
"approved": True or False, # Whether this site is approved.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
"siteContacts": [ # Site contacts.
{ # Site Contact
"address": "A String", # Address of this site contact.
"contactType": "A String", # Site contact type.
"email": "A String", # Email address of this site contact. This is a required field.
"firstName": "A String", # First name of this site contact.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
"lastName": "A String", # Last name of this site contact.
"phone": "A String", # Primary phone number of this site contact.
"title": "A String", # Title or designation of this site contact.
},
],
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
},
"videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
"vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
},
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
],
"imageOnly": True or False, # Whether to serve only static images as companions.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
"obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
"iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
"iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
"iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
"program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
"resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
"xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
"enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
<pre>Inserts a new site.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a site.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
"approved": True or False, # Whether this site is approved.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
"siteContacts": [ # Site contacts.
{ # Site Contact
"address": "A String", # Address of this site contact.
"contactType": "A String", # Site contact type.
"email": "A String", # Email address of this site contact. This is a required field.
"firstName": "A String", # First name of this site contact.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
"lastName": "A String", # Last name of this site contact.
"phone": "A String", # Primary phone number of this site contact.
"title": "A String", # Title or designation of this site contact.
},
],
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
},
"videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
"vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
},
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
],
"imageOnly": True or False, # Whether to serve only static images as companions.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
"obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
"iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
"iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
"iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
"program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
"resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
"xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
"enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a site.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
"approved": True or False, # Whether this site is approved.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
"siteContacts": [ # Site contacts.
{ # Site Contact
"address": "A String", # Address of this site contact.
"contactType": "A String", # Site contact type.
"email": "A String", # Email address of this site contact. This is a required field.
"firstName": "A String", # First name of this site contact.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
"lastName": "A String", # Last name of this site contact.
"phone": "A String", # Primary phone number of this site contact.
"title": "A String", # Title or designation of this site contact.
},
],
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
},
"videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
"vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
},
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
],
"imageOnly": True or False, # Whether to serve only static images as companions.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
"obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
"iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
"iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
"iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
"program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
"resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
"xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
"enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(profileId, acceptsInStreamVideoPlacements=None, acceptsInterstitialPlacements=None, acceptsPublisherPaidPlacements=None, adWordsSite=None, approved=None, campaignIds=None, directorySiteIds=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, unmappedSite=None, x__xgafv=None)</code>
<pre>Retrieves a list of sites, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
adWordsSite: boolean, Select only AdWords sites.
approved: boolean, Select only approved sites.
campaignIds: string, Select only sites with these campaign IDs. (repeated)
directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
ids: string, Select only sites with these IDs. (repeated)
maxResults: integer, Maximum number of results to return.
pageToken: string, Value of the nextPageToken from the previous result page.
searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "site 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "site" will match objects with name "my site", "site 2015", or simply "site".
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
subaccountId: string, Select only sites with this subaccount ID.
unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Site List Response
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#sitesListResponse".
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"sites": [ # Site collection.
{ # Contains properties of a site.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
"approved": True or False, # Whether this site is approved.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
"siteContacts": [ # Site contacts.
{ # Site Contact
"address": "A String", # Address of this site contact.
"contactType": "A String", # Site contact type.
"email": "A String", # Email address of this site contact. This is a required field.
"firstName": "A String", # First name of this site contact.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
"lastName": "A String", # Last name of this site contact.
"phone": "A String", # Primary phone number of this site contact.
"title": "A String", # Title or designation of this site contact.
},
],
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
},
"videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
"vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
},
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
],
"imageOnly": True or False, # Whether to serve only static images as companions.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
"obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
"iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
"iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
"iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
"program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
"resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
"xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
"enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
},
},
},
],
}</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="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
<pre>Updates an existing site. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Site ID. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a site.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
"approved": True or False, # Whether this site is approved.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
"siteContacts": [ # Site contacts.
{ # Site Contact
"address": "A String", # Address of this site contact.
"contactType": "A String", # Site contact type.
"email": "A String", # Email address of this site contact. This is a required field.
"firstName": "A String", # First name of this site contact.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
"lastName": "A String", # Last name of this site contact.
"phone": "A String", # Primary phone number of this site contact.
"title": "A String", # Title or designation of this site contact.
},
],
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
},
"videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
"vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
},
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
],
"imageOnly": True or False, # Whether to serve only static images as companions.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
"obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
"iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
"iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
"iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
"program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
"resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
"xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
"enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a site.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
"approved": True or False, # Whether this site is approved.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
"siteContacts": [ # Site contacts.
{ # Site Contact
"address": "A String", # Address of this site contact.
"contactType": "A String", # Site contact type.
"email": "A String", # Email address of this site contact. This is a required field.
"firstName": "A String", # First name of this site contact.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
"lastName": "A String", # Last name of this site contact.
"phone": "A String", # Primary phone number of this site contact.
"title": "A String", # Title or designation of this site contact.
},
],
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
},
"videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
"vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
},
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
],
"imageOnly": True or False, # Whether to serve only static images as companions.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
"obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
"iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
"iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
"iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
"program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
"resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
"xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
"enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
<pre>Updates an existing site.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body.
The object takes the form of:
{ # Contains properties of a site.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
"approved": True or False, # Whether this site is approved.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
"siteContacts": [ # Site contacts.
{ # Site Contact
"address": "A String", # Address of this site contact.
"contactType": "A String", # Site contact type.
"email": "A String", # Email address of this site contact. This is a required field.
"firstName": "A String", # First name of this site contact.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
"lastName": "A String", # Last name of this site contact.
"phone": "A String", # Primary phone number of this site contact.
"title": "A String", # Title or designation of this site contact.
},
],
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
},
"videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
"vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
},
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
],
"imageOnly": True or False, # Whether to serve only static images as companions.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
"obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
"iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
"iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
"iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
"program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
"resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
"xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
"enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains properties of a site.
"accountId": "A String", # Account ID of this site. This is a read-only field that can be left blank.
"approved": True or False, # Whether this site is approved.
"directorySiteId": "A String", # Directory site associated with this site. This is a required field that is read-only after insertion.
"directorySiteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"id": "A String", # ID of this site. This is a read-only, auto-generated field.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"id": "A String", # The ID associated with the value if available.
"kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue.
"matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
"value": "A String", # The value of the dimension.
},
"keyName": "A String", # Key name of this site. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#site".
"name": "A String", # Name of this site.This is a required field. Must be less than 128 characters long. If this site is under a subaccount, the name must be unique among sites of the same subaccount. Otherwise, this site is a top-level site, and the name must be unique among top-level sites of the same account.
"siteContacts": [ # Site contacts.
{ # Site Contact
"address": "A String", # Address of this site contact.
"contactType": "A String", # Site contact type.
"email": "A String", # Email address of this site contact. This is a required field.
"firstName": "A String", # First name of this site contact.
"id": "A String", # ID of this site contact. This is a read-only, auto-generated field.
"lastName": "A String", # Last name of this site contact.
"phone": "A String", # Primary phone number of this site contact.
"title": "A String", # Title or designation of this site contact.
},
],
"siteSettings": { # Site Settings # Site-wide settings.
"activeViewOptOut": True or False, # Whether active view creatives are disabled for this site.
"adBlockingOptOut": True or False, # Whether this site opts out of ad blocking. When true, ad blocking is disabled for all placements under the site, regardless of the individual placement settings. When false, the campaign and placement settings take effect.
"disableNewCookie": True or False, # Whether new cookies are disabled for this site.
"tagSetting": { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
"additionalKeyValues": "A String", # Additional key-values to be included in tags. Each key-value pair must be of the form key=value, and pairs must be separated by a semicolon (;). Keys and values must not contain commas. For example, id=2;color=red is a valid value for this field.
"includeClickThroughUrls": True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
"includeClickTracking": True or False, # Whether click-tracking string should be included in the tags.
"keywordOption": "A String", # Option specifying how keywords are embedded in ad tags. This setting can be used to specify whether keyword placeholders are inserted in placement tags for this site. Publishers can then add keywords to those placeholders.
},
"videoActiveViewOptOutTemplate": True or False, # Whether Verification and ActiveView for in-stream video creatives are disabled by default for new placements created under this site. This value will be used to populate the placement.videoActiveViewOptOut field, when no value is specified for the new placement.
"vpaidAdapterChoiceTemplate": "A String", # Default VPAID adapter setting for new placements created under this site. This value will be used to populate the placements.vpaidAdapterChoice field, when no value is specified for the new placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to the placement. The publisher's specifications will typically determine this setting. For VPAID creatives, the adapter format will match the VPAID format (HTML5 VPAID creatives use the HTML5 adapter). *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
},
"subaccountId": "A String", # Subaccount ID of this site. This is a read-only field that can be left blank.
"videoSettings": { # Video Settings # Default video settings for new placements created under this site. This value will be used to populate the placements.videoSettings field, when no value is specified for the new placement.
"companionSettings": { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
"companionsDisabled": True or False, # Whether companions are disabled for this site template.
"enabledSizes": [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
{ # Represents the dimensions of ads, placements, creatives, or creative assets.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
],
"imageOnly": True or False, # Whether to serve only static images as companions.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteCompanionSetting".
},
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteVideoSettings".
"obaEnabled": True or False, # Whether OBA icons are enabled for this placement.
"obaSettings": { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this site. This will act as default for new placements created under this site.
"iconClickThroughUrl": "A String", # URL to redirect to when an OBA icon is clicked.
"iconClickTrackingUrl": "A String", # URL to track click when an OBA icon is clicked.
"iconViewTrackingUrl": "A String", # URL to track view when an OBA icon is clicked.
"program": "A String", # Identifies the industry initiative that the icon supports. For example, AdChoices.
"resourceUrl": "A String", # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
"size": { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
"height": 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
"iab": True or False, # IAB standard size. This is a read-only, auto-generated field.
"id": "A String", # ID of this size. This is a read-only, auto-generated field.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#size".
"width": 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
},
"xPosition": "A String", # OBA icon x coordinate position. Accepted values are left or right.
"yPosition": "A String", # OBA icon y coordinate position. Accepted values are top or bottom.
},
"orientation": "A String", # Orientation of a site template used for video. This will act as default for new placements created under this site.
"skippableSettings": { # Skippable Settings # Settings for the skippability of video creatives served to this site. This will act as default for new placements created under this site.
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteSkippableSetting".
"progressOffset": { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skipOffset": { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
"offsetPercentage": 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
"offsetSeconds": 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
},
"skippable": True or False, # Whether the user can skip creatives served to this site. This will act as default for new placements created under this site.
},
"transcodeSettings": { # Transcode Settings # Settings for the transcodes of video creatives served to this site. This will act as default for new placements created under this site.
"enabledVideoFormats": [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
42,
],
"kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#siteTranscodeSetting".
},
},
}</pre>
</div>
</body></html>
|
