| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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="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"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 81 | <code><a href="#patch">patch(floodlightGroupId, body=None, updateMask=None, partnerId=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Updates an existing Floodlight group. Returns the updated Floodlight group if successful.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | |
| 88 | Args: |
| 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 | |
| 96 | Returns: |
| 97 | An object of the form: |
| 98 | |
| 99 | { # A single Floodlight group. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 100 | "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. |
| 101 | "clickDays": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. |
| 102 | "impressionDays": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. |
| 103 | }, |
| 104 | "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: `"<>`. |
| 105 | "a_key": "", # Properties of the object. |
| 106 | }, |
| 107 | "displayName": "A String", # Required. The display name of the Floodlight group. |
| 108 | "webTagType": "A String", # Required. The web tag type enabled for the Floodlight group. |
| 109 | "floodlightGroupId": "A String", # Output only. The unique ID of the Floodlight group. Assigned by the system. |
| 110 | "name": "A String", # Output only. The resource name of the Floodlight group. |
| 111 | "activeViewConfig": { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight group. |
| 112 | "minimumVolume": "A String", # Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. |
| 113 | "displayName": "A String", # Required. The display name of the custom metric. |
| 114 | "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). |
| 115 | "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). |
| 116 | "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. |
| 117 | }, |
| 118 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 119 | </div> |
| 120 | |
| 121 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 122 | <code class="details" id="patch">patch(floodlightGroupId, body=None, updateMask=None, partnerId=None, x__xgafv=None)</code> |
| 123 | <pre>Updates an existing Floodlight group. Returns the updated Floodlight group if successful. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | |
| 125 | Args: |
| 126 | floodlightGroupId: string, Output only. The unique ID of the Floodlight group. Assigned by the system. (required) |
| 127 | body: object, The request body. |
| 128 | The object takes the form of: |
| 129 | |
| 130 | { # A single Floodlight group. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 131 | "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. |
| 132 | "clickDays": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. |
| 133 | "impressionDays": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. |
| 134 | }, |
| 135 | "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: `"<>`. |
| 136 | "a_key": "", # Properties of the object. |
| 137 | }, |
| 138 | "displayName": "A String", # Required. The display name of the Floodlight group. |
| 139 | "webTagType": "A String", # Required. The web tag type enabled for the Floodlight group. |
| 140 | "floodlightGroupId": "A String", # Output only. The unique ID of the Floodlight group. Assigned by the system. |
| 141 | "name": "A String", # Output only. The resource name of the Floodlight group. |
| 142 | "activeViewConfig": { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight group. |
| 143 | "minimumVolume": "A String", # Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. |
| 144 | "displayName": "A String", # Required. The display name of the custom metric. |
| 145 | "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). |
| 146 | "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). |
| 147 | "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. |
| 148 | }, |
| 149 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 150 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 151 | updateMask: string, Required. The mask to control which fields to update. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 152 | partnerId: string, Required. The partner context by which the Floodlight group is being accessed. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 153 | x__xgafv: string, V1 error format. |
| 154 | Allowed values |
| 155 | 1 - v1 error format |
| 156 | 2 - v2 error format |
| 157 | |
| 158 | Returns: |
| 159 | An object of the form: |
| 160 | |
| 161 | { # A single Floodlight group. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 162 | "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. |
| 163 | "clickDays": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. |
| 164 | "impressionDays": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. |
| 165 | }, |
| 166 | "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: `"<>`. |
| 167 | "a_key": "", # Properties of the object. |
| 168 | }, |
| 169 | "displayName": "A String", # Required. The display name of the Floodlight group. |
| 170 | "webTagType": "A String", # Required. The web tag type enabled for the Floodlight group. |
| 171 | "floodlightGroupId": "A String", # Output only. The unique ID of the Floodlight group. Assigned by the system. |
| 172 | "name": "A String", # Output only. The resource name of the Floodlight group. |
| 173 | "activeViewConfig": { # Configuration for custom Active View video viewability metrics. # The Active View video viewability metric configuration for the Floodlight group. |
| 174 | "minimumVolume": "A String", # Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. |
| 175 | "displayName": "A String", # Required. The display name of the custom metric. |
| 176 | "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). |
| 177 | "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). |
| 178 | "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. |
| 179 | }, |
| 180 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 181 | </div> |
| 182 | |
| 183 | </body></html> |