Debian Codegraph @

docs/dyn/dfareporting_v3_3.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_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.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, advertiserIds=None, archived=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(previous_request, previous_response)</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;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.
182 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
183 { # Represents the dimensions of ads, placements, creatives, or creative assets.
184 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
185 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
186 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
187 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
188 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
189 },
190 ],
191 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
192 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
193 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
194 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
195 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
196 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
197 &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.
198 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
199 },
200 &quot;archived&quot;: True or False, # Whether this placement is archived.
201 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
202 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
203 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
204 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
205 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
206 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
207 &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.
208 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
209 },
210 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
211 &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.
212 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
213 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
214 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
215 },
216 &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.
217 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
218 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
219 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
220 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
221 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
222 &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.
223 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
224 },
225 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
226 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
227 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. 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;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
236 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
237 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
238 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
239 },
240 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
241 &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.
242 &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.
243 },
244 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
245 &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.
246 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
247 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
248 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
249 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
250 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
251 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
252 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
253 &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.
254 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
255 },
256 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
257 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
258 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
259 &quot;disregardOverdelivery&quot;: True or False, # Whether cap costs are ignored by ad serving.
260 &quot;endDate&quot;: &quot;A String&quot;,
261 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
262 &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.
263 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
264 { # Pricing Period
265 &quot;endDate&quot;: &quot;A String&quot;,
266 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
267 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
268 &quot;startDate&quot;: &quot;A String&quot;,
269 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
270 },
271 ],
272 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
273 &quot;startDate&quot;: &quot;A String&quot;,
274 &quot;testingStartDate&quot;: &quot;A String&quot;,
275 },
276 &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.
277 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
278 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
279 },
280 &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.
281 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
282 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
283 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
284 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
285 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
286 &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.
287 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
288 },
289 &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.
290 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
291 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
292 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
293 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
294 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
295 },
296 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
297 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
298 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
299 &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;
300 &quot;A String&quot;,
301 ],
302 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
303 &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.
304 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
305 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
306 &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.
307 },
308 &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.
309 &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.
310 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
311 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
312 &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.
313 { # Represents the dimensions of ads, placements, creatives, or creative assets.
314 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
315 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
316 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
317 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
318 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
319 },
320 ],
321 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
322 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
323 },
324 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
325 &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.
326 &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.
327 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
328 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
329 &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.
330 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
331 },
332 &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.
333 &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.
334 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
335 },
336 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
337 },
338 &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.
339 &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.
340 42,
341 ],
342 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
343 },
344 },
345 &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.
346 }</pre>
347 </div>
348
349 <div class="method">
350 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code>
351 <pre>Inserts a new placement.
352
353 Args:
354 profileId: string, User profile ID associated with this request. (required)
355 body: object, The request body.
356 The object takes the form of:
357
358 { # Contains properties of a placement.
359 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
360 &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.
361 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
362 { # Represents the dimensions of ads, placements, creatives, or creative assets.
363 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
364 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
365 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
366 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
367 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
368 },
369 ],
370 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
371 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
372 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
373 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
374 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
375 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
376 &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.
377 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
378 },
379 &quot;archived&quot;: True or False, # Whether this placement is archived.
380 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
381 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
382 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
383 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
384 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
385 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
386 &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.
387 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
388 },
389 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
390 &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.
391 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
392 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
393 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
394 },
395 &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.
396 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
397 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
398 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
399 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
400 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
401 &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.
402 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
403 },
404 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
405 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
406 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
407 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
408 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
409 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
410 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
411 &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.
412 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
413 },
414 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
415 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
416 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
417 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
418 },
419 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
420 &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.
421 &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.
422 },
423 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
424 &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.
425 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
426 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
427 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
428 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
429 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
430 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
431 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
432 &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.
433 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
434 },
435 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
436 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
437 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
438 &quot;disregardOverdelivery&quot;: True or False, # Whether cap costs are ignored by ad serving.
439 &quot;endDate&quot;: &quot;A String&quot;,
440 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
441 &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.
442 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
443 { # Pricing Period
444 &quot;endDate&quot;: &quot;A String&quot;,
445 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
446 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
447 &quot;startDate&quot;: &quot;A String&quot;,
448 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
449 },
450 ],
451 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
452 &quot;startDate&quot;: &quot;A String&quot;,
453 &quot;testingStartDate&quot;: &quot;A String&quot;,
454 },
455 &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.
456 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
457 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
458 },
459 &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.
460 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
461 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
462 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
463 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
464 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
465 &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.
466 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
467 },
468 &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.
469 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
470 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
471 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
472 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
473 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
474 },
475 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
476 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
477 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
478 &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;
479 &quot;A String&quot;,
480 ],
481 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
482 &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.
483 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
484 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
485 &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.
486 },
487 &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.
488 &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.
489 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
490 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
491 &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.
492 { # Represents the dimensions of ads, placements, creatives, or creative assets.
493 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
494 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
495 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
496 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
497 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
498 },
499 ],
500 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
501 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
502 },
503 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
504 &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.
505 &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.
506 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
507 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
508 &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.
509 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
510 },
511 &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.
512 &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.
513 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
514 },
515 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
516 },
517 &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.
518 &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.
519 42,
520 ],
521 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
522 },
523 },
524 &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.
525 }
526
527 x__xgafv: string, V1 error format.
528 Allowed values
529 1 - v1 error format
530 2 - v2 error format
531
532 Returns:
533 An object of the form:
534
535 { # Contains properties of a placement.
536 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
537 &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.
538 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
539 { # Represents the dimensions of ads, placements, creatives, or creative assets.
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 ],
547 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
548 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
549 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
550 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
551 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
552 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
553 &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.
554 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
555 },
556 &quot;archived&quot;: True or False, # Whether this placement is archived.
557 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
558 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
559 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
560 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
561 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
562 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
563 &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.
564 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
565 },
566 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
567 &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.
568 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
569 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
570 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
571 },
572 &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.
573 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
574 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
575 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
576 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
577 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
578 &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.
579 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
580 },
581 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
582 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
583 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
584 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
585 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
586 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
587 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
588 &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.
589 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
590 },
591 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
592 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
593 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
594 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
595 },
596 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
597 &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.
598 &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.
599 },
600 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
601 &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.
602 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
603 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
604 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
605 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
606 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
607 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
608 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
609 &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.
610 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
611 },
612 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
613 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
614 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
615 &quot;disregardOverdelivery&quot;: True or False, # Whether cap costs are ignored by ad serving.
616 &quot;endDate&quot;: &quot;A String&quot;,
617 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
618 &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.
619 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
620 { # Pricing Period
621 &quot;endDate&quot;: &quot;A String&quot;,
622 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
623 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
624 &quot;startDate&quot;: &quot;A String&quot;,
625 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
626 },
627 ],
628 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
629 &quot;startDate&quot;: &quot;A String&quot;,
630 &quot;testingStartDate&quot;: &quot;A String&quot;,
631 },
632 &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.
633 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
634 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
635 },
636 &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.
637 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
638 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
639 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
640 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
641 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
642 &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.
643 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
644 },
645 &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.
646 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
647 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
648 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
649 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
650 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
651 },
652 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
653 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
654 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
655 &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;
656 &quot;A String&quot;,
657 ],
658 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
659 &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.
660 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
661 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
662 &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.
663 },
664 &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.
665 &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.
666 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
667 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
668 &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.
669 { # Represents the dimensions of ads, placements, creatives, or creative assets.
670 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
671 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
672 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
673 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
674 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
675 },
676 ],
677 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
678 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
679 },
680 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
681 &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.
682 &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.
683 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
684 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
685 &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.
686 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
687 },
688 &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.
689 &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.
690 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
691 },
692 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
693 },
694 &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.
695 &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.
696 42,
697 ],
698 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
699 },
700 },
701 &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.
702 }</pre>
703 </div>
704
705 <div class="method">
706 <code class="details" id="list">list(profileId, advertiserIds=None, archived=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>
707 <pre>Retrieves a list of placements, possibly filtered. This method supports paging.
708
709 Args:
710 profileId: string, User profile ID associated with this request. (required)
711 advertiserIds: string, Select only placements that belong to these advertisers. (repeated)
712 archived: boolean, Select only archived placements. Don&#x27;t set this field to select both archived and non-archived placements.
713 campaignIds: string, Select only placements that belong to these campaigns. (repeated)
714 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)
715 Allowed values
716 DISPLAY -
717 DISPLAY_INTERSTITIAL -
718 APP -
719 APP_INTERSTITIAL -
720 IN_STREAM_VIDEO -
721 IN_STREAM_AUDIO -
722 contentCategoryIds: string, Select only placements that are associated with these content categories. (repeated)
723 directorySiteIds: string, Select only placements that are associated with these directory sites. (repeated)
724 groupIds: string, Select only placements that belong to these placement groups. (repeated)
725 ids: string, Select only placements with these IDs. (repeated)
726 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;.
727 maxResults: integer, Maximum number of results to return.
728 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;.
729 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;.
730 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;.
731 pageToken: string, Value of the nextPageToken from the previous result page.
732 paymentSource: string, Select only placements with this payment source.
733 Allowed values
734 PLACEMENT_AGENCY_PAID -
735 PLACEMENT_PUBLISHER_PAID -
736 placementStrategyIds: string, Select only placements that are associated with these placement strategies. (repeated)
737 pricingTypes: string, Select only placements with these pricing types. (repeated)
738 Allowed values
739 PRICING_TYPE_CPM -
740 PRICING_TYPE_CPC -
741 PRICING_TYPE_CPA -
742 PRICING_TYPE_FLAT_RATE_IMPRESSIONS -
743 PRICING_TYPE_FLAT_RATE_CLICKS -
744 PRICING_TYPE_CPM_ACTIVEVIEW -
745 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; .
746 siteIds: string, Select only placements that are associated with these sites. (repeated)
747 sizeIds: string, Select only placements that are associated with these sizes. (repeated)
748 sortField: string, Field by which to sort the list.
749 Allowed values
750 ID -
751 NAME -
752 sortOrder: string, Order of sorted results.
753 Allowed values
754 ASCENDING -
755 DESCENDING -
756 x__xgafv: string, V1 error format.
757 Allowed values
758 1 - v1 error format
759 2 - v2 error format
760
761 Returns:
762 An object of the form:
763
764 { # Placement List Response
765 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placementsListResponse&quot;.
766 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token to be used for the next list operation.
767 &quot;placements&quot;: [ # Placement collection.
768 { # Contains properties of a placement.
769 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
770 &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.
771 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
772 { # Represents the dimensions of ads, placements, creatives, or creative assets.
773 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
774 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
775 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
776 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
777 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
778 },
779 ],
780 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
781 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
782 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
783 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
784 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
785 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
786 &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.
787 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
788 },
789 &quot;archived&quot;: True or False, # Whether this placement is archived.
790 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
791 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
792 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
793 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
794 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
795 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
796 &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.
797 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
798 },
799 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
800 &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.
801 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
802 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
803 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
804 },
805 &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.
806 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
807 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
808 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
809 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
810 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
811 &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.
812 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
813 },
814 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
815 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
816 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
817 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
818 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
819 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
820 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
821 &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.
822 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
823 },
824 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
825 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
826 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
827 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
828 },
829 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
830 &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.
831 &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.
832 },
833 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
834 &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.
835 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
836 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
837 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
838 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
839 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
840 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
841 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
842 &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.
843 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
844 },
845 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
846 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
847 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
848 &quot;disregardOverdelivery&quot;: True or False, # Whether cap costs are ignored by ad serving.
849 &quot;endDate&quot;: &quot;A String&quot;,
850 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
851 &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.
852 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
853 { # Pricing Period
854 &quot;endDate&quot;: &quot;A String&quot;,
855 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
856 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
857 &quot;startDate&quot;: &quot;A String&quot;,
858 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
859 },
860 ],
861 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
862 &quot;startDate&quot;: &quot;A String&quot;,
863 &quot;testingStartDate&quot;: &quot;A String&quot;,
864 },
865 &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.
866 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
867 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
868 },
869 &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.
870 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
871 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
872 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
873 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
874 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
875 &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.
876 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
877 },
878 &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.
879 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
880 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
881 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
882 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
883 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
884 },
885 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
886 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
887 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
888 &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;
889 &quot;A String&quot;,
890 ],
891 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
892 &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.
893 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
894 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
895 &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.
896 },
897 &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.
898 &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.
899 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
900 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
901 &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.
902 { # Represents the dimensions of ads, placements, creatives, or creative assets.
903 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
904 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
905 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
906 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
907 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
908 },
909 ],
910 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
911 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
912 },
913 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
914 &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.
915 &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.
916 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
917 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
918 &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.
919 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
920 },
921 &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.
922 &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.
923 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
924 },
925 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
926 },
927 &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.
928 &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.
929 42,
930 ],
931 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
932 },
933 },
934 &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.
935 },
936 ],
937 }</pre>
938 </div>
939
940 <div class="method">
941 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
942 <pre>Retrieves the next page of results.
943
944 Args:
945 previous_request: The request for the previous page. (required)
946 previous_response: The response from the request for the previous page. (required)
947
948 Returns:
949 A request object that you can call &#x27;execute()&#x27; on to request the next
950 page. Returns None if there are no more items in the collection.
951 </pre>
952 </div>
953
954 <div class="method">
955 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code>
956 <pre>Updates an existing placement. This method supports patch semantics.
957
958 Args:
959 profileId: string, User profile ID associated with this request. (required)
960 id: string, Placement ID. (required)
961 body: object, The request body.
962 The object takes the form of:
963
964 { # Contains properties of a placement.
965 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
966 &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.
967 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
968 { # Represents the dimensions of ads, placements, creatives, or creative assets.
969 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
970 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
971 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
972 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
973 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
974 },
975 ],
976 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
977 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
978 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
979 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
980 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
981 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
982 &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.
983 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
984 },
985 &quot;archived&quot;: True or False, # Whether this placement is archived.
986 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
987 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. 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;comment&quot;: &quot;A String&quot;, # Comments for this placement.
996 &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.
997 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
998 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
999 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1000 },
1001 &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.
1002 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
1003 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1004 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1005 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1006 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1007 &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.
1008 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1009 },
1010 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
1011 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
1012 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
1013 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1014 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1015 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1016 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1017 &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.
1018 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1019 },
1020 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
1021 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
1022 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
1023 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1024 },
1025 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
1026 &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.
1027 &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.
1028 },
1029 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
1030 &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.
1031 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
1032 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
1033 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
1034 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1035 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1036 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1037 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1038 &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.
1039 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1040 },
1041 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
1042 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
1043 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
1044 &quot;disregardOverdelivery&quot;: True or False, # Whether cap costs are ignored by ad serving.
1045 &quot;endDate&quot;: &quot;A String&quot;,
1046 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
1047 &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.
1048 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
1049 { # Pricing Period
1050 &quot;endDate&quot;: &quot;A String&quot;,
1051 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
1052 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
1053 &quot;startDate&quot;: &quot;A String&quot;,
1054 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
1055 },
1056 ],
1057 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
1058 &quot;startDate&quot;: &quot;A String&quot;,
1059 &quot;testingStartDate&quot;: &quot;A String&quot;,
1060 },
1061 &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.
1062 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
1063 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1064 },
1065 &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.
1066 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
1067 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1068 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1069 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1070 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1071 &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.
1072 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1073 },
1074 &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.
1075 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1076 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1077 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1078 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1079 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1080 },
1081 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
1082 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
1083 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
1084 &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;
1085 &quot;A String&quot;,
1086 ],
1087 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
1088 &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.
1089 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
1090 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
1091 &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.
1092 },
1093 &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.
1094 &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.
1095 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
1096 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
1097 &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.
1098 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1099 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1100 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1101 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1102 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1103 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1104 },
1105 ],
1106 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
1107 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
1108 },
1109 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
1110 &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.
1111 &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.
1112 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
1113 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
1114 &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.
1115 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1116 },
1117 &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.
1118 &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.
1119 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1120 },
1121 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
1122 },
1123 &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.
1124 &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.
1125 42,
1126 ],
1127 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
1128 },
1129 },
1130 &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.
1131 }
1132
1133 x__xgafv: string, V1 error format.
1134 Allowed values
1135 1 - v1 error format
1136 2 - v2 error format
1137
1138 Returns:
1139 An object of the form:
1140
1141 { # Contains properties of a placement.
1142 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
1143 &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.
1144 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
1145 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1146 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1147 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1148 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1149 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1150 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1151 },
1152 ],
1153 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
1154 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
1155 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1156 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1157 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1158 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1159 &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.
1160 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1161 },
1162 &quot;archived&quot;: True or False, # Whether this placement is archived.
1163 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
1164 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
1165 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1166 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1167 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1168 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1169 &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.
1170 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1171 },
1172 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
1173 &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.
1174 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
1175 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
1176 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1177 },
1178 &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.
1179 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
1180 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1181 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1182 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1183 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1184 &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.
1185 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1186 },
1187 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
1188 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
1189 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
1190 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1191 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1192 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1193 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1194 &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.
1195 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1196 },
1197 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
1198 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
1199 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
1200 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1201 },
1202 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
1203 &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.
1204 &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.
1205 },
1206 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
1207 &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.
1208 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
1209 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
1210 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
1211 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1212 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1213 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1214 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1215 &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.
1216 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1217 },
1218 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
1219 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
1220 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
1221 &quot;disregardOverdelivery&quot;: True or False, # Whether cap costs are ignored by ad serving.
1222 &quot;endDate&quot;: &quot;A String&quot;,
1223 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
1224 &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.
1225 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
1226 { # Pricing Period
1227 &quot;endDate&quot;: &quot;A String&quot;,
1228 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
1229 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
1230 &quot;startDate&quot;: &quot;A String&quot;,
1231 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
1232 },
1233 ],
1234 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
1235 &quot;startDate&quot;: &quot;A String&quot;,
1236 &quot;testingStartDate&quot;: &quot;A String&quot;,
1237 },
1238 &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.
1239 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
1240 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1241 },
1242 &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.
1243 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
1244 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1245 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1246 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1247 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1248 &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.
1249 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1250 },
1251 &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.
1252 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1253 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1254 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1255 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1256 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1257 },
1258 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
1259 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
1260 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
1261 &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;
1262 &quot;A String&quot;,
1263 ],
1264 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
1265 &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.
1266 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
1267 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
1268 &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.
1269 },
1270 &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.
1271 &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.
1272 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
1273 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
1274 &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.
1275 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1276 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1277 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1278 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1279 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1280 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1281 },
1282 ],
1283 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
1284 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
1285 },
1286 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
1287 &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.
1288 &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.
1289 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
1290 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
1291 &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.
1292 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1293 },
1294 &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.
1295 &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.
1296 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1297 },
1298 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
1299 },
1300 &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.
1301 &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.
1302 42,
1303 ],
1304 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
1305 },
1306 },
1307 &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.
1308 }</pre>
1309 </div>
1310
1311 <div class="method">
1312 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code>
1313 <pre>Updates an existing placement.
1314
1315 Args:
1316 profileId: string, User profile ID associated with this request. (required)
1317 body: object, The request body.
1318 The object takes the form of:
1319
1320 { # Contains properties of a placement.
1321 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
1322 &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.
1323 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
1324 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1325 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1326 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1327 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1328 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1329 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1330 },
1331 ],
1332 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
1333 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
1334 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1335 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1336 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1337 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1338 &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.
1339 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1340 },
1341 &quot;archived&quot;: True or False, # Whether this placement is archived.
1342 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
1343 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
1344 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1345 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1346 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1347 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1348 &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.
1349 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1350 },
1351 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
1352 &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.
1353 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
1354 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
1355 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1356 },
1357 &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.
1358 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
1359 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1360 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1361 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1362 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1363 &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.
1364 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1365 },
1366 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
1367 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
1368 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
1369 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1370 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1371 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1372 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1373 &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.
1374 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1375 },
1376 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
1377 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
1378 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
1379 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1380 },
1381 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
1382 &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.
1383 &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.
1384 },
1385 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
1386 &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.
1387 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
1388 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
1389 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
1390 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1391 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1392 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1393 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1394 &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.
1395 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1396 },
1397 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
1398 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
1399 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
1400 &quot;disregardOverdelivery&quot;: True or False, # Whether cap costs are ignored by ad serving.
1401 &quot;endDate&quot;: &quot;A String&quot;,
1402 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
1403 &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.
1404 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
1405 { # Pricing Period
1406 &quot;endDate&quot;: &quot;A String&quot;,
1407 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
1408 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
1409 &quot;startDate&quot;: &quot;A String&quot;,
1410 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
1411 },
1412 ],
1413 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
1414 &quot;startDate&quot;: &quot;A String&quot;,
1415 &quot;testingStartDate&quot;: &quot;A String&quot;,
1416 },
1417 &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.
1418 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
1419 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1420 },
1421 &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.
1422 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
1423 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1424 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1425 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1426 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1427 &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.
1428 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1429 },
1430 &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.
1431 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1432 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1433 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1434 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1435 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1436 },
1437 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
1438 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
1439 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
1440 &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;
1441 &quot;A String&quot;,
1442 ],
1443 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
1444 &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.
1445 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
1446 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
1447 &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.
1448 },
1449 &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.
1450 &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.
1451 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
1452 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
1453 &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.
1454 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1455 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1456 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1457 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1458 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1459 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1460 },
1461 ],
1462 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
1463 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
1464 },
1465 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
1466 &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.
1467 &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.
1468 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
1469 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
1470 &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.
1471 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1472 },
1473 &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.
1474 &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.
1475 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1476 },
1477 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
1478 },
1479 &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.
1480 &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.
1481 42,
1482 ],
1483 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
1484 },
1485 },
1486 &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.
1487 }
1488
1489 x__xgafv: string, V1 error format.
1490 Allowed values
1491 1 - v1 error format
1492 2 - v2 error format
1493
1494 Returns:
1495 An object of the form:
1496
1497 { # Contains properties of a placement.
1498 &quot;accountId&quot;: &quot;A String&quot;, # Account ID of this placement. This field can be left blank.
1499 &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.
1500 &quot;additionalSizes&quot;: [ # Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.
1501 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1502 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1503 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1504 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1505 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1506 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1507 },
1508 ],
1509 &quot;advertiserId&quot;: &quot;A String&quot;, # Advertiser ID of this placement. This field can be left blank.
1510 &quot;advertiserIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field.
1511 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1512 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1513 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1514 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1515 &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.
1516 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1517 },
1518 &quot;archived&quot;: True or False, # Whether this placement is archived.
1519 &quot;campaignId&quot;: &quot;A String&quot;, # Campaign ID of this placement. This field is a required field on insertion.
1520 &quot;campaignIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the campaign. This is a read-only, auto-generated field.
1521 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1522 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1523 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1524 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1525 &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.
1526 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1527 },
1528 &quot;comment&quot;: &quot;A String&quot;, # Comments for this placement.
1529 &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.
1530 &quot;contentCategoryId&quot;: &quot;A String&quot;, # ID of the content category assigned to this placement.
1531 &quot;createInfo&quot;: { # Modification timestamp. # Information about the creation of this placement. This is a read-only field.
1532 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1533 },
1534 &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.
1535 &quot;directorySiteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the directory site. This is a read-only, auto-generated field.
1536 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1537 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1538 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1539 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1540 &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.
1541 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1542 },
1543 &quot;externalId&quot;: &quot;A String&quot;, # External ID for this placement.
1544 &quot;id&quot;: &quot;A String&quot;, # ID of this placement. This is a read-only, auto-generated field.
1545 &quot;idDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of this placement. This is a read-only, auto-generated field.
1546 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1547 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1548 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1549 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1550 &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.
1551 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1552 },
1553 &quot;keyName&quot;: &quot;A String&quot;, # Key name of this placement. This is a read-only, auto-generated field.
1554 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#placement&quot;.
1555 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Information about the most recent modification of this placement. This is a read-only field.
1556 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1557 },
1558 &quot;lookbackConfiguration&quot;: { # Lookback configuration settings. # Lookback window settings for this placement.
1559 &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.
1560 &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.
1561 },
1562 &quot;name&quot;: &quot;A String&quot;, # Name of this placement.This is a required field and must be less than or equal to 256 characters long.
1563 &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.
1564 &quot;paymentSource&quot;: &quot;A String&quot;, # Payment source for this placement. This is a required field that is read-only after insertion.
1565 &quot;placementGroupId&quot;: &quot;A String&quot;, # ID of this placement&#x27;s group, if applicable.
1566 &quot;placementGroupIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the placement group. This is a read-only, auto-generated field.
1567 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1568 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1569 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1570 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1571 &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.
1572 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1573 },
1574 &quot;placementStrategyId&quot;: &quot;A String&quot;, # ID of the placement strategy assigned to this placement.
1575 &quot;pricingSchedule&quot;: { # Pricing Schedule # Pricing schedule of this placement. This field is required on insertion, specifically subfields startDate, endDate and pricingType.
1576 &quot;capCostOption&quot;: &quot;A String&quot;, # Placement cap cost option.
1577 &quot;disregardOverdelivery&quot;: True or False, # Whether cap costs are ignored by ad serving.
1578 &quot;endDate&quot;: &quot;A String&quot;,
1579 &quot;flighted&quot;: True or False, # Whether this placement is flighted. If true, pricing periods will be computed automatically.
1580 &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.
1581 &quot;pricingPeriods&quot;: [ # Pricing periods for this placement.
1582 { # Pricing Period
1583 &quot;endDate&quot;: &quot;A String&quot;,
1584 &quot;pricingComment&quot;: &quot;A String&quot;, # Comments for this pricing period.
1585 &quot;rateOrCostNanos&quot;: &quot;A String&quot;, # Rate or cost of this pricing period in nanos (i.e., multipled by 1000000000). Acceptable values are 0 to 1000000000000000000, inclusive.
1586 &quot;startDate&quot;: &quot;A String&quot;,
1587 &quot;units&quot;: &quot;A String&quot;, # Units of this pricing period. Acceptable values are 0 to 10000000000, inclusive.
1588 },
1589 ],
1590 &quot;pricingType&quot;: &quot;A String&quot;, # Placement pricing type. This field is required on insertion.
1591 &quot;startDate&quot;: &quot;A String&quot;,
1592 &quot;testingStartDate&quot;: &quot;A String&quot;,
1593 },
1594 &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.
1595 &quot;publisherUpdateInfo&quot;: { # Modification timestamp. # Information about the last publisher update. This is a read-only field.
1596 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
1597 },
1598 &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.
1599 &quot;siteIdDimensionValue&quot;: { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field.
1600 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
1601 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
1602 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
1603 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
1604 &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.
1605 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
1606 },
1607 &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.
1608 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1609 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1610 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1611 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1612 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1613 },
1614 &quot;sslRequired&quot;: True or False, # Whether creatives assigned to this placement must be SSL-compliant.
1615 &quot;status&quot;: &quot;A String&quot;, # Third-party placement status.
1616 &quot;subaccountId&quot;: &quot;A String&quot;, # Subaccount ID of this placement. This field can be left blank.
1617 &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;
1618 &quot;A String&quot;,
1619 ],
1620 &quot;tagSetting&quot;: { # Tag Settings # Tag settings for this placement.
1621 &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.
1622 &quot;includeClickThroughUrls&quot;: True or False, # Whether static landing page URLs should be included in the tags. This setting applies only to placements.
1623 &quot;includeClickTracking&quot;: True or False, # Whether click-tracking string should be included in the tags.
1624 &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.
1625 },
1626 &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.
1627 &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.
1628 &quot;companionSettings&quot;: { # Companion Settings # Settings for the companion creatives of video creatives served to this placement.
1629 &quot;companionsDisabled&quot;: True or False, # Whether companions are disabled for this placement.
1630 &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.
1631 { # Represents the dimensions of ads, placements, creatives, or creative assets.
1632 &quot;height&quot;: 42, # Height of this size. Acceptable values are 0 to 32767, inclusive.
1633 &quot;iab&quot;: True or False, # IAB standard size. This is a read-only, auto-generated field.
1634 &quot;id&quot;: &quot;A String&quot;, # ID of this size. This is a read-only, auto-generated field.
1635 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#size&quot;.
1636 &quot;width&quot;: 42, # Width of this size. Acceptable values are 0 to 32767, inclusive.
1637 },
1638 ],
1639 &quot;imageOnly&quot;: True or False, # Whether to serve only static images as companions.
1640 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#companionSetting&quot;.
1641 },
1642 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#videoSettings&quot;.
1643 &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.
1644 &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.
1645 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#skippableSetting&quot;.
1646 &quot;progressOffset&quot;: { # Video Offset # Amount of time to play videos served to this placement before counting a view. Applicable when skippable is true.
1647 &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.
1648 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1649 },
1650 &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.
1651 &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.
1652 &quot;offsetSeconds&quot;: 42, # Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive.
1653 },
1654 &quot;skippable&quot;: True or False, # Whether the user can skip creatives served to this placement.
1655 },
1656 &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.
1657 &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.
1658 42,
1659 ],
1660 &quot;kind&quot;: &quot;A String&quot;, # Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#transcodeSetting&quot;.
1661 },
1662 },
1663 &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.
1664 }</pre>
1665 </div>
1666
1667 </body></html>