Debian Codegraph @

docs/dyn/dfareporting_v4.placements.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_v4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v4.placements.html">placements</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="#generatetags">generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Generates tags for a placement.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets one placement by ID.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Inserts a new placement.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(profileId, activeStatus=None, advertiserIds=None, campaignIds=None, compatibilities=None, contentCategoryIds=None, directorySiteIds=None, groupIds=None, ids=None, maxEndDate=None, maxResults=None, maxStartDate=None, minEndDate=None, minStartDate=None, pageToken=None, paymentSource=None, placementStrategyIds=None, pricingTypes=None, searchString=None, siteIds=None, sizeIds=None, sortField=None, sortOrder=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Retrieves a list of placements, possibly filtered. This method supports paging.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates an existing placement. This method supports patch semantics.</p>
98 <p class="toc_element">
99 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p>
100 <p class="firstline">Updates an existing placement.</p>
101 <h3>Method Details</h3>
102 <div class="method">
103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105 </div>
106
107 <div class="method">
108 <code class="details" id="generatetags">generatetags(profileId, campaignId=None, placementIds=None, tagFormats=None, x__xgafv=None)</code>
109 <pre>Generates tags for a placement.
110
111 Args:
112 profileId: string, User profile ID associated with this request. (required)
113 campaignId: string, Generate placements belonging to this campaign. This is a required field.
114 placementIds: string, Generate tags for these placements. (repeated)
115 tagFormats: string, Tag formats to generate for these placements. *Note:* PLACEMENT_TAG_STANDARD can only be generated for 1x1 placements. (repeated)
116 Allowed values
117 PLACEMENT_TAG_STANDARD -
118 PLACEMENT_TAG_IFRAME_JAVASCRIPT -
119 PLACEMENT_TAG_IFRAME_ILAYER -
120 PLACEMENT_TAG_INTERNAL_REDIRECT -
121 PLACEMENT_TAG_JAVASCRIPT -
122 PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT -
123 PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT -
124 PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT -
125 PLACEMENT_TAG_CLICK_COMMANDS -
126 PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH -
127 PLACEMENT_TAG_TRACKING -
128 PLACEMENT_TAG_TRACKING_IFRAME -
129 PLACEMENT_TAG_TRACKING_JAVASCRIPT -
130 PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3 -
131 PLACEMENT_TAG_IFRAME_JAVASCRIPT_LEGACY -
132 PLACEMENT_TAG_JAVASCRIPT_LEGACY -
133 PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT_LEGACY -
134 PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT_LEGACY -
135 PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4 -
136 PLACEMENT_TAG_TRACKING_THIRD_PARTY_MEASUREMENT -
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142 Returns:
143 An object of the form:
144
145 { # Placement GenerateTags Response
146 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementsGenerateTagsResponse&quot;.
147 &quot;placementTags&quot;: [ # Set of generated tags for the specified placements.
148 { # Placement Tag
149 &quot;placementId&quot;: &quot;A String&quot;, # Placement ID
150 &quot;tagDatas&quot;: [ # Tags generated for this placement.
151 { # Placement Tag Data
152 &quot;adId&quot;: &quot;A String&quot;, # Ad associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.
153 &quot;clickTag&quot;: &quot;A String&quot;, # Tag string to record a click.
154 &quot;creativeId&quot;: &quot;A String&quot;, # Creative associated with this placement tag. Applicable only when format is PLACEMENT_TAG_TRACKING.
155 &quot;format&quot;: &quot;A String&quot;, # TagData tag format of this tag.
156 &quot;impressionTag&quot;: &quot;A String&quot;, # Tag string for serving an ad.
157 },
158 ],
159 },
160 ],
161 }</pre>
162 </div>
163
164 <div class="method">
165 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code>
166 <pre>Gets one placement by ID.
167
168 Args:
169 profileId: string, User profile ID associated with this request. (required)
170 id: string, Placement ID. (required)
171 x__xgafv: string, V1 error format.
172 Allowed values
173 1 - v1 error format
174 2 - v2 error format
175
176 Returns:
177 An object of the form:
178
179 { # Contains properties of a placement.
180 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
181 &quot;activeStatus&quot;: &quot;A String&quot;, # Whether this placement is active, inactive, archived or permanently archived.
182 &quot;adBlockingOptOut&quot;: True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
183 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. 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
184 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
185 { # Represents the dimensions of ads, placements, creatives, or creative assets.
186 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
187 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
188 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
189 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
190 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
191 },
192 ],
193 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
194 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
195 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
196 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
197 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
198 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
199 &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.
200 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
201 },
202 &quot;allowOnYoutube&quot;: True or False, # Optional. Whether the placement is enabled for YouTube integration.
203 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
204 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
205 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
206 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
207 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
208 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
209 &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.
210 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
211 },
212 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
213 &quot;compatibility&quot;: &quot;A String&quot;, # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
214 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
215 &quot;conversionDomainOverride&quot;: { # Optional. Conversion domain overrides for a placement.
216 &quot;conversionDomains&quot;: [
217 {
218 &quot;conversionDomainId&quot;: &quot;A String&quot;,
219 &quot;conversionDomainValue&quot;: &quot;A String&quot;,
220 },
221 ],
222 },
223 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
224 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
225 },
226 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
227 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
228 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
229 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
230 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
231 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
232 &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.
233 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
234 },
235 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
236 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
237 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
238 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
239 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
240 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
241 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
242 &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.
243 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
244 },
245 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
246 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
247 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
248 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
249 },
250 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
251 &quot;clickDuration&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
252 &quot;postImpressionActivitiesDuration&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
253 },
254 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 512 characters long.
255 &quot;partnerWrappingData&quot;: { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
256 &quot;linkStatus&quot;: &quot;A String&quot;, # Placement wrapping status.
257 &quot;measurementPartner&quot;: &quot;A String&quot;, # Measurement partner used for wrapping the placement.
258 &quot;tagWrappingMode&quot;: &quot;A String&quot;, # Measurement mode for the wrapped placement.
259 &quot;wrappedTag&quot;: &quot;A String&quot;, # Tag provided by the measurement partner during wrapping.
260 },
261 &quot;paymentApproved&quot;: True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
262 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
263 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
264 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
265 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
266 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
267 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
268 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
269 &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.
270 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
271 },
272 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
273 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
274 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
275 &quot;endDate&quot;: &quot;A String&quot;,
276 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
277 &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
278 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
279 { # Pricing Period
280 &quot;endDate&quot;: &quot;A String&quot;,
281 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
282 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
283 &quot;startDate&quot;: &quot;A String&quot;,
284 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
285 },
286 ],
287 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
288 &quot;startDate&quot;: &quot;A String&quot;,
289 &quot;testingStartDate&quot;: &quot;A String&quot;,
290 },
291 &quot;primary&quot;: True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock&#x27;s primaryPlacementId field to the ID of this placement.
292 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
293 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
294 },
295 &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
296 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
297 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
298 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
299 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
300 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
301 &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.
302 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
303 },
304 &quot;siteServed&quot;: True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.
305 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
306 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
307 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
308 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
309 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
310 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
311 },
312 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
313 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
314 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
315 &quot;tagFormats&quot;: [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - &quot;PLACEMENT_TAG_STANDARD&quot; - &quot;PLACEMENT_TAG_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_IFRAME_ILAYER&quot; - &quot;PLACEMENT_TAG_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_CLICK_COMMANDS&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4&quot; - &quot;PLACEMENT_TAG_TRACKING&quot; - &quot;PLACEMENT_TAG_TRACKING_IFRAME&quot; - &quot;PLACEMENT_TAG_TRACKING_JAVASCRIPT&quot;
316 &quot;A String&quot;,
317 ],
318 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
319 &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.
320 &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.
321 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
322 &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.
323 &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.
324 },
325 &quot;videoActiveViewOptOut&quot;: True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
326 &quot;videoSettings&quot;: { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
327 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
328 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
329 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
330 { # Represents the dimensions of ads, placements, creatives, or creative assets.
331 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
332 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
333 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
334 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
335 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
336 },
337 ],
338 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
339 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
340 },
341 &quot;durationSeconds&quot;: 42, # Duration of a video placement in seconds.
342 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
343 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
344 &quot;obaSettings&quot;: { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
345 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
346 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
347 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
348 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
349 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
350 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
351 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
352 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
353 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
354 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
355 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
356 },
357 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
358 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
359 },
360 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
361 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID of a video placement. 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
362 &quot;skippableSettings&quot;: { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
363 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
364 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
365 &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.
366 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
367 },
368 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
369 &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.
370 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
371 },
372 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
373 },
374 &quot;transcodeSettings&quot;: { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
375 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
376 42,
377 ],
378 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
379 },
380 },
381 &quot;vpaidAdapterChoice&quot;: &quot;A String&quot;, # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
382 &quot;wrappingOptOut&quot;: True or False, # Whether this placement opts out of tag wrapping.
383 &quot;youtubeSettings&quot;: { # Contains the YouTube settings. # Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field.
384 &quot;businessLogoCreativeIds&quot;: [ # Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.
385 &quot;A String&quot;,
386 ],
387 &quot;businessName&quot;: &quot;A String&quot;, # Optional. The business name.
388 &quot;callToActions&quot;: [ # Optional. The call to actions. Currently only one call to action is supported.
389 &quot;A String&quot;,
390 ],
391 &quot;descriptions&quot;: [ # Optional. The descriptions. Currently only one description is supported.
392 &quot;A String&quot;,
393 ],
394 &quot;headlines&quot;: [ # Optional. The headlines associated with the call to actions. Currently only one headline is supported.
395 &quot;A String&quot;,
396 ],
397 &quot;longHeadlines&quot;: [ # Optional. The long headlines. Currently only one long headline is supported.
398 &quot;A String&quot;,
399 ],
400 },
401 }</pre>
402 </div>
403
404 <div class="method">
405 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
406 <pre>Inserts a new placement.
407
408 Args:
409 profileId: string, User profile ID associated with this request. (required)
410 body: object, The request body.
411 The object takes the form of:
412
413 { # Contains properties of a placement.
414 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
415 &quot;activeStatus&quot;: &quot;A String&quot;, # Whether this placement is active, inactive, archived or permanently archived.
416 &quot;adBlockingOptOut&quot;: True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
417 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. 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
418 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
419 { # Represents the dimensions of ads, placements, creatives, or creative assets.
420 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
421 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
422 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
423 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
424 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
425 },
426 ],
427 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
428 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
429 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
430 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
431 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
432 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
433 &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.
434 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
435 },
436 &quot;allowOnYoutube&quot;: True or False, # Optional. Whether the placement is enabled for YouTube integration.
437 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
438 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
439 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
440 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
441 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
442 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
443 &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.
444 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
445 },
446 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
447 &quot;compatibility&quot;: &quot;A String&quot;, # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
448 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
449 &quot;conversionDomainOverride&quot;: { # Optional. Conversion domain overrides for a placement.
450 &quot;conversionDomains&quot;: [
451 {
452 &quot;conversionDomainId&quot;: &quot;A String&quot;,
453 &quot;conversionDomainValue&quot;: &quot;A String&quot;,
454 },
455 ],
456 },
457 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
458 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
459 },
460 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
461 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
462 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
463 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
464 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
465 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
466 &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.
467 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
468 },
469 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
470 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
471 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
472 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
473 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
474 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
475 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
476 &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.
477 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
478 },
479 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
480 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
481 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
482 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
483 },
484 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
485 &quot;clickDuration&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
486 &quot;postImpressionActivitiesDuration&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
487 },
488 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 512 characters long.
489 &quot;partnerWrappingData&quot;: { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
490 &quot;linkStatus&quot;: &quot;A String&quot;, # Placement wrapping status.
491 &quot;measurementPartner&quot;: &quot;A String&quot;, # Measurement partner used for wrapping the placement.
492 &quot;tagWrappingMode&quot;: &quot;A String&quot;, # Measurement mode for the wrapped placement.
493 &quot;wrappedTag&quot;: &quot;A String&quot;, # Tag provided by the measurement partner during wrapping.
494 },
495 &quot;paymentApproved&quot;: True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
496 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
497 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
498 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
499 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
500 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
501 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
502 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
503 &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.
504 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
505 },
506 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
507 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
508 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
509 &quot;endDate&quot;: &quot;A String&quot;,
510 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
511 &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
512 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
513 { # Pricing Period
514 &quot;endDate&quot;: &quot;A String&quot;,
515 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
516 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
517 &quot;startDate&quot;: &quot;A String&quot;,
518 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
519 },
520 ],
521 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
522 &quot;startDate&quot;: &quot;A String&quot;,
523 &quot;testingStartDate&quot;: &quot;A String&quot;,
524 },
525 &quot;primary&quot;: True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock&#x27;s primaryPlacementId field to the ID of this placement.
526 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
527 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
528 },
529 &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
530 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
531 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
532 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
533 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
534 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
535 &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.
536 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
537 },
538 &quot;siteServed&quot;: True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.
539 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
540 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
541 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
542 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
543 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
544 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
545 },
546 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
547 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
548 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
549 &quot;tagFormats&quot;: [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - &quot;PLACEMENT_TAG_STANDARD&quot; - &quot;PLACEMENT_TAG_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_IFRAME_ILAYER&quot; - &quot;PLACEMENT_TAG_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_CLICK_COMMANDS&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4&quot; - &quot;PLACEMENT_TAG_TRACKING&quot; - &quot;PLACEMENT_TAG_TRACKING_IFRAME&quot; - &quot;PLACEMENT_TAG_TRACKING_JAVASCRIPT&quot;
550 &quot;A String&quot;,
551 ],
552 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
553 &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.
554 &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.
555 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
556 &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.
557 &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.
558 },
559 &quot;videoActiveViewOptOut&quot;: True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
560 &quot;videoSettings&quot;: { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
561 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
562 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
563 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
564 { # Represents the dimensions of ads, placements, creatives, or creative assets.
565 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
566 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
567 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
568 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
569 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
570 },
571 ],
572 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
573 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
574 },
575 &quot;durationSeconds&quot;: 42, # Duration of a video placement in seconds.
576 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
577 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
578 &quot;obaSettings&quot;: { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
579 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
580 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
581 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
582 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
583 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
584 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
585 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
586 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
587 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
588 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
589 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
590 },
591 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
592 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
593 },
594 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
595 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID of a video placement. 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
596 &quot;skippableSettings&quot;: { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
597 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
598 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
599 &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.
600 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
601 },
602 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
603 &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.
604 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
605 },
606 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
607 },
608 &quot;transcodeSettings&quot;: { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
609 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
610 42,
611 ],
612 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
613 },
614 },
615 &quot;vpaidAdapterChoice&quot;: &quot;A String&quot;, # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
616 &quot;wrappingOptOut&quot;: True or False, # Whether this placement opts out of tag wrapping.
617 &quot;youtubeSettings&quot;: { # Contains the YouTube settings. # Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field.
618 &quot;businessLogoCreativeIds&quot;: [ # Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.
619 &quot;A String&quot;,
620 ],
621 &quot;businessName&quot;: &quot;A String&quot;, # Optional. The business name.
622 &quot;callToActions&quot;: [ # Optional. The call to actions. Currently only one call to action is supported.
623 &quot;A String&quot;,
624 ],
625 &quot;descriptions&quot;: [ # Optional. The descriptions. Currently only one description is supported.
626 &quot;A String&quot;,
627 ],
628 &quot;headlines&quot;: [ # Optional. The headlines associated with the call to actions. Currently only one headline is supported.
629 &quot;A String&quot;,
630 ],
631 &quot;longHeadlines&quot;: [ # Optional. The long headlines. Currently only one long headline is supported.
632 &quot;A String&quot;,
633 ],
634 },
635 }
636
637 x__xgafv: string, V1 error format.
638 Allowed values
639 1 - v1 error format
640 2 - v2 error format
641
642 Returns:
643 An object of the form:
644
645 { # Contains properties of a placement.
646 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
647 &quot;activeStatus&quot;: &quot;A String&quot;, # Whether this placement is active, inactive, archived or permanently archived.
648 &quot;adBlockingOptOut&quot;: True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
649 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. 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
650 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
651 { # Represents the dimensions of ads, placements, creatives, or creative assets.
652 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
653 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
654 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
655 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
656 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
657 },
658 ],
659 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
660 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
661 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
662 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
663 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
664 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
665 &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.
666 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
667 },
668 &quot;allowOnYoutube&quot;: True or False, # Optional. Whether the placement is enabled for YouTube integration.
669 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
670 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
671 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
672 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
673 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
674 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
675 &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.
676 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
677 },
678 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
679 &quot;compatibility&quot;: &quot;A String&quot;, # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
680 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
681 &quot;conversionDomainOverride&quot;: { # Optional. Conversion domain overrides for a placement.
682 &quot;conversionDomains&quot;: [
683 {
684 &quot;conversionDomainId&quot;: &quot;A String&quot;,
685 &quot;conversionDomainValue&quot;: &quot;A String&quot;,
686 },
687 ],
688 },
689 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
690 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
691 },
692 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
693 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
694 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
695 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
696 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
697 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
698 &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.
699 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
700 },
701 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
702 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
703 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
704 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
705 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
706 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
707 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
708 &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.
709 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
710 },
711 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
712 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
713 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
714 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
715 },
716 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
717 &quot;clickDuration&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
718 &quot;postImpressionActivitiesDuration&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
719 },
720 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 512 characters long.
721 &quot;partnerWrappingData&quot;: { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
722 &quot;linkStatus&quot;: &quot;A String&quot;, # Placement wrapping status.
723 &quot;measurementPartner&quot;: &quot;A String&quot;, # Measurement partner used for wrapping the placement.
724 &quot;tagWrappingMode&quot;: &quot;A String&quot;, # Measurement mode for the wrapped placement.
725 &quot;wrappedTag&quot;: &quot;A String&quot;, # Tag provided by the measurement partner during wrapping.
726 },
727 &quot;paymentApproved&quot;: True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
728 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
729 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
730 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
731 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
732 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
733 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
734 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
735 &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.
736 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
737 },
738 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
739 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
740 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
741 &quot;endDate&quot;: &quot;A String&quot;,
742 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
743 &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
744 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
745 { # Pricing Period
746 &quot;endDate&quot;: &quot;A String&quot;,
747 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
748 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
749 &quot;startDate&quot;: &quot;A String&quot;,
750 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
751 },
752 ],
753 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
754 &quot;startDate&quot;: &quot;A String&quot;,
755 &quot;testingStartDate&quot;: &quot;A String&quot;,
756 },
757 &quot;primary&quot;: True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock&#x27;s primaryPlacementId field to the ID of this placement.
758 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
759 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
760 },
761 &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
762 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
763 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
764 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
765 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
766 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
767 &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.
768 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
769 },
770 &quot;siteServed&quot;: True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.
771 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
772 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
773 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
774 &quot;id&quot;: &quot;A String&quot;, # ID of this size. 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#size&quot;.
776 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
777 },
778 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
779 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
780 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
781 &quot;tagFormats&quot;: [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - &quot;PLACEMENT_TAG_STANDARD&quot; - &quot;PLACEMENT_TAG_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_IFRAME_ILAYER&quot; - &quot;PLACEMENT_TAG_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_CLICK_COMMANDS&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4&quot; - &quot;PLACEMENT_TAG_TRACKING&quot; - &quot;PLACEMENT_TAG_TRACKING_IFRAME&quot; - &quot;PLACEMENT_TAG_TRACKING_JAVASCRIPT&quot;
782 &quot;A String&quot;,
783 ],
784 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
785 &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.
786 &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.
787 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
788 &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.
789 &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.
790 },
791 &quot;videoActiveViewOptOut&quot;: True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
792 &quot;videoSettings&quot;: { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
793 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
794 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
795 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
796 { # Represents the dimensions of ads, placements, creatives, or creative assets.
797 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
798 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
799 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
800 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
801 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
802 },
803 ],
804 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
805 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
806 },
807 &quot;durationSeconds&quot;: 42, # Duration of a video placement in seconds.
808 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
809 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
810 &quot;obaSettings&quot;: { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
811 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
812 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
813 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
814 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
815 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
816 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
817 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
818 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
819 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
820 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
821 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
822 },
823 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
824 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
825 },
826 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
827 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID of a video placement. 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
828 &quot;skippableSettings&quot;: { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
829 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
830 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
831 &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.
832 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
833 },
834 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
835 &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.
836 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
837 },
838 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
839 },
840 &quot;transcodeSettings&quot;: { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
841 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
842 42,
843 ],
844 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
845 },
846 },
847 &quot;vpaidAdapterChoice&quot;: &quot;A String&quot;, # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
848 &quot;wrappingOptOut&quot;: True or False, # Whether this placement opts out of tag wrapping.
849 &quot;youtubeSettings&quot;: { # Contains the YouTube settings. # Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field.
850 &quot;businessLogoCreativeIds&quot;: [ # Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.
851 &quot;A String&quot;,
852 ],
853 &quot;businessName&quot;: &quot;A String&quot;, # Optional. The business name.
854 &quot;callToActions&quot;: [ # Optional. The call to actions. Currently only one call to action is supported.
855 &quot;A String&quot;,
856 ],
857 &quot;descriptions&quot;: [ # Optional. The descriptions. Currently only one description is supported.
858 &quot;A String&quot;,
859 ],
860 &quot;headlines&quot;: [ # Optional. The headlines associated with the call to actions. Currently only one headline is supported.
861 &quot;A String&quot;,
862 ],
863 &quot;longHeadlines&quot;: [ # Optional. The long headlines. Currently only one long headline is supported.
864 &quot;A String&quot;,
865 ],
866 },
867 }</pre>
868 </div>
869
870 <div class="method">
871 <code class="details" id="list">list(profileId, activeStatus=None, advertiserIds=None, campaignIds=None, compatibilities=None, contentCategoryIds=None, directorySiteIds=None, groupIds=None, ids=None, maxEndDate=None, maxResults=None, maxStartDate=None, minEndDate=None, minStartDate=None, pageToken=None, paymentSource=None, placementStrategyIds=None, pricingTypes=None, searchString=None, siteIds=None, sizeIds=None, sortField=None, sortOrder=None, x__xgafv=None)</code>
872 <pre>Retrieves a list of placements, possibly filtered. This method supports paging.
873
874 Args:
875 profileId: string, User profile ID associated with this request. (required)
876 activeStatus: string, Select only placements with these active statuses. (repeated)
877 Allowed values
878 PLACEMENT_STATUS_UNKNOWN -
879 PLACEMENT_STATUS_ACTIVE -
880 PLACEMENT_STATUS_INACTIVE -
881 PLACEMENT_STATUS_ARCHIVED -
882 PLACEMENT_STATUS_PERMANENTLY_ARCHIVED -
883 advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
884 campaignIds: string, Select only placements that belong to these campaigns. (repeated)
885 compatibilities: string, Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. (repeated)
886 Allowed values
887 DISPLAY -
888 DISPLAY_INTERSTITIAL -
889 APP - Deprecated enum value. No longer supported.
890 APP_INTERSTITIAL - Deprecated enum value. No longer supported.
891 IN_STREAM_VIDEO -
892 IN_STREAM_AUDIO -
893 contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
894 directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
895 groupIds: string, Select only placements that belong to these placement groups. (repeated)
896 ids: string, Select only placements with these IDs. (repeated)
897 maxEndDate: string, Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as &quot;yyyy-MM-dd&quot;.
898 maxResults: integer, Maximum number of results to return.
899 maxStartDate: string, Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as &quot;yyyy-MM-dd&quot;.
900 minEndDate: string, Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as &quot;yyyy-MM-dd&quot;.
901 minStartDate: string, Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as &quot;yyyy-MM-dd&quot;.
902 pageToken: string, Value of the nextPageToken from the previous result page.
903 paymentSource: string, Select only placements with this payment source.
904 Allowed values
905 PLACEMENT_AGENCY_PAID -
906 PLACEMENT_PUBLISHER_PAID -
907 placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
908 pricingTypes: string, Select only placements with these pricing types. (repeated)
909 Allowed values
910 PRICING_TYPE_CPM -
911 PRICING_TYPE_CPC -
912 PRICING_TYPE_CPA -
913 PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
914 PRICING_TYPE_FLAT_RATE_CLICKS -
915 PRICING_TYPE_CPM_ACTIVEVIEW -
916 searchString: string, Allows searching for placements by name or ID. Wildcards (*) are allowed. For example, &quot;placement*2015&quot; will return placements with names like &quot;placement June 2015&quot;, &quot;placement May 2015&quot;, or simply &quot;placements 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;placement&quot; will match placements with name &quot;my placement&quot;, &quot;placement 2015&quot;, or simply &quot;placement&quot; .
917 siteIds: string, Select only placements that are associated with these sites. (repeated)
918 sizeIds: string, Select only placements that are associated with these sizes. (repeated)
919 sortField: string, Field by which to sort the list.
920 Allowed values
921 ID -
922 NAME -
923 sortOrder: string, Order of sorted results.
924 Allowed values
925 ASCENDING - Ascending order.
926 DESCENDING - Descending order.
927 x__xgafv: string, V1 error format.
928 Allowed values
929 1 - v1 error format
930 2 - v2 error format
931
932 Returns:
933 An object of the form:
934
935 { # Placement List Response
936 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementsListResponse&quot;.
937 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
938 &quot;placements&quot;: [ # Placement collection.
939 { # Contains properties of a placement.
940 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
941 &quot;activeStatus&quot;: &quot;A String&quot;, # Whether this placement is active, inactive, archived or permanently archived.
942 &quot;adBlockingOptOut&quot;: True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
943 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. 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
944 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
945 { # Represents the dimensions of ads, placements, creatives, or creative assets.
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 ],
953 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
954 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
955 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
956 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
957 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
958 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
959 &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.
960 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
961 },
962 &quot;allowOnYoutube&quot;: True or False, # Optional. Whether the placement is enabled for YouTube integration.
963 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
964 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
965 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
966 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
967 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
968 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
969 &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.
970 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
971 },
972 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
973 &quot;compatibility&quot;: &quot;A String&quot;, # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
974 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
975 &quot;conversionDomainOverride&quot;: { # Optional. Conversion domain overrides for a placement.
976 &quot;conversionDomains&quot;: [
977 {
978 &quot;conversionDomainId&quot;: &quot;A String&quot;,
979 &quot;conversionDomainValue&quot;: &quot;A String&quot;,
980 },
981 ],
982 },
983 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
984 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
985 },
986 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
987 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
988 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
989 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
990 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
991 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
992 &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.
993 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
994 },
995 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
996 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
997 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
998 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
999 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1000 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1001 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1002 &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.
1003 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1004 },
1005 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
1006 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
1007 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
1008 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1009 },
1010 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
1011 &quot;clickDuration&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1012 &quot;postImpressionActivitiesDuration&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1013 },
1014 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 512 characters long.
1015 &quot;partnerWrappingData&quot;: { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
1016 &quot;linkStatus&quot;: &quot;A String&quot;, # Placement wrapping status.
1017 &quot;measurementPartner&quot;: &quot;A String&quot;, # Measurement partner used for wrapping the placement.
1018 &quot;tagWrappingMode&quot;: &quot;A String&quot;, # Measurement mode for the wrapped placement.
1019 &quot;wrappedTag&quot;: &quot;A String&quot;, # Tag provided by the measurement partner during wrapping.
1020 },
1021 &quot;paymentApproved&quot;: True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
1022 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
1023 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
1024 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
1025 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1026 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1027 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1028 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1029 &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.
1030 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1031 },
1032 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
1033 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
1034 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
1035 &quot;endDate&quot;: &quot;A String&quot;,
1036 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
1037 &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
1038 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
1039 { # Pricing Period
1040 &quot;endDate&quot;: &quot;A String&quot;,
1041 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
1042 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
1043 &quot;startDate&quot;: &quot;A String&quot;,
1044 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
1045 },
1046 ],
1047 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
1048 &quot;startDate&quot;: &quot;A String&quot;,
1049 &quot;testingStartDate&quot;: &quot;A String&quot;,
1050 },
1051 &quot;primary&quot;: True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock&#x27;s primaryPlacementId field to the ID of this placement.
1052 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
1053 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1054 },
1055 &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
1056 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
1057 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1058 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1059 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1060 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1061 &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.
1062 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1063 },
1064 &quot;siteServed&quot;: True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.
1065 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
1066 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1067 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1068 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1069 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1070 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1071 },
1072 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
1073 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
1074 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
1075 &quot;tagFormats&quot;: [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - &quot;PLACEMENT_TAG_STANDARD&quot; - &quot;PLACEMENT_TAG_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_IFRAME_ILAYER&quot; - &quot;PLACEMENT_TAG_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_CLICK_COMMANDS&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4&quot; - &quot;PLACEMENT_TAG_TRACKING&quot; - &quot;PLACEMENT_TAG_TRACKING_IFRAME&quot; - &quot;PLACEMENT_TAG_TRACKING_JAVASCRIPT&quot;
1076 &quot;A String&quot;,
1077 ],
1078 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
1079 &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.
1080 &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.
1081 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
1082 &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.
1083 &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.
1084 },
1085 &quot;videoActiveViewOptOut&quot;: True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
1086 &quot;videoSettings&quot;: { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
1087 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
1088 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
1089 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
1090 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1091 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1092 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1093 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1094 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1095 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1096 },
1097 ],
1098 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
1099 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
1100 },
1101 &quot;durationSeconds&quot;: 42, # Duration of a video placement in seconds.
1102 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
1103 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
1104 &quot;obaSettings&quot;: { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
1105 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
1106 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
1107 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
1108 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
1109 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
1110 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
1111 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1112 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1113 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1114 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1115 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1116 },
1117 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
1118 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
1119 },
1120 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
1121 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID of a video placement. 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
1122 &quot;skippableSettings&quot;: { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
1123 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
1124 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
1125 &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.
1126 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1127 },
1128 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
1129 &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.
1130 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1131 },
1132 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
1133 },
1134 &quot;transcodeSettings&quot;: { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
1135 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
1136 42,
1137 ],
1138 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
1139 },
1140 },
1141 &quot;vpaidAdapterChoice&quot;: &quot;A String&quot;, # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
1142 &quot;wrappingOptOut&quot;: True or False, # Whether this placement opts out of tag wrapping.
1143 &quot;youtubeSettings&quot;: { # Contains the YouTube settings. # Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field.
1144 &quot;businessLogoCreativeIds&quot;: [ # Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.
1145 &quot;A String&quot;,
1146 ],
1147 &quot;businessName&quot;: &quot;A String&quot;, # Optional. The business name.
1148 &quot;callToActions&quot;: [ # Optional. The call to actions. Currently only one call to action is supported.
1149 &quot;A String&quot;,
1150 ],
1151 &quot;descriptions&quot;: [ # Optional. The descriptions. Currently only one description is supported.
1152 &quot;A String&quot;,
1153 ],
1154 &quot;headlines&quot;: [ # Optional. The headlines associated with the call to actions. Currently only one headline is supported.
1155 &quot;A String&quot;,
1156 ],
1157 &quot;longHeadlines&quot;: [ # Optional. The long headlines. Currently only one long headline is supported.
1158 &quot;A String&quot;,
1159 ],
1160 },
1161 },
1162 ],
1163 }</pre>
1164 </div>
1165
1166 <div class="method">
1167 <code class="details" id="list_next">list_next()</code>
1168 <pre>Retrieves the next page of results.
1169
1170 Args:
1171 previous_request: The request for the previous page. (required)
1172 previous_response: The response from the request for the previous page. (required)
1173
1174 Returns:
1175 A request object that you can call &#x27;execute()&#x27; on to request the next
1176 page. Returns None if there are no more items in the collection.
1177 </pre>
1178 </div>
1179
1180 <div class="method">
1181 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
1182 <pre>Updates an existing placement. This method supports patch semantics.
1183
1184 Args:
1185 profileId: string, User profile ID associated with this request. (required)
1186 id: string, Required. Placement ID. (required)
1187 body: object, The request body.
1188 The object takes the form of:
1189
1190 { # Contains properties of a placement.
1191 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
1192 &quot;activeStatus&quot;: &quot;A String&quot;, # Whether this placement is active, inactive, archived or permanently archived.
1193 &quot;adBlockingOptOut&quot;: True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
1194 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. 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
1195 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
1196 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1197 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1198 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1199 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1200 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1201 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1202 },
1203 ],
1204 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
1205 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
1206 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1207 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1208 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1209 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1210 &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.
1211 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1212 },
1213 &quot;allowOnYoutube&quot;: True or False, # Optional. Whether the placement is enabled for YouTube integration.
1214 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
1215 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
1216 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1217 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1218 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1219 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1220 &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.
1221 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1222 },
1223 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
1224 &quot;compatibility&quot;: &quot;A String&quot;, # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
1225 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
1226 &quot;conversionDomainOverride&quot;: { # Optional. Conversion domain overrides for a placement.
1227 &quot;conversionDomains&quot;: [
1228 {
1229 &quot;conversionDomainId&quot;: &quot;A String&quot;,
1230 &quot;conversionDomainValue&quot;: &quot;A String&quot;,
1231 },
1232 ],
1233 },
1234 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
1235 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1236 },
1237 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
1238 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
1239 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1240 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1241 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1242 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1243 &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.
1244 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1245 },
1246 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
1247 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
1248 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
1249 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1250 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1251 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1252 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1253 &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.
1254 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1255 },
1256 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
1257 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
1258 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
1259 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1260 },
1261 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
1262 &quot;clickDuration&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1263 &quot;postImpressionActivitiesDuration&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1264 },
1265 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 512 characters long.
1266 &quot;partnerWrappingData&quot;: { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
1267 &quot;linkStatus&quot;: &quot;A String&quot;, # Placement wrapping status.
1268 &quot;measurementPartner&quot;: &quot;A String&quot;, # Measurement partner used for wrapping the placement.
1269 &quot;tagWrappingMode&quot;: &quot;A String&quot;, # Measurement mode for the wrapped placement.
1270 &quot;wrappedTag&quot;: &quot;A String&quot;, # Tag provided by the measurement partner during wrapping.
1271 },
1272 &quot;paymentApproved&quot;: True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
1273 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
1274 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
1275 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
1276 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1277 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1278 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1279 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1280 &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.
1281 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1282 },
1283 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
1284 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
1285 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
1286 &quot;endDate&quot;: &quot;A String&quot;,
1287 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
1288 &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
1289 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
1290 { # Pricing Period
1291 &quot;endDate&quot;: &quot;A String&quot;,
1292 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
1293 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
1294 &quot;startDate&quot;: &quot;A String&quot;,
1295 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
1296 },
1297 ],
1298 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
1299 &quot;startDate&quot;: &quot;A String&quot;,
1300 &quot;testingStartDate&quot;: &quot;A String&quot;,
1301 },
1302 &quot;primary&quot;: True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock&#x27;s primaryPlacementId field to the ID of this placement.
1303 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
1304 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1305 },
1306 &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
1307 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
1308 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1309 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1310 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1311 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1312 &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.
1313 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1314 },
1315 &quot;siteServed&quot;: True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.
1316 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
1317 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1318 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1319 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1320 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1321 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1322 },
1323 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
1324 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
1325 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
1326 &quot;tagFormats&quot;: [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - &quot;PLACEMENT_TAG_STANDARD&quot; - &quot;PLACEMENT_TAG_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_IFRAME_ILAYER&quot; - &quot;PLACEMENT_TAG_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_CLICK_COMMANDS&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4&quot; - &quot;PLACEMENT_TAG_TRACKING&quot; - &quot;PLACEMENT_TAG_TRACKING_IFRAME&quot; - &quot;PLACEMENT_TAG_TRACKING_JAVASCRIPT&quot;
1327 &quot;A String&quot;,
1328 ],
1329 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
1330 &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.
1331 &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.
1332 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
1333 &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.
1334 &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.
1335 },
1336 &quot;videoActiveViewOptOut&quot;: True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
1337 &quot;videoSettings&quot;: { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
1338 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
1339 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
1340 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
1341 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1342 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1343 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1344 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1345 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1346 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1347 },
1348 ],
1349 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
1350 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
1351 },
1352 &quot;durationSeconds&quot;: 42, # Duration of a video placement in seconds.
1353 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
1354 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
1355 &quot;obaSettings&quot;: { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
1356 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
1357 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
1358 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
1359 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
1360 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
1361 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
1362 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1363 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1364 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1365 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1366 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1367 },
1368 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
1369 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
1370 },
1371 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
1372 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID of a video placement. 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
1373 &quot;skippableSettings&quot;: { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
1374 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
1375 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
1376 &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.
1377 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1378 },
1379 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
1380 &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.
1381 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1382 },
1383 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
1384 },
1385 &quot;transcodeSettings&quot;: { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
1386 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
1387 42,
1388 ],
1389 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
1390 },
1391 },
1392 &quot;vpaidAdapterChoice&quot;: &quot;A String&quot;, # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
1393 &quot;wrappingOptOut&quot;: True or False, # Whether this placement opts out of tag wrapping.
1394 &quot;youtubeSettings&quot;: { # Contains the YouTube settings. # Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field.
1395 &quot;businessLogoCreativeIds&quot;: [ # Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.
1396 &quot;A String&quot;,
1397 ],
1398 &quot;businessName&quot;: &quot;A String&quot;, # Optional. The business name.
1399 &quot;callToActions&quot;: [ # Optional. The call to actions. Currently only one call to action is supported.
1400 &quot;A String&quot;,
1401 ],
1402 &quot;descriptions&quot;: [ # Optional. The descriptions. Currently only one description is supported.
1403 &quot;A String&quot;,
1404 ],
1405 &quot;headlines&quot;: [ # Optional. The headlines associated with the call to actions. Currently only one headline is supported.
1406 &quot;A String&quot;,
1407 ],
1408 &quot;longHeadlines&quot;: [ # Optional. The long headlines. Currently only one long headline is supported.
1409 &quot;A String&quot;,
1410 ],
1411 },
1412 }
1413
1414 x__xgafv: string, V1 error format.
1415 Allowed values
1416 1 - v1 error format
1417 2 - v2 error format
1418
1419 Returns:
1420 An object of the form:
1421
1422 { # Contains properties of a placement.
1423 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
1424 &quot;activeStatus&quot;: &quot;A String&quot;, # Whether this placement is active, inactive, archived or permanently archived.
1425 &quot;adBlockingOptOut&quot;: True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
1426 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. 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
1427 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
1428 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1429 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1430 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1431 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1432 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1433 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1434 },
1435 ],
1436 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
1437 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
1438 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1439 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1440 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1441 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1442 &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.
1443 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1444 },
1445 &quot;allowOnYoutube&quot;: True or False, # Optional. Whether the placement is enabled for YouTube integration.
1446 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
1447 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
1448 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1449 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1450 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1451 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1452 &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.
1453 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1454 },
1455 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
1456 &quot;compatibility&quot;: &quot;A String&quot;, # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
1457 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
1458 &quot;conversionDomainOverride&quot;: { # Optional. Conversion domain overrides for a placement.
1459 &quot;conversionDomains&quot;: [
1460 {
1461 &quot;conversionDomainId&quot;: &quot;A String&quot;,
1462 &quot;conversionDomainValue&quot;: &quot;A String&quot;,
1463 },
1464 ],
1465 },
1466 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
1467 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1468 },
1469 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
1470 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
1471 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1472 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1473 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1474 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1475 &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.
1476 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1477 },
1478 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
1479 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
1480 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
1481 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1482 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1483 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1484 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1485 &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.
1486 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1487 },
1488 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
1489 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
1490 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
1491 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1492 },
1493 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
1494 &quot;clickDuration&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1495 &quot;postImpressionActivitiesDuration&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1496 },
1497 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 512 characters long.
1498 &quot;partnerWrappingData&quot;: { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
1499 &quot;linkStatus&quot;: &quot;A String&quot;, # Placement wrapping status.
1500 &quot;measurementPartner&quot;: &quot;A String&quot;, # Measurement partner used for wrapping the placement.
1501 &quot;tagWrappingMode&quot;: &quot;A String&quot;, # Measurement mode for the wrapped placement.
1502 &quot;wrappedTag&quot;: &quot;A String&quot;, # Tag provided by the measurement partner during wrapping.
1503 },
1504 &quot;paymentApproved&quot;: True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
1505 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
1506 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
1507 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
1508 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1509 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1510 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1511 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1512 &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.
1513 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1514 },
1515 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
1516 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
1517 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
1518 &quot;endDate&quot;: &quot;A String&quot;,
1519 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
1520 &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
1521 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
1522 { # Pricing Period
1523 &quot;endDate&quot;: &quot;A String&quot;,
1524 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
1525 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
1526 &quot;startDate&quot;: &quot;A String&quot;,
1527 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
1528 },
1529 ],
1530 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
1531 &quot;startDate&quot;: &quot;A String&quot;,
1532 &quot;testingStartDate&quot;: &quot;A String&quot;,
1533 },
1534 &quot;primary&quot;: True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock&#x27;s primaryPlacementId field to the ID of this placement.
1535 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
1536 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1537 },
1538 &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
1539 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
1540 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1541 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1542 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1543 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1544 &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.
1545 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1546 },
1547 &quot;siteServed&quot;: True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.
1548 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
1549 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1550 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1551 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1552 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1553 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1554 },
1555 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
1556 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
1557 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
1558 &quot;tagFormats&quot;: [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - &quot;PLACEMENT_TAG_STANDARD&quot; - &quot;PLACEMENT_TAG_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_IFRAME_ILAYER&quot; - &quot;PLACEMENT_TAG_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_CLICK_COMMANDS&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4&quot; - &quot;PLACEMENT_TAG_TRACKING&quot; - &quot;PLACEMENT_TAG_TRACKING_IFRAME&quot; - &quot;PLACEMENT_TAG_TRACKING_JAVASCRIPT&quot;
1559 &quot;A String&quot;,
1560 ],
1561 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
1562 &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.
1563 &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.
1564 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
1565 &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.
1566 &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.
1567 },
1568 &quot;videoActiveViewOptOut&quot;: True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
1569 &quot;videoSettings&quot;: { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
1570 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
1571 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
1572 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
1573 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1574 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1575 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1576 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1577 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1578 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1579 },
1580 ],
1581 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
1582 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
1583 },
1584 &quot;durationSeconds&quot;: 42, # Duration of a video placement in seconds.
1585 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
1586 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
1587 &quot;obaSettings&quot;: { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
1588 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
1589 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
1590 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
1591 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
1592 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
1593 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
1594 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1595 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1596 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1597 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1598 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1599 },
1600 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
1601 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
1602 },
1603 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
1604 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID of a video placement. 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
1605 &quot;skippableSettings&quot;: { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
1606 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
1607 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
1608 &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.
1609 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1610 },
1611 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
1612 &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.
1613 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1614 },
1615 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
1616 },
1617 &quot;transcodeSettings&quot;: { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
1618 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
1619 42,
1620 ],
1621 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
1622 },
1623 },
1624 &quot;vpaidAdapterChoice&quot;: &quot;A String&quot;, # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
1625 &quot;wrappingOptOut&quot;: True or False, # Whether this placement opts out of tag wrapping.
1626 &quot;youtubeSettings&quot;: { # Contains the YouTube settings. # Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field.
1627 &quot;businessLogoCreativeIds&quot;: [ # Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.
1628 &quot;A String&quot;,
1629 ],
1630 &quot;businessName&quot;: &quot;A String&quot;, # Optional. The business name.
1631 &quot;callToActions&quot;: [ # Optional. The call to actions. Currently only one call to action is supported.
1632 &quot;A String&quot;,
1633 ],
1634 &quot;descriptions&quot;: [ # Optional. The descriptions. Currently only one description is supported.
1635 &quot;A String&quot;,
1636 ],
1637 &quot;headlines&quot;: [ # Optional. The headlines associated with the call to actions. Currently only one headline is supported.
1638 &quot;A String&quot;,
1639 ],
1640 &quot;longHeadlines&quot;: [ # Optional. The long headlines. Currently only one long headline is supported.
1641 &quot;A String&quot;,
1642 ],
1643 },
1644 }</pre>
1645 </div>
1646
1647 <div class="method">
1648 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
1649 <pre>Updates an existing placement.
1650
1651 Args:
1652 profileId: string, User profile ID associated with this request. (required)
1653 body: object, The request body.
1654 The object takes the form of:
1655
1656 { # Contains properties of a placement.
1657 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
1658 &quot;activeStatus&quot;: &quot;A String&quot;, # Whether this placement is active, inactive, archived or permanently archived.
1659 &quot;adBlockingOptOut&quot;: True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
1660 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. 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
1661 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
1662 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1663 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1664 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1665 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1666 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1667 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1668 },
1669 ],
1670 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
1671 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
1672 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1673 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1674 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1675 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1676 &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.
1677 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1678 },
1679 &quot;allowOnYoutube&quot;: True or False, # Optional. Whether the placement is enabled for YouTube integration.
1680 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
1681 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
1682 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1683 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1684 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1685 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1686 &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.
1687 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1688 },
1689 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
1690 &quot;compatibility&quot;: &quot;A String&quot;, # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
1691 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
1692 &quot;conversionDomainOverride&quot;: { # Optional. Conversion domain overrides for a placement.
1693 &quot;conversionDomains&quot;: [
1694 {
1695 &quot;conversionDomainId&quot;: &quot;A String&quot;,
1696 &quot;conversionDomainValue&quot;: &quot;A String&quot;,
1697 },
1698 ],
1699 },
1700 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
1701 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1702 },
1703 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
1704 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
1705 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1706 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1707 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1708 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1709 &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.
1710 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1711 },
1712 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
1713 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
1714 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
1715 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1716 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1717 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1718 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1719 &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.
1720 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1721 },
1722 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
1723 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
1724 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
1725 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1726 },
1727 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
1728 &quot;clickDuration&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1729 &quot;postImpressionActivitiesDuration&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1730 },
1731 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 512 characters long.
1732 &quot;partnerWrappingData&quot;: { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
1733 &quot;linkStatus&quot;: &quot;A String&quot;, # Placement wrapping status.
1734 &quot;measurementPartner&quot;: &quot;A String&quot;, # Measurement partner used for wrapping the placement.
1735 &quot;tagWrappingMode&quot;: &quot;A String&quot;, # Measurement mode for the wrapped placement.
1736 &quot;wrappedTag&quot;: &quot;A String&quot;, # Tag provided by the measurement partner during wrapping.
1737 },
1738 &quot;paymentApproved&quot;: True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
1739 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
1740 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
1741 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
1742 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1743 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1744 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1745 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1746 &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.
1747 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1748 },
1749 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
1750 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
1751 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
1752 &quot;endDate&quot;: &quot;A String&quot;,
1753 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
1754 &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
1755 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
1756 { # Pricing Period
1757 &quot;endDate&quot;: &quot;A String&quot;,
1758 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
1759 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
1760 &quot;startDate&quot;: &quot;A String&quot;,
1761 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
1762 },
1763 ],
1764 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
1765 &quot;startDate&quot;: &quot;A String&quot;,
1766 &quot;testingStartDate&quot;: &quot;A String&quot;,
1767 },
1768 &quot;primary&quot;: True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock&#x27;s primaryPlacementId field to the ID of this placement.
1769 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
1770 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1771 },
1772 &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
1773 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
1774 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1775 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1776 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1777 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1778 &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.
1779 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1780 },
1781 &quot;siteServed&quot;: True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.
1782 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
1783 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1784 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1785 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1786 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1787 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1788 },
1789 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
1790 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
1791 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
1792 &quot;tagFormats&quot;: [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - &quot;PLACEMENT_TAG_STANDARD&quot; - &quot;PLACEMENT_TAG_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_IFRAME_ILAYER&quot; - &quot;PLACEMENT_TAG_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_CLICK_COMMANDS&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4&quot; - &quot;PLACEMENT_TAG_TRACKING&quot; - &quot;PLACEMENT_TAG_TRACKING_IFRAME&quot; - &quot;PLACEMENT_TAG_TRACKING_JAVASCRIPT&quot;
1793 &quot;A String&quot;,
1794 ],
1795 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
1796 &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.
1797 &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.
1798 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
1799 &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.
1800 &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.
1801 },
1802 &quot;videoActiveViewOptOut&quot;: True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
1803 &quot;videoSettings&quot;: { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
1804 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
1805 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
1806 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
1807 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1808 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1809 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1810 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1811 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1812 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1813 },
1814 ],
1815 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
1816 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
1817 },
1818 &quot;durationSeconds&quot;: 42, # Duration of a video placement in seconds.
1819 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
1820 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
1821 &quot;obaSettings&quot;: { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
1822 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
1823 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
1824 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
1825 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
1826 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
1827 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
1828 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1829 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1830 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1831 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1832 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1833 },
1834 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
1835 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
1836 },
1837 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
1838 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID of a video placement. 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
1839 &quot;skippableSettings&quot;: { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
1840 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
1841 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
1842 &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.
1843 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1844 },
1845 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
1846 &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.
1847 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1848 },
1849 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
1850 },
1851 &quot;transcodeSettings&quot;: { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
1852 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
1853 42,
1854 ],
1855 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
1856 },
1857 },
1858 &quot;vpaidAdapterChoice&quot;: &quot;A String&quot;, # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
1859 &quot;wrappingOptOut&quot;: True or False, # Whether this placement opts out of tag wrapping.
1860 &quot;youtubeSettings&quot;: { # Contains the YouTube settings. # Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field.
1861 &quot;businessLogoCreativeIds&quot;: [ # Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.
1862 &quot;A String&quot;,
1863 ],
1864 &quot;businessName&quot;: &quot;A String&quot;, # Optional. The business name.
1865 &quot;callToActions&quot;: [ # Optional. The call to actions. Currently only one call to action is supported.
1866 &quot;A String&quot;,
1867 ],
1868 &quot;descriptions&quot;: [ # Optional. The descriptions. Currently only one description is supported.
1869 &quot;A String&quot;,
1870 ],
1871 &quot;headlines&quot;: [ # Optional. The headlines associated with the call to actions. Currently only one headline is supported.
1872 &quot;A String&quot;,
1873 ],
1874 &quot;longHeadlines&quot;: [ # Optional. The long headlines. Currently only one long headline is supported.
1875 &quot;A String&quot;,
1876 ],
1877 },
1878 }
1879
1880 x__xgafv: string, V1 error format.
1881 Allowed values
1882 1 - v1 error format
1883 2 - v2 error format
1884
1885 Returns:
1886 An object of the form:
1887
1888 { # Contains properties of a placement.
1889 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
1890 &quot;activeStatus&quot;: &quot;A String&quot;, # Whether this placement is active, inactive, archived or permanently archived.
1891 &quot;adBlockingOptOut&quot;: True or False, # Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.
1892 &quot;adServingPlatformId&quot;: &quot;A String&quot;, # Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. 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
1893 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
1894 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1895 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1896 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1897 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1898 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1899 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1900 },
1901 ],
1902 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
1903 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
1904 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1905 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1906 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1907 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1908 &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.
1909 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1910 },
1911 &quot;allowOnYoutube&quot;: True or False, # Optional. Whether the placement is enabled for YouTube integration.
1912 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
1913 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
1914 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1915 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1916 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1917 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1918 &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.
1919 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1920 },
1921 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
1922 &quot;compatibility&quot;: &quot;A String&quot;, # Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion.
1923 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
1924 &quot;conversionDomainOverride&quot;: { # Optional. Conversion domain overrides for a placement.
1925 &quot;conversionDomains&quot;: [
1926 {
1927 &quot;conversionDomainId&quot;: &quot;A String&quot;,
1928 &quot;conversionDomainValue&quot;: &quot;A String&quot;,
1929 },
1930 ],
1931 },
1932 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
1933 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1934 },
1935 &quot;directorySiteId&quot;: &quot;A String&quot;, # Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
1936 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
1937 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1938 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1939 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1940 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1941 &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.
1942 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1943 },
1944 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
1945 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
1946 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
1947 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1948 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1949 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1950 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1951 &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.
1952 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1953 },
1954 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
1955 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
1956 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
1957 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1958 },
1959 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
1960 &quot;clickDuration&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1961 &quot;postImpressionActivitiesDuration&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
1962 },
1963 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 512 characters long.
1964 &quot;partnerWrappingData&quot;: { # Placement tag wrapping # Measurement partner provided settings for a wrapped placement.
1965 &quot;linkStatus&quot;: &quot;A String&quot;, # Placement wrapping status.
1966 &quot;measurementPartner&quot;: &quot;A String&quot;, # Measurement partner used for wrapping the placement.
1967 &quot;tagWrappingMode&quot;: &quot;A String&quot;, # Measurement mode for the wrapped placement.
1968 &quot;wrappedTag&quot;: &quot;A String&quot;, # Tag provided by the measurement partner during wrapping.
1969 },
1970 &quot;paymentApproved&quot;: True or False, # Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements.
1971 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
1972 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
1973 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
1974 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1975 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1976 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1977 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1978 &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.
1979 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1980 },
1981 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
1982 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
1983 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
1984 &quot;endDate&quot;: &quot;A String&quot;,
1985 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
1986 &quot;floodlightActivityId&quot;: &quot;A String&quot;, # Floodlight activity ID associated with this placement. This field should be set when placement pricing type is set to PRICING_TYPE_CPA.
1987 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
1988 { # Pricing Period
1989 &quot;endDate&quot;: &quot;A String&quot;,
1990 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
1991 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multiplied by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
1992 &quot;startDate&quot;: &quot;A String&quot;,
1993 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
1994 },
1995 ],
1996 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
1997 &quot;startDate&quot;: &quot;A String&quot;,
1998 &quot;testingStartDate&quot;: &quot;A String&quot;,
1999 },
2000 &quot;primary&quot;: True or False, # Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock&#x27;s primaryPlacementId field to the ID of this placement.
2001 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
2002 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
2003 },
2004 &quot;siteId&quot;: &quot;A String&quot;, # Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion.
2005 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
2006 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
2007 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
2008 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
2009 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
2010 &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.
2011 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
2012 },
2013 &quot;siteServed&quot;: True or False, # Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.
2014 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion.
2015 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
2016 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
2017 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
2018 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
2019 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
2020 },
2021 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
2022 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
2023 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
2024 &quot;tagFormats&quot;: [ # Tag formats to generate for this placement. This field is required on insertion. Acceptable values are: - &quot;PLACEMENT_TAG_STANDARD&quot; - &quot;PLACEMENT_TAG_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_IFRAME_ILAYER&quot; - &quot;PLACEMENT_TAG_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT&quot; - &quot;PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT&quot; - &quot;PLACEMENT_TAG_CLICK_COMMANDS&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_3&quot; - &quot;PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4&quot; - &quot;PLACEMENT_TAG_TRACKING&quot; - &quot;PLACEMENT_TAG_TRACKING_IFRAME&quot; - &quot;PLACEMENT_TAG_TRACKING_JAVASCRIPT&quot;
2025 &quot;A String&quot;,
2026 ],
2027 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
2028 &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.
2029 &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.
2030 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
2031 &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.
2032 &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.
2033 },
2034 &quot;videoActiveViewOptOut&quot;: True or False, # Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites.siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView.
2035 &quot;videoSettings&quot;: { # Video Settings # A collection of settings which affect video creatives served through this placement. Applicable to placements with IN_STREAM_VIDEO compatibility.
2036 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
2037 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
2038 &quot;enabledSizes&quot;: [ # Allowlist of companion sizes to be served to this placement. Set this list to null or empty to serve all companion sizes.
2039 { # Represents the dimensions of ads, placements, creatives, or creative assets.
2040 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
2041 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
2042 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
2043 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
2044 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
2045 },
2046 ],
2047 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
2048 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
2049 },
2050 &quot;durationSeconds&quot;: 42, # Duration of a video placement in seconds.
2051 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
2052 &quot;obaEnabled&quot;: True or False, # Whether OBA icons are enabled for this placement.
2053 &quot;obaSettings&quot;: { # Online Behavioral Advertiser icon. # Settings for the OBA icon of video creatives served to this placement. If this object is provided, the creative-level OBA settings will be overridden.
2054 &quot;iconClickThroughUrl&quot;: &quot;A String&quot;, # URL to redirect to when an OBA icon is clicked.
2055 &quot;iconClickTrackingUrl&quot;: &quot;A String&quot;, # URL to track click when an OBA icon is clicked.
2056 &quot;iconViewTrackingUrl&quot;: &quot;A String&quot;, # URL to track view when an OBA icon is clicked.
2057 &quot;program&quot;: &quot;A String&quot;, # Identifies the industry initiative that the icon supports. For example, AdChoices.
2058 &quot;resourceUrl&quot;: &quot;A String&quot;, # OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more
2059 &quot;size&quot;: { # Represents the dimensions of ads, placements, creatives, or creative assets. # OBA icon size.
2060 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
2061 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
2062 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
2063 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
2064 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
2065 },
2066 &quot;xPosition&quot;: &quot;A String&quot;, # OBA icon x coordinate position. Accepted values are left or right.
2067 &quot;yPosition&quot;: &quot;A String&quot;, # OBA icon y coordinate position. Accepted values are top or bottom.
2068 },
2069 &quot;orientation&quot;: &quot;A String&quot;, # Orientation of a video placement. If this value is set, placement will return assets matching the specified orientation.
2070 &quot;publisherSpecificationId&quot;: &quot;A String&quot;, # Publisher specification ID of a video placement. 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
2071 &quot;skippableSettings&quot;: { # Skippable Settings # Settings for the skippability of video creatives served to this placement. If this object is provided, the creative-level skippable settings will be overridden.
2072 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
2073 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
2074 &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.
2075 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
2076 },
2077 &quot;skipOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before the skip button should appear. Applicable when skippable is true.
2078 &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.
2079 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
2080 },
2081 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
2082 },
2083 &quot;transcodeSettings&quot;: { # Transcode Settings # Settings for the transcodes of video creatives served to this placement. If this object is provided, the creative-level transcode settings will be overridden.
2084 &quot;enabledVideoFormats&quot;: [ # Allowlist of video formats to be served to this placement. Set this list to null or empty to serve all video formats.
2085 42,
2086 ],
2087 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
2088 },
2089 },
2090 &quot;vpaidAdapterChoice&quot;: &quot;A String&quot;, # VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. *Note:* Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH.
2091 &quot;wrappingOptOut&quot;: True or False, # Whether this placement opts out of tag wrapping.
2092 &quot;youtubeSettings&quot;: { # Contains the YouTube settings. # Optional. YouTube settings for the placement. The placement must be enabled for YouTube to use this field.
2093 &quot;businessLogoCreativeIds&quot;: [ # Optional. The IDs of the creatives to use for the business logo. Currently only one creative is supported.
2094 &quot;A String&quot;,
2095 ],
2096 &quot;businessName&quot;: &quot;A String&quot;, # Optional. The business name.
2097 &quot;callToActions&quot;: [ # Optional. The call to actions. Currently only one call to action is supported.
2098 &quot;A String&quot;,
2099 ],
2100 &quot;descriptions&quot;: [ # Optional. The descriptions. Currently only one description is supported.
2101 &quot;A String&quot;,
2102 ],
2103 &quot;headlines&quot;: [ # Optional. The headlines associated with the call to actions. Currently only one headline is supported.
2104 &quot;A String&quot;,
2105 ],
2106 &quot;longHeadlines&quot;: [ # Optional. The long headlines. Currently only one long headline is supported.
2107 &quot;A String&quot;,
2108 ],
2109 },
2110 }</pre>
2111 </div>
2112
2113 </body></html>