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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(floodlightGroupId, partnerId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets a Floodlight group.</p> 83<p class="toc_element"> 84 <code><a href="#patch">patch(floodlightGroupId, body=None, partnerId=None, updateMask=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Updates an existing Floodlight group. Returns the updated Floodlight group if successful.</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="get">get(floodlightGroupId, partnerId=None, x__xgafv=None)</code> 94 <pre>Gets a Floodlight group. 95 96Args: 97 floodlightGroupId: string, Required. The ID of the Floodlight group to fetch. (required) 98 partnerId: string, Required. The partner context by which the Floodlight group is being accessed. 99 x__xgafv: string, V1 error format. 100 Allowed values 101 1 - v1 error format 102 2 - v2 error format 103 104Returns: 105 An object of the form: 106 107 { # A single Floodlight group. 108 "activeViewConfig": { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight group. 109 "displayName": "A String", # Required. The display name of the custom metric. 110 "minimumDuration": "A String", # The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). 111 "minimumQuartile": "A String", # The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). 112 "minimumViewability": "A String", # Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded. 113 "minimumVolume": "A String", # Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. 114 }, 115 "customVariables": { # User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 }, "U2": value { string_value: "MyVariable2" }, "U3": value { string_value: "MyVariable3" } } }` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<>`. 116 "a_key": "", # Properties of the object. 117 }, 118 "displayName": "A String", # Required. The display name of the Floodlight group. 119 "floodlightGroupId": "A String", # Output only. The unique ID of the Floodlight group. Assigned by the system. 120 "lookbackWindow": { # Specifies how many days into the past to look when determining whether to record a conversion. # Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive. 121 "clickDays": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. 122 "impressionDays": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. 123 }, 124 "name": "A String", # Output only. The resource name of the Floodlight group. 125 "webTagType": "A String", # Required. The web tag type enabled for the Floodlight group. 126}</pre> 127</div> 128 129<div class="method"> 130 <code class="details" id="patch">patch(floodlightGroupId, body=None, partnerId=None, updateMask=None, x__xgafv=None)</code> 131 <pre>Updates an existing Floodlight group. Returns the updated Floodlight group if successful. 132 133Args: 134 floodlightGroupId: string, Output only. The unique ID of the Floodlight group. Assigned by the system. (required) 135 body: object, The request body. 136 The object takes the form of: 137 138{ # A single Floodlight group. 139 "activeViewConfig": { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight group. 140 "displayName": "A String", # Required. The display name of the custom metric. 141 "minimumDuration": "A String", # The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). 142 "minimumQuartile": "A String", # The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). 143 "minimumViewability": "A String", # Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded. 144 "minimumVolume": "A String", # Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. 145 }, 146 "customVariables": { # User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 }, "U2": value { string_value: "MyVariable2" }, "U3": value { string_value: "MyVariable3" } } }` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<>`. 147 "a_key": "", # Properties of the object. 148 }, 149 "displayName": "A String", # Required. The display name of the Floodlight group. 150 "floodlightGroupId": "A String", # Output only. The unique ID of the Floodlight group. Assigned by the system. 151 "lookbackWindow": { # Specifies how many days into the past to look when determining whether to record a conversion. # Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive. 152 "clickDays": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. 153 "impressionDays": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. 154 }, 155 "name": "A String", # Output only. The resource name of the Floodlight group. 156 "webTagType": "A String", # Required. The web tag type enabled for the Floodlight group. 157} 158 159 partnerId: string, Required. The partner context by which the Floodlight group is being accessed. 160 updateMask: string, Required. The mask to control which fields to update. 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { # A single Floodlight group. 170 "activeViewConfig": { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight group. 171 "displayName": "A String", # Required. The display name of the custom metric. 172 "minimumDuration": "A String", # The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). 173 "minimumQuartile": "A String", # The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first). 174 "minimumViewability": "A String", # Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded. 175 "minimumVolume": "A String", # Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. 176 }, 177 "customVariables": { # User-defined custom variables owned by the Floodlight group. Use custom Floodlight variables to create reporting data that is tailored to your unique business needs. Custom Floodlight variables use the keys `U1=`, `U2=`, and so on, and can take any values that you choose to pass to them. You can use them to track virtually any type of data that you collect about your customers, such as the genre of movie that a customer purchases, the country to which the item is shipped, and so on. Custom Floodlight variables may not be used to pass any data that could be used or recognized as personally identifiable information (PII). Example: `custom_variables { fields { "U1": value { number_value: 123.4 }, "U2": value { string_value: "MyVariable2" }, "U3": value { string_value: "MyVariable3" } } }` Acceptable values for keys are "U1" through "U100", inclusive. String values must be less than 64 characters long, and cannot contain the following characters: `"<>`. 178 "a_key": "", # Properties of the object. 179 }, 180 "displayName": "A String", # Required. The display name of the Floodlight group. 181 "floodlightGroupId": "A String", # Output only. The unique ID of the Floodlight group. Assigned by the system. 182 "lookbackWindow": { # Specifies how many days into the past to look when determining whether to record a conversion. # Required. The lookback window for the Floodlight group. Both click_days and impression_days are required. Acceptable values for both are `0` to `90`, inclusive. 183 "clickDays": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. 184 "impressionDays": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. 185 }, 186 "name": "A String", # Output only. The resource name of the Floodlight group. 187 "webTagType": "A String", # Required. The web tag type enabled for the Floodlight group. 188}</pre> 189</div> 190 191</body></html>