Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c72efbc6b71c963997c5728d471c04ab33d95e4f / . / docs / dyn / displayvideo_v1.floodlightGroups.html
blob: 2e2bcd281276ea6119e0ac9f87b7c0cc6b7398dd [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.floodlightGroups.html">floodlightGroups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(floodlightGroupId, partnerId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a Floodlight group.</p>
80<p class="toc_element">
81 <code><a href="#patch">patch(floodlightGroupId, body=None, partnerId=None, updateMask=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Updates an existing Floodlight group.</p>
83<h3>Method Details</h3>
84<div class="method">
85 <code class="details" id="get">get(floodlightGroupId, partnerId=None, x__xgafv=None)</code>
86 <pre>Gets a Floodlight group.
87
88Args:
89 floodlightGroupId: string, Required. The ID of the Floodlight group to fetch. (required)
90 partnerId: string, Required. The partner context by which the Floodlight group is being accessed.
91 x__xgafv: string, V1 error format.
92 Allowed values
93 1 - v1 error format
94 2 - v2 error format
95
96Returns:
97 An object of the form:
98
99 { # A single Floodlight group.
100 &quot;activeViewConfig&quot;: { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight
101 # group.
102 &quot;minimumViewability&quot;: &quot;A String&quot;, # Required. The minimum percentage of the video ad&#x27;s pixels visible on the screen in
103 # order for an impression to be recorded.
104 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the custom metric.
105 &quot;minimumVolume&quot;: &quot;A String&quot;, # Required. The minimum percentage of the video ad&#x27;s volume required in order for an
106 # impression to be recorded.
107 &quot;minimumDuration&quot;: &quot;A String&quot;, # The minimum visible video duration required (in seconds) in order for an
108 # impression to be recorded.
109 #
110 # You must specify
111 # minimum_duration,
112 # minimum_quartile
113 # or both. If both are specified, an impression meets the metric criteria if
114 # either requirement is met (whichever happens first).
115 &quot;minimumQuartile&quot;: &quot;A String&quot;, # The minimum visible video duration required, based on the video quartiles,
116 # in order for an impression to be recorded.
117 #
118 # You must specify
119 # minimum_duration,
120 # minimum_quartile
121 # or both. If both are specified, an impression meets the metric criteria if
122 # either requirement is met (whichever happens first).
123 },
124 &quot;floodlightGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the Floodlight group. Assigned by the system.
125 &quot;lookbackWindow&quot;: { # Specifies how many days into the past to look when determining whether to # Required. The lookback window for the Floodlight group.
126 # Both click_days and
127 # impression_days are required. Acceptable
128 # values for both are `0` to `90`, inclusive.
129 # record a conversion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]130 &quot;impressionDays&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of
131 # your ads.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]132 &quot;clickDays&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of
133 # your ads.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 &quot;customVariables&quot;: { # User-defined custom variables owned by the Floodlight group.
136 # Use custom Floodlight variables to create reporting data that is tailored
137 # to your unique business needs. Custom Floodlight variables use the keys
138 # `U1=`, `U2=`, and so on, and can take any values that you choose to pass to
139 # them. You can use them to track virtually any type of data that you collect
140 # about your customers, such as the genre of movie that a customer purchases,
141 # the country to which the item is shipped, and so on.
142 #
143 # Custom Floodlight variables may not be used to pass any data that could be
144 # used or recognized as personally identifiable information (PII).
145 #
146 # Example:
147 # `custom_variables {
148 # fields {
149 # &quot;U1&quot;: value { number_value: 123.4 },
150 # &quot;U2&quot;: value { string_value: &quot;MyVariable2&quot; },
151 # &quot;U3&quot;: value { string_value: &quot;MyVariable3&quot; }
152 # }
153 # }`
154 #
155 # Acceptable values for keys are &quot;U1&quot; through &quot;U100&quot;, inclusive. String
156 # values must be less than 64 characters long, and cannot contain the
157 # following characters: `&quot;&lt;&gt;`.
158 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
159 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]160 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the Floodlight group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Floodlight group.
162 &quot;webTagType&quot;: &quot;A String&quot;, # Required. The web tag type enabled for the Floodlight group.
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="patch">patch(floodlightGroupId, body=None, partnerId=None, updateMask=None, x__xgafv=None)</code>
168 <pre>Updates an existing Floodlight group.
169Returns the updated Floodlight group if successful.
170
171Args:
172 floodlightGroupId: string, Output only. The unique ID of the Floodlight group. Assigned by the system. (required)
173 body: object, The request body.
174 The object takes the form of:
175
176{ # A single Floodlight group.
177 &quot;activeViewConfig&quot;: { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight
178 # group.
179 &quot;minimumViewability&quot;: &quot;A String&quot;, # Required. The minimum percentage of the video ad&#x27;s pixels visible on the screen in
180 # order for an impression to be recorded.
181 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the custom metric.
182 &quot;minimumVolume&quot;: &quot;A String&quot;, # Required. The minimum percentage of the video ad&#x27;s volume required in order for an
183 # impression to be recorded.
184 &quot;minimumDuration&quot;: &quot;A String&quot;, # The minimum visible video duration required (in seconds) in order for an
185 # impression to be recorded.
186 #
187 # You must specify
188 # minimum_duration,
189 # minimum_quartile
190 # or both. If both are specified, an impression meets the metric criteria if
191 # either requirement is met (whichever happens first).
192 &quot;minimumQuartile&quot;: &quot;A String&quot;, # The minimum visible video duration required, based on the video quartiles,
193 # in order for an impression to be recorded.
194 #
195 # You must specify
196 # minimum_duration,
197 # minimum_quartile
198 # or both. If both are specified, an impression meets the metric criteria if
199 # either requirement is met (whichever happens first).
200 },
201 &quot;floodlightGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the Floodlight group. Assigned by the system.
202 &quot;lookbackWindow&quot;: { # Specifies how many days into the past to look when determining whether to # Required. The lookback window for the Floodlight group.
203 # Both click_days and
204 # impression_days are required. Acceptable
205 # values for both are `0` to `90`, inclusive.
206 # record a conversion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]207 &quot;impressionDays&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of
208 # your ads.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]209 &quot;clickDays&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of
210 # your ads.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]211 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]212 &quot;customVariables&quot;: { # User-defined custom variables owned by the Floodlight group.
213 # Use custom Floodlight variables to create reporting data that is tailored
214 # to your unique business needs. Custom Floodlight variables use the keys
215 # `U1=`, `U2=`, and so on, and can take any values that you choose to pass to
216 # them. You can use them to track virtually any type of data that you collect
217 # about your customers, such as the genre of movie that a customer purchases,
218 # the country to which the item is shipped, and so on.
219 #
220 # Custom Floodlight variables may not be used to pass any data that could be
221 # used or recognized as personally identifiable information (PII).
222 #
223 # Example:
224 # `custom_variables {
225 # fields {
226 # &quot;U1&quot;: value { number_value: 123.4 },
227 # &quot;U2&quot;: value { string_value: &quot;MyVariable2&quot; },
228 # &quot;U3&quot;: value { string_value: &quot;MyVariable3&quot; }
229 # }
230 # }`
231 #
232 # Acceptable values for keys are &quot;U1&quot; through &quot;U100&quot;, inclusive. String
233 # values must be less than 64 characters long, and cannot contain the
234 # following characters: `&quot;&lt;&gt;`.
235 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
236 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]237 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the Floodlight group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]238 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Floodlight group.
239 &quot;webTagType&quot;: &quot;A String&quot;, # Required. The web tag type enabled for the Floodlight group.
240}
241
242 partnerId: string, Required. The partner context by which the Floodlight group is being accessed.
243 updateMask: string, Required. The mask to control which fields to update.
244 x__xgafv: string, V1 error format.
245 Allowed values
246 1 - v1 error format
247 2 - v2 error format
248
249Returns:
250 An object of the form:
251
252 { # A single Floodlight group.
253 &quot;activeViewConfig&quot;: { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight
254 # group.
255 &quot;minimumViewability&quot;: &quot;A String&quot;, # Required. The minimum percentage of the video ad&#x27;s pixels visible on the screen in
256 # order for an impression to be recorded.
257 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the custom metric.
258 &quot;minimumVolume&quot;: &quot;A String&quot;, # Required. The minimum percentage of the video ad&#x27;s volume required in order for an
259 # impression to be recorded.
260 &quot;minimumDuration&quot;: &quot;A String&quot;, # The minimum visible video duration required (in seconds) in order for an
261 # impression to be recorded.
262 #
263 # You must specify
264 # minimum_duration,
265 # minimum_quartile
266 # or both. If both are specified, an impression meets the metric criteria if
267 # either requirement is met (whichever happens first).
268 &quot;minimumQuartile&quot;: &quot;A String&quot;, # The minimum visible video duration required, based on the video quartiles,
269 # in order for an impression to be recorded.
270 #
271 # You must specify
272 # minimum_duration,
273 # minimum_quartile
274 # or both. If both are specified, an impression meets the metric criteria if
275 # either requirement is met (whichever happens first).
276 },
277 &quot;floodlightGroupId&quot;: &quot;A String&quot;, # Output only. The unique ID of the Floodlight group. Assigned by the system.
278 &quot;lookbackWindow&quot;: { # Specifies how many days into the past to look when determining whether to # Required. The lookback window for the Floodlight group.
279 # Both click_days and
280 # impression_days are required. Acceptable
281 # values for both are `0` to `90`, inclusive.
282 # record a conversion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]283 &quot;impressionDays&quot;: 42, # Lookback window, in days, from the last time a given user viewed one of
284 # your ads.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]285 &quot;clickDays&quot;: 42, # Lookback window, in days, from the last time a given user clicked on one of
286 # your ads.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]287 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]288 &quot;customVariables&quot;: { # User-defined custom variables owned by the Floodlight group.
289 # Use custom Floodlight variables to create reporting data that is tailored
290 # to your unique business needs. Custom Floodlight variables use the keys
291 # `U1=`, `U2=`, and so on, and can take any values that you choose to pass to
292 # them. You can use them to track virtually any type of data that you collect
293 # about your customers, such as the genre of movie that a customer purchases,
294 # the country to which the item is shipped, and so on.
295 #
296 # Custom Floodlight variables may not be used to pass any data that could be
297 # used or recognized as personally identifiable information (PII).
298 #
299 # Example:
300 # `custom_variables {
301 # fields {
302 # &quot;U1&quot;: value { number_value: 123.4 },
303 # &quot;U2&quot;: value { string_value: &quot;MyVariable2&quot; },
304 # &quot;U3&quot;: value { string_value: &quot;MyVariable3&quot; }
305 # }
306 # }`
307 #
308 # Acceptable values for keys are &quot;U1&quot; through &quot;U100&quot;, inclusive. String
309 # values must be less than 64 characters long, and cannot contain the
310 # following characters: `&quot;&lt;&gt;`.
311 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
312 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]313 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the Floodlight group.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]314 &quot;displayName&quot;: &quot;A String&quot;, # Required. The display name of the Floodlight group.
315 &quot;webTagType&quot;: &quot;A String&quot;, # Required. The web tag type enabled for the Floodlight group.
316 }</pre>
317</div>
318
319</body></html>