Debian Codegraph @

docs/dyn/dfareporting_v5.sites.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="dfareporting_v5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v5.sites.html">sites</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
82 <p class="firstline">Gets one site by ID.</p>
83 <p class="toc_element">
84 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Inserts a new site.</p>
86 <p class="toc_element">
87 <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>
88 <p class="firstline">Retrieves a list of sites, possibly filtered. This method supports paging.</p>
89 <p class="toc_element">
90 <code><a href="#list_next">list_next()</a></code></p>
91 <p class="firstline">Retrieves the next page of results.</p>
92 <p class="toc_element">
93 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Updates an existing site. This method supports patch semantics.</p>
95 <p class="toc_element">
96 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates an existing site.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
106 <pre>Gets one site by ID.
107
108 Args:
109 profileId: string, User profile ID associated with this request. (required)
110 id: string, Site ID. (required)
111 x__xgafv: string, V1 error format.
112 Allowed values
113 1 - v1 error format
114 2 - v2 error format
115
116 Returns:
117 An object of the form:
118
119 { # Contains properties of a site.
120 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this site. This is a read-only field that can be left blank.
121 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
122 &quot;approved&quot;: True or False, # Whether this site is approved.
123 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site associated with this site. This is a required field that is read-only after insertion.
124 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
125 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
126 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
127 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
128 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
129 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
130 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
131 },
132 &quot;id&quot;: &quot;A String&quot;, # ID of this site. This is a read-only, auto-generated field.
133 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
134 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
135 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
136 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
137 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
138 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
139 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
140 },
141 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this site. This is a read-only, auto-generated field.
142 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#site&quot;.
143 &quot;name&quot;: &quot;A String&quot;, # 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.
144 &quot;siteContacts&quot;: [ # Site contacts.
145 { # Site Contact
146 &quot;address&quot;: &quot;A String&quot;, # Address of this site contact.
147 &quot;contactType&quot;: &quot;A String&quot;, # Site contact type.
148 &quot;email&quot;: &quot;A String&quot;, # Email address of this site contact. This is a required field.
149 &quot;firstName&quot;: &quot;A String&quot;, # First name of this site contact.
150 &quot;id&quot;: &quot;A String&quot;, # ID of this site contact. This is a read-only, auto-generated field.
151 &quot;lastName&quot;: &quot;A String&quot;, # Last name of this site contact.
152 &quot;phone&quot;: &quot;A String&quot;, # Primary phone number of this site contact.
153 &quot;title&quot;: &quot;A String&quot;, # Title or designation of this site contact.
154 },
155 ],
156 &quot;siteSettings&quot;: { # Site Settings # Site-wide settings.
157 &quot;activeViewOptOut&quot;: True or False, # Whether active view creatives are disabled for this site.
158 &quot;adBlockingOptOut&quot;: 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.
159 &quot;disableNewCookie&quot;: True or False, # Whether new cookies are disabled for this site.
160 &quot;tagSetting&quot;: { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
161 &quot;additionalKeyValues&quot;: &quot;A String&quot;, # 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.
162 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
163 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
164 &quot;includeUnescapedlpurlMacro&quot;: True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.
165 &quot;keywordOption&quot;: &quot;A String&quot;, # 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.
166 },
167 &quot;videoActiveViewOptOutTemplate&quot;: 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.
168 &quot;vpaidAdapterChoiceTemplate&quot;: &quot;A String&quot;, # 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&#x27;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.
169 },
170 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this site. This is a read-only field that can be left blank.
171 &quot;videoSettings&quot;: { # 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.
172 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
173 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this site template.
174 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
175 { # Represents the dimensions of ads, placements, creatives, or creative assets.
176 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
177 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
178 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
179 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
180 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
181 },
182 ],
183 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
184 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteCompanionSetting&quot;.
185 },
186 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteVideoSettings&quot;.
187 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
188 &quot;obaSettings&quot;: { # 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.
189 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
190 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
191 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
192 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
193 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
194 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
195 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
196 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
197 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
198 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
199 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
200 },
201 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
202 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
203 },
204 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a site template used for video. This will act as default for new placements created under this site.
205 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
206 &quot;skippableSettings&quot;: { # 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.
207 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteSkippableSetting&quot;.
208 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
209 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
210 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
211 },
212 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
213 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
214 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
215 },
216 &quot;skippable&quot;: 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.
217 },
218 &quot;transcodeSettings&quot;: { # 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.
219 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
220 42,
221 ],
222 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteTranscodeSetting&quot;.
223 },
224 },
225 }</pre>
226 </div>
227
228 <div class="method">
229 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
230 <pre>Inserts a new site.
231
232 Args:
233 profileId: string, User profile ID associated with this request. (required)
234 body: object, The request body.
235 The object takes the form of:
236
237 { # Contains properties of a site.
238 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this site. This is a read-only field that can be left blank.
239 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
240 &quot;approved&quot;: True or False, # Whether this site is approved.
241 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site associated with this site. This is a required field that is read-only after insertion.
242 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
243 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
244 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
245 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
246 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
247 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
248 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
249 },
250 &quot;id&quot;: &quot;A String&quot;, # ID of this site. This is a read-only, auto-generated field.
251 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
252 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
253 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
254 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
255 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
256 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
257 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
258 },
259 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this site. This is a read-only, auto-generated field.
260 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#site&quot;.
261 &quot;name&quot;: &quot;A String&quot;, # 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.
262 &quot;siteContacts&quot;: [ # Site contacts.
263 { # Site Contact
264 &quot;address&quot;: &quot;A String&quot;, # Address of this site contact.
265 &quot;contactType&quot;: &quot;A String&quot;, # Site contact type.
266 &quot;email&quot;: &quot;A String&quot;, # Email address of this site contact. This is a required field.
267 &quot;firstName&quot;: &quot;A String&quot;, # First name of this site contact.
268 &quot;id&quot;: &quot;A String&quot;, # ID of this site contact. This is a read-only, auto-generated field.
269 &quot;lastName&quot;: &quot;A String&quot;, # Last name of this site contact.
270 &quot;phone&quot;: &quot;A String&quot;, # Primary phone number of this site contact.
271 &quot;title&quot;: &quot;A String&quot;, # Title or designation of this site contact.
272 },
273 ],
274 &quot;siteSettings&quot;: { # Site Settings # Site-wide settings.
275 &quot;activeViewOptOut&quot;: True or False, # Whether active view creatives are disabled for this site.
276 &quot;adBlockingOptOut&quot;: 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.
277 &quot;disableNewCookie&quot;: True or False, # Whether new cookies are disabled for this site.
278 &quot;tagSetting&quot;: { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
279 &quot;additionalKeyValues&quot;: &quot;A String&quot;, # 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.
280 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
281 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
282 &quot;includeUnescapedlpurlMacro&quot;: True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.
283 &quot;keywordOption&quot;: &quot;A String&quot;, # 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.
284 },
285 &quot;videoActiveViewOptOutTemplate&quot;: 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.
286 &quot;vpaidAdapterChoiceTemplate&quot;: &quot;A String&quot;, # 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&#x27;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.
287 },
288 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this site. This is a read-only field that can be left blank.
289 &quot;videoSettings&quot;: { # 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.
290 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
291 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this site template.
292 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
293 { # Represents the dimensions of ads, placements, creatives, or creative assets.
294 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
295 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
296 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
297 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
298 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
299 },
300 ],
301 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
302 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteCompanionSetting&quot;.
303 },
304 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteVideoSettings&quot;.
305 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
306 &quot;obaSettings&quot;: { # 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.
307 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
308 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
309 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
310 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
311 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
312 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
313 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
314 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
315 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
316 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
317 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
318 },
319 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
320 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
321 },
322 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a site template used for video. This will act as default for new placements created under this site.
323 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
324 &quot;skippableSettings&quot;: { # 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.
325 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteSkippableSetting&quot;.
326 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
327 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
328 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
329 },
330 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
331 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
332 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
333 },
334 &quot;skippable&quot;: 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.
335 },
336 &quot;transcodeSettings&quot;: { # 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.
337 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
338 42,
339 ],
340 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteTranscodeSetting&quot;.
341 },
342 },
343 }
344
345 x__xgafv: string, V1 error format.
346 Allowed values
347 1 - v1 error format
348 2 - v2 error format
349
350 Returns:
351 An object of the form:
352
353 { # Contains properties of a site.
354 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this site. This is a read-only field that can be left blank.
355 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
356 &quot;approved&quot;: True or False, # Whether this site is approved.
357 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site associated with this site. This is a required field that is read-only after insertion.
358 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
359 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
360 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
361 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
362 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
363 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
364 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
365 },
366 &quot;id&quot;: &quot;A String&quot;, # ID of this site. This is a read-only, auto-generated field.
367 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
368 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
369 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
370 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
371 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
372 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
373 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
374 },
375 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this site. This is a read-only, auto-generated field.
376 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#site&quot;.
377 &quot;name&quot;: &quot;A String&quot;, # 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.
378 &quot;siteContacts&quot;: [ # Site contacts.
379 { # Site Contact
380 &quot;address&quot;: &quot;A String&quot;, # Address of this site contact.
381 &quot;contactType&quot;: &quot;A String&quot;, # Site contact type.
382 &quot;email&quot;: &quot;A String&quot;, # Email address of this site contact. This is a required field.
383 &quot;firstName&quot;: &quot;A String&quot;, # First name of this site contact.
384 &quot;id&quot;: &quot;A String&quot;, # ID of this site contact. This is a read-only, auto-generated field.
385 &quot;lastName&quot;: &quot;A String&quot;, # Last name of this site contact.
386 &quot;phone&quot;: &quot;A String&quot;, # Primary phone number of this site contact.
387 &quot;title&quot;: &quot;A String&quot;, # Title or designation of this site contact.
388 },
389 ],
390 &quot;siteSettings&quot;: { # Site Settings # Site-wide settings.
391 &quot;activeViewOptOut&quot;: True or False, # Whether active view creatives are disabled for this site.
392 &quot;adBlockingOptOut&quot;: 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.
393 &quot;disableNewCookie&quot;: True or False, # Whether new cookies are disabled for this site.
394 &quot;tagSetting&quot;: { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
395 &quot;additionalKeyValues&quot;: &quot;A String&quot;, # 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.
396 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
397 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
398 &quot;includeUnescapedlpurlMacro&quot;: True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.
399 &quot;keywordOption&quot;: &quot;A String&quot;, # 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.
400 },
401 &quot;videoActiveViewOptOutTemplate&quot;: 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.
402 &quot;vpaidAdapterChoiceTemplate&quot;: &quot;A String&quot;, # 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&#x27;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.
403 },
404 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this site. This is a read-only field that can be left blank.
405 &quot;videoSettings&quot;: { # 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.
406 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
407 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this site template.
408 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
409 { # Represents the dimensions of ads, placements, creatives, or creative assets.
410 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
411 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
412 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
413 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
414 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
415 },
416 ],
417 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
418 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteCompanionSetting&quot;.
419 },
420 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteVideoSettings&quot;.
421 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
422 &quot;obaSettings&quot;: { # 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.
423 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
424 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
425 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
426 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
427 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
428 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
429 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
430 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
431 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
432 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
433 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
434 },
435 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
436 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
437 },
438 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a site template used for video. This will act as default for new placements created under this site.
439 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
440 &quot;skippableSettings&quot;: { # 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.
441 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteSkippableSetting&quot;.
442 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
443 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
444 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
445 },
446 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
447 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
448 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
449 },
450 &quot;skippable&quot;: 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.
451 },
452 &quot;transcodeSettings&quot;: { # 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.
453 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
454 42,
455 ],
456 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteTranscodeSetting&quot;.
457 },
458 },
459 }</pre>
460 </div>
461
462 <div class="method">
463 <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>
464 <pre>Retrieves a list of sites, possibly filtered. This method supports paging.
465
466 Args:
467 profileId: string, User profile ID associated with this request. (required)
468 acceptsInStreamVideoPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
469 acceptsInterstitialPlacements: boolean, This search filter is no longer supported and will have no effect on the results returned.
470 acceptsPublisherPaidPlacements: boolean, Select only sites that accept publisher paid placements.
471 adWordsSite: boolean, Select only AdWords sites.
472 approved: boolean, Select only approved sites.
473 campaignIds: string, Select only sites with these campaign IDs. (repeated)
474 directorySiteIds: string, Select only sites with these directory site IDs. (repeated)
475 ids: string, Select only sites with these IDs. (repeated)
476 maxResults: integer, Maximum number of results to return.
477 pageToken: string, Value of the nextPageToken from the previous result page.
478 searchString: string, Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, &quot;site*2015&quot; will return objects with names like &quot;site June 2015&quot;, &quot;site April 2015&quot;, or simply &quot;site 2015&quot;. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of &quot;site&quot; will match objects with name &quot;my site&quot;, &quot;site 2015&quot;, or simply &quot;site&quot;.
479 sortField: string, Field by which to sort the list.
480 Allowed values
481 ID -
482 NAME -
483 sortOrder: string, Order of sorted results.
484 Allowed values
485 ASCENDING - Ascending order.
486 DESCENDING - Descending order.
487 subaccountId: string, Select only sites with this subaccount ID.
488 unmappedSite: boolean, Select only sites that have not been mapped to a directory site.
489 x__xgafv: string, V1 error format.
490 Allowed values
491 1 - v1 error format
492 2 - v2 error format
493
494 Returns:
495 An object of the form:
496
497 { # Site List Response
498 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#sitesListResponse&quot;.
499 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
500 &quot;sites&quot;: [ # Site collection.
501 { # Contains properties of a site.
502 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this site. This is a read-only field that can be left blank.
503 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
504 &quot;approved&quot;: True or False, # Whether this site is approved.
505 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site associated with this site. This is a required field that is read-only after insertion.
506 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
507 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
508 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
509 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
510 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
511 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
512 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
513 },
514 &quot;id&quot;: &quot;A String&quot;, # ID of this site. This is a read-only, auto-generated field.
515 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
516 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
517 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
518 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
519 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
520 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
521 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
522 },
523 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this site. This is a read-only, auto-generated field.
524 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#site&quot;.
525 &quot;name&quot;: &quot;A String&quot;, # 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.
526 &quot;siteContacts&quot;: [ # Site contacts.
527 { # Site Contact
528 &quot;address&quot;: &quot;A String&quot;, # Address of this site contact.
529 &quot;contactType&quot;: &quot;A String&quot;, # Site contact type.
530 &quot;email&quot;: &quot;A String&quot;, # Email address of this site contact. This is a required field.
531 &quot;firstName&quot;: &quot;A String&quot;, # First name of this site contact.
532 &quot;id&quot;: &quot;A String&quot;, # ID of this site contact. This is a read-only, auto-generated field.
533 &quot;lastName&quot;: &quot;A String&quot;, # Last name of this site contact.
534 &quot;phone&quot;: &quot;A String&quot;, # Primary phone number of this site contact.
535 &quot;title&quot;: &quot;A String&quot;, # Title or designation of this site contact.
536 },
537 ],
538 &quot;siteSettings&quot;: { # Site Settings # Site-wide settings.
539 &quot;activeViewOptOut&quot;: True or False, # Whether active view creatives are disabled for this site.
540 &quot;adBlockingOptOut&quot;: 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.
541 &quot;disableNewCookie&quot;: True or False, # Whether new cookies are disabled for this site.
542 &quot;tagSetting&quot;: { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
543 &quot;additionalKeyValues&quot;: &quot;A String&quot;, # 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.
544 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
545 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
546 &quot;includeUnescapedlpurlMacro&quot;: True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.
547 &quot;keywordOption&quot;: &quot;A String&quot;, # 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.
548 },
549 &quot;videoActiveViewOptOutTemplate&quot;: 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.
550 &quot;vpaidAdapterChoiceTemplate&quot;: &quot;A String&quot;, # 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&#x27;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.
551 },
552 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this site. This is a read-only field that can be left blank.
553 &quot;videoSettings&quot;: { # 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.
554 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
555 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this site template.
556 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
557 { # Represents the dimensions of ads, placements, creatives, or creative assets.
558 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
559 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
560 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
561 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
562 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
563 },
564 ],
565 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
566 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteCompanionSetting&quot;.
567 },
568 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteVideoSettings&quot;.
569 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
570 &quot;obaSettings&quot;: { # 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.
571 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
572 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
573 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
574 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
575 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
576 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
577 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
578 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
579 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
580 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
581 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
582 },
583 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
584 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
585 },
586 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a site template used for video. This will act as default for new placements created under this site.
587 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
588 &quot;skippableSettings&quot;: { # 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.
589 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteSkippableSetting&quot;.
590 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
591 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
592 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
593 },
594 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
595 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
596 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
597 },
598 &quot;skippable&quot;: 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.
599 },
600 &quot;transcodeSettings&quot;: { # 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.
601 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
602 42,
603 ],
604 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteTranscodeSetting&quot;.
605 },
606 },
607 },
608 ],
609 }</pre>
610 </div>
611
612 <div class="method">
613 <code class="details" id="list_next">list_next()</code>
614 <pre>Retrieves the next page of results.
615
616 Args:
617 previous_request: The request for the previous page. (required)
618 previous_response: The response from the request for the previous page. (required)
619
620 Returns:
621 A request object that you can call &#x27;execute()&#x27; on to request the next
622 page. Returns None if there are no more items in the collection.
623 </pre>
624 </div>
625
626 <div class="method">
627 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
628 <pre>Updates an existing site. This method supports patch semantics.
629
630 Args:
631 profileId: string, User profile ID associated with this request. (required)
632 id: string, Required. Site ID. (required)
633 body: object, The request body.
634 The object takes the form of:
635
636 { # Contains properties of a site.
637 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this site. This is a read-only field that can be left blank.
638 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
639 &quot;approved&quot;: True or False, # Whether this site is approved.
640 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site associated with this site. This is a required field that is read-only after insertion.
641 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
642 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
643 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
644 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
645 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
646 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
647 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
648 },
649 &quot;id&quot;: &quot;A String&quot;, # ID of this site. This is a read-only, auto-generated field.
650 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
651 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
652 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
653 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
654 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
655 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
656 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
657 },
658 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this site. This is a read-only, auto-generated field.
659 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#site&quot;.
660 &quot;name&quot;: &quot;A String&quot;, # 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.
661 &quot;siteContacts&quot;: [ # Site contacts.
662 { # Site Contact
663 &quot;address&quot;: &quot;A String&quot;, # Address of this site contact.
664 &quot;contactType&quot;: &quot;A String&quot;, # Site contact type.
665 &quot;email&quot;: &quot;A String&quot;, # Email address of this site contact. This is a required field.
666 &quot;firstName&quot;: &quot;A String&quot;, # First name of this site contact.
667 &quot;id&quot;: &quot;A String&quot;, # ID of this site contact. This is a read-only, auto-generated field.
668 &quot;lastName&quot;: &quot;A String&quot;, # Last name of this site contact.
669 &quot;phone&quot;: &quot;A String&quot;, # Primary phone number of this site contact.
670 &quot;title&quot;: &quot;A String&quot;, # Title or designation of this site contact.
671 },
672 ],
673 &quot;siteSettings&quot;: { # Site Settings # Site-wide settings.
674 &quot;activeViewOptOut&quot;: True or False, # Whether active view creatives are disabled for this site.
675 &quot;adBlockingOptOut&quot;: 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.
676 &quot;disableNewCookie&quot;: True or False, # Whether new cookies are disabled for this site.
677 &quot;tagSetting&quot;: { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
678 &quot;additionalKeyValues&quot;: &quot;A String&quot;, # 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.
679 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
680 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
681 &quot;includeUnescapedlpurlMacro&quot;: True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.
682 &quot;keywordOption&quot;: &quot;A String&quot;, # 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.
683 },
684 &quot;videoActiveViewOptOutTemplate&quot;: 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.
685 &quot;vpaidAdapterChoiceTemplate&quot;: &quot;A String&quot;, # 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&#x27;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.
686 },
687 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this site. This is a read-only field that can be left blank.
688 &quot;videoSettings&quot;: { # 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.
689 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
690 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this site template.
691 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
692 { # Represents the dimensions of ads, placements, creatives, or creative assets.
693 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
694 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
695 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
696 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
697 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
698 },
699 ],
700 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
701 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteCompanionSetting&quot;.
702 },
703 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteVideoSettings&quot;.
704 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
705 &quot;obaSettings&quot;: { # 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.
706 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
707 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
708 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
709 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
710 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
711 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
712 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
713 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
714 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
715 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
716 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
717 },
718 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
719 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
720 },
721 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a site template used for video. This will act as default for new placements created under this site.
722 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
723 &quot;skippableSettings&quot;: { # 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.
724 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteSkippableSetting&quot;.
725 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
726 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
727 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
728 },
729 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
730 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
731 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
732 },
733 &quot;skippable&quot;: 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.
734 },
735 &quot;transcodeSettings&quot;: { # 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.
736 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
737 42,
738 ],
739 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteTranscodeSetting&quot;.
740 },
741 },
742 }
743
744 x__xgafv: string, V1 error format.
745 Allowed values
746 1 - v1 error format
747 2 - v2 error format
748
749 Returns:
750 An object of the form:
751
752 { # Contains properties of a site.
753 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this site. This is a read-only field that can be left blank.
754 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
755 &quot;approved&quot;: True or False, # Whether this site is approved.
756 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site associated with this site. This is a required field that is read-only after insertion.
757 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
758 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
759 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
760 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
761 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
762 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
763 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
764 },
765 &quot;id&quot;: &quot;A String&quot;, # ID of this site. This is a read-only, auto-generated field.
766 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
767 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
768 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
769 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
770 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
771 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
772 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
773 },
774 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this site. This is a read-only, auto-generated field.
775 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#site&quot;.
776 &quot;name&quot;: &quot;A String&quot;, # 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.
777 &quot;siteContacts&quot;: [ # Site contacts.
778 { # Site Contact
779 &quot;address&quot;: &quot;A String&quot;, # Address of this site contact.
780 &quot;contactType&quot;: &quot;A String&quot;, # Site contact type.
781 &quot;email&quot;: &quot;A String&quot;, # Email address of this site contact. This is a required field.
782 &quot;firstName&quot;: &quot;A String&quot;, # First name of this site contact.
783 &quot;id&quot;: &quot;A String&quot;, # ID of this site contact. This is a read-only, auto-generated field.
784 &quot;lastName&quot;: &quot;A String&quot;, # Last name of this site contact.
785 &quot;phone&quot;: &quot;A String&quot;, # Primary phone number of this site contact.
786 &quot;title&quot;: &quot;A String&quot;, # Title or designation of this site contact.
787 },
788 ],
789 &quot;siteSettings&quot;: { # Site Settings # Site-wide settings.
790 &quot;activeViewOptOut&quot;: True or False, # Whether active view creatives are disabled for this site.
791 &quot;adBlockingOptOut&quot;: 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.
792 &quot;disableNewCookie&quot;: True or False, # Whether new cookies are disabled for this site.
793 &quot;tagSetting&quot;: { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
794 &quot;additionalKeyValues&quot;: &quot;A String&quot;, # 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.
795 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
796 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
797 &quot;includeUnescapedlpurlMacro&quot;: True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.
798 &quot;keywordOption&quot;: &quot;A String&quot;, # 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.
799 },
800 &quot;videoActiveViewOptOutTemplate&quot;: 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.
801 &quot;vpaidAdapterChoiceTemplate&quot;: &quot;A String&quot;, # 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&#x27;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.
802 },
803 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this site. This is a read-only field that can be left blank.
804 &quot;videoSettings&quot;: { # 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.
805 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
806 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this site template.
807 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
808 { # Represents the dimensions of ads, placements, creatives, or creative assets.
809 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
810 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
811 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
812 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
813 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
814 },
815 ],
816 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
817 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteCompanionSetting&quot;.
818 },
819 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteVideoSettings&quot;.
820 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
821 &quot;obaSettings&quot;: { # 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.
822 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
823 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
824 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
825 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
826 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
827 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
828 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
829 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
830 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
831 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
832 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
833 },
834 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
835 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
836 },
837 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a site template used for video. This will act as default for new placements created under this site.
838 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
839 &quot;skippableSettings&quot;: { # 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.
840 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteSkippableSetting&quot;.
841 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
842 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
843 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
844 },
845 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
846 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
847 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
848 },
849 &quot;skippable&quot;: 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.
850 },
851 &quot;transcodeSettings&quot;: { # 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.
852 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
853 42,
854 ],
855 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteTranscodeSetting&quot;.
856 },
857 },
858 }</pre>
859 </div>
860
861 <div class="method">
862 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
863 <pre>Updates an existing site.
864
865 Args:
866 profileId: string, User profile ID associated with this request. (required)
867 body: object, The request body.
868 The object takes the form of:
869
870 { # Contains properties of a site.
871 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this site. This is a read-only field that can be left blank.
872 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
873 &quot;approved&quot;: True or False, # Whether this site is approved.
874 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site associated with this site. This is a required field that is read-only after insertion.
875 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
876 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
877 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
878 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
879 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
880 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
881 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
882 },
883 &quot;id&quot;: &quot;A String&quot;, # ID of this site. This is a read-only, auto-generated field.
884 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
885 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
886 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
887 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
888 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
889 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
890 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
891 },
892 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this site. This is a read-only, auto-generated field.
893 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#site&quot;.
894 &quot;name&quot;: &quot;A String&quot;, # 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.
895 &quot;siteContacts&quot;: [ # Site contacts.
896 { # Site Contact
897 &quot;address&quot;: &quot;A String&quot;, # Address of this site contact.
898 &quot;contactType&quot;: &quot;A String&quot;, # Site contact type.
899 &quot;email&quot;: &quot;A String&quot;, # Email address of this site contact. This is a required field.
900 &quot;firstName&quot;: &quot;A String&quot;, # First name of this site contact.
901 &quot;id&quot;: &quot;A String&quot;, # ID of this site contact. This is a read-only, auto-generated field.
902 &quot;lastName&quot;: &quot;A String&quot;, # Last name of this site contact.
903 &quot;phone&quot;: &quot;A String&quot;, # Primary phone number of this site contact.
904 &quot;title&quot;: &quot;A String&quot;, # Title or designation of this site contact.
905 },
906 ],
907 &quot;siteSettings&quot;: { # Site Settings # Site-wide settings.
908 &quot;activeViewOptOut&quot;: True or False, # Whether active view creatives are disabled for this site.
909 &quot;adBlockingOptOut&quot;: 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.
910 &quot;disableNewCookie&quot;: True or False, # Whether new cookies are disabled for this site.
911 &quot;tagSetting&quot;: { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
912 &quot;additionalKeyValues&quot;: &quot;A String&quot;, # 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.
913 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
914 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
915 &quot;includeUnescapedlpurlMacro&quot;: True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.
916 &quot;keywordOption&quot;: &quot;A String&quot;, # 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.
917 },
918 &quot;videoActiveViewOptOutTemplate&quot;: 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.
919 &quot;vpaidAdapterChoiceTemplate&quot;: &quot;A String&quot;, # 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&#x27;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.
920 },
921 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this site. This is a read-only field that can be left blank.
922 &quot;videoSettings&quot;: { # 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.
923 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
924 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this site template.
925 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
926 { # Represents the dimensions of ads, placements, creatives, or creative assets.
927 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
928 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
929 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
930 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
931 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
932 },
933 ],
934 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
935 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteCompanionSetting&quot;.
936 },
937 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteVideoSettings&quot;.
938 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
939 &quot;obaSettings&quot;: { # 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.
940 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
941 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
942 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
943 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
944 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
945 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
946 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
947 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
948 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
949 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
950 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
951 },
952 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
953 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
954 },
955 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a site template used for video. This will act as default for new placements created under this site.
956 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
957 &quot;skippableSettings&quot;: { # 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.
958 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteSkippableSetting&quot;.
959 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
960 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
961 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
962 },
963 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
964 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
965 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
966 },
967 &quot;skippable&quot;: 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.
968 },
969 &quot;transcodeSettings&quot;: { # 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.
970 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
971 42,
972 ],
973 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteTranscodeSetting&quot;.
974 },
975 },
976 }
977
978 x__xgafv: string, V1 error format.
979 Allowed values
980 1 - v1 error format
981 2 - v2 error format
982
983 Returns:
984 An object of the form:
985
986 { # Contains properties of a site.
987 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this site. This is a read-only field that can be left blank.
988 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv * `23`, AdTheorent * `24`, DeepIntent * `25`, Pulsepoint
989 &quot;approved&quot;: True or False, # Whether this site is approved.
990 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site associated with this site. This is a required field that is read-only after insertion.
991 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
992 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
993 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
994 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
995 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
996 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
997 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
998 },
999 &quot;id&quot;: &quot;A String&quot;, # ID of this site. This is a read-only, auto-generated field.
1000 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this site. This is a read-only, auto-generated field.
1001 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1002 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1003 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1004 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1005 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
1006 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1007 },
1008 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this site. This is a read-only, auto-generated field.
1009 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#site&quot;.
1010 &quot;name&quot;: &quot;A String&quot;, # 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.
1011 &quot;siteContacts&quot;: [ # Site contacts.
1012 { # Site Contact
1013 &quot;address&quot;: &quot;A String&quot;, # Address of this site contact.
1014 &quot;contactType&quot;: &quot;A String&quot;, # Site contact type.
1015 &quot;email&quot;: &quot;A String&quot;, # Email address of this site contact. This is a required field.
1016 &quot;firstName&quot;: &quot;A String&quot;, # First name of this site contact.
1017 &quot;id&quot;: &quot;A String&quot;, # ID of this site contact. This is a read-only, auto-generated field.
1018 &quot;lastName&quot;: &quot;A String&quot;, # Last name of this site contact.
1019 &quot;phone&quot;: &quot;A String&quot;, # Primary phone number of this site contact.
1020 &quot;title&quot;: &quot;A String&quot;, # Title or designation of this site contact.
1021 },
1022 ],
1023 &quot;siteSettings&quot;: { # Site Settings # Site-wide settings.
1024 &quot;activeViewOptOut&quot;: True or False, # Whether active view creatives are disabled for this site.
1025 &quot;adBlockingOptOut&quot;: 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.
1026 &quot;disableNewCookie&quot;: True or False, # Whether new cookies are disabled for this site.
1027 &quot;tagSetting&quot;: { # Tag Settings # Configuration settings for dynamic and image floodlight tags.
1028 &quot;additionalKeyValues&quot;: &quot;A String&quot;, # 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.
1029 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. New placements will default to the value set on their site.
1030 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
1031 &quot;includeUnescapedlpurlMacro&quot;: True or False, # Optional. Indicates that the unescapedlpurl macro should be included in the tag for the static landing page. New placements will default to the value set on their site.
1032 &quot;keywordOption&quot;: &quot;A String&quot;, # 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.
1033 },
1034 &quot;videoActiveViewOptOutTemplate&quot;: 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.
1035 &quot;vpaidAdapterChoiceTemplate&quot;: &quot;A String&quot;, # 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&#x27;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.
1036 },
1037 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this site. This is a read-only field that can be left blank.
1038 &quot;videoSettings&quot;: { # 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.
1039 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this site.
1040 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this site template.
1041 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served via this site template. Set this list to null or empty to serve all companion sizes.
1042 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1043 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1044 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1045 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1046 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1047 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1048 },
1049 ],
1050 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
1051 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteCompanionSetting&quot;.
1052 },
1053 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteVideoSettings&quot;.
1054 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
1055 &quot;obaSettings&quot;: { # 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.
1056 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
1057 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
1058 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
1059 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
1060 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
1061 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
1062 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1063 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1064 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1065 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1066 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1067 },
1068 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
1069 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
1070 },
1071 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a site template used for video. This will act as default for new placements created under this site.
1072 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max
1073 &quot;skippableSettings&quot;: { # 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.
1074 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteSkippableSetting&quot;.
1075 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this site template before counting a view. Applicable when skippable is true.
1076 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
1077 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1078 },
1079 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this site before the skip button should appear. Applicable when skippable is true.
1080 &quot;offsetPercentage&quot;: 42, # Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive.
1081 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1082 },
1083 &quot;skippable&quot;: 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.
1084 },
1085 &quot;transcodeSettings&quot;: { # 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.
1086 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this site template. Set this list to null or empty to serve all video formats.
1087 42,
1088 ],
1089 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#siteTranscodeSetting&quot;.
1090 },
1091 },
1092 }</pre>
1093 </div>
1094
1095 </body></html>