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="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.floodlightActivities.html">floodlightActivities</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="#delete">delete(profileId, id, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes an existing floodlight activity.</p> 83<p class="toc_element"> 84 <code><a href="#generatetag">generatetag(profileId, floodlightActivityId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Generates a tag for a floodlight activity.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets one floodlight activity by ID.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Inserts a new floodlight activity.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(profileId, advertiserId=None, floodlightActivityGroupIds=None, floodlightActivityGroupName=None, floodlightActivityGroupTagString=None, floodlightActivityGroupType=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, tagString=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Retrieves a list of floodlight activities, possibly filtered. This method supports paging.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Updates an existing floodlight activity. This method supports patch semantics.</p> 101<p class="toc_element"> 102 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates an existing floodlight activity.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="close">close()</code> 107 <pre>Close httplib2 connections.</pre> 108</div> 109 110<div class="method"> 111 <code class="details" id="delete">delete(profileId, id, x__xgafv=None)</code> 112 <pre>Deletes an existing floodlight activity. 113 114Args: 115 profileId: string, User profile ID associated with this request. (required) 116 id: string, Floodlight activity ID. (required) 117 x__xgafv: string, V1 error format. 118 Allowed values 119 1 - v1 error format 120 2 - v2 error format 121</pre> 122</div> 123 124<div class="method"> 125 <code class="details" id="generatetag">generatetag(profileId, floodlightActivityId=None, x__xgafv=None)</code> 126 <pre>Generates a tag for a floodlight activity. 127 128Args: 129 profileId: string, User profile ID associated with this request. (required) 130 floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag. 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136Returns: 137 An object of the form: 138 139 { # Floodlight Activity GenerateTag Response 140 "floodlightActivityTag": "A String", # Generated tag for this Floodlight activity. For global site tags, this is the event snippet. 141 "globalSiteTagGlobalSnippet": "A String", # The global snippet section of a global site tag. The global site tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more. 142 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". 143}</pre> 144</div> 145 146<div class="method"> 147 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code> 148 <pre>Gets one floodlight activity by ID. 149 150Args: 151 profileId: string, User profile ID associated with this request. (required) 152 id: string, Floodlight activity ID. (required) 153 x__xgafv: string, V1 error format. 154 Allowed values 155 1 - v1 error format 156 2 - v2 error format 157 158Returns: 159 An object of the form: 160 161 { # Contains properties of a Floodlight activity. 162 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 163 "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. 164 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 165 "dimensionName": "A String", # The name of the dimension. 166 "etag": "A String", # The eTag of this response for caching purposes. 167 "id": "A String", # The ID associated with the value if available. 168 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 169 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 170 "value": "A String", # The value of the dimension. 171 }, 172 "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. 173 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 174 "defaultTags": [ # Dynamic floodlight tags. 175 { # Dynamic Tag 176 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 177 "name": "A String", # Name of this tag. 178 "tag": "A String", # Tag code. 179 }, 180 ], 181 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 182 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 183 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 184 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 185 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 186 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. 187 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 188 "dimensionName": "A String", # The name of the dimension. 189 "etag": "A String", # The eTag of this response for caching purposes. 190 "id": "A String", # The ID associated with the value if available. 191 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 192 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 193 "value": "A String", # The value of the dimension. 194 }, 195 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 196 "hidden": True or False, # Whether this activity is archived. 197 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 198 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 199 "dimensionName": "A String", # The name of the dimension. 200 "etag": "A String", # The eTag of this response for caching purposes. 201 "id": "A String", # The ID associated with the value if available. 202 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 203 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 204 "value": "A String", # The value of the dimension. 205 }, 206 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 207 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 208 "notes": "A String", # General notes or implementation instructions for the tag. 209 "publisherTags": [ # Publisher dynamic floodlight tags. 210 { # Publisher Dynamic Tag 211 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 212 "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. 213 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 214 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 215 "name": "A String", # Name of this tag. 216 "tag": "A String", # Tag code. 217 }, 218 "siteId": "A String", # Site ID of this dynamic tag. 219 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 220 "dimensionName": "A String", # The name of the dimension. 221 "etag": "A String", # The eTag of this response for caching purposes. 222 "id": "A String", # The ID associated with the value if available. 223 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 224 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 225 "value": "A String", # The value of the dimension. 226 }, 227 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 228 }, 229 ], 230 "secure": True or False, # Whether this tag should use SSL. 231 "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. 232 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 233 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 234 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 235 "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 236 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. 237 "A String", 238 ], 239}</pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 244 <pre>Inserts a new floodlight activity. 245 246Args: 247 profileId: string, User profile ID associated with this request. (required) 248 body: object, The request body. 249 The object takes the form of: 250 251{ # Contains properties of a Floodlight activity. 252 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 253 "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. 254 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 255 "dimensionName": "A String", # The name of the dimension. 256 "etag": "A String", # The eTag of this response for caching purposes. 257 "id": "A String", # The ID associated with the value if available. 258 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 259 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 260 "value": "A String", # The value of the dimension. 261 }, 262 "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. 263 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 264 "defaultTags": [ # Dynamic floodlight tags. 265 { # Dynamic Tag 266 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 267 "name": "A String", # Name of this tag. 268 "tag": "A String", # Tag code. 269 }, 270 ], 271 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 272 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 273 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 274 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 275 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 276 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. 277 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 278 "dimensionName": "A String", # The name of the dimension. 279 "etag": "A String", # The eTag of this response for caching purposes. 280 "id": "A String", # The ID associated with the value if available. 281 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 282 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 283 "value": "A String", # The value of the dimension. 284 }, 285 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 286 "hidden": True or False, # Whether this activity is archived. 287 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 288 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 289 "dimensionName": "A String", # The name of the dimension. 290 "etag": "A String", # The eTag of this response for caching purposes. 291 "id": "A String", # The ID associated with the value if available. 292 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 293 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 294 "value": "A String", # The value of the dimension. 295 }, 296 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 297 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 298 "notes": "A String", # General notes or implementation instructions for the tag. 299 "publisherTags": [ # Publisher dynamic floodlight tags. 300 { # Publisher Dynamic Tag 301 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 302 "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. 303 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 304 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 305 "name": "A String", # Name of this tag. 306 "tag": "A String", # Tag code. 307 }, 308 "siteId": "A String", # Site ID of this dynamic tag. 309 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 310 "dimensionName": "A String", # The name of the dimension. 311 "etag": "A String", # The eTag of this response for caching purposes. 312 "id": "A String", # The ID associated with the value if available. 313 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 314 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 315 "value": "A String", # The value of the dimension. 316 }, 317 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 318 }, 319 ], 320 "secure": True or False, # Whether this tag should use SSL. 321 "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. 322 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 323 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 324 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 325 "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 326 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. 327 "A String", 328 ], 329} 330 331 x__xgafv: string, V1 error format. 332 Allowed values 333 1 - v1 error format 334 2 - v2 error format 335 336Returns: 337 An object of the form: 338 339 { # Contains properties of a Floodlight activity. 340 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 341 "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. 342 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 343 "dimensionName": "A String", # The name of the dimension. 344 "etag": "A String", # The eTag of this response for caching purposes. 345 "id": "A String", # The ID associated with the value if available. 346 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 347 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 348 "value": "A String", # The value of the dimension. 349 }, 350 "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. 351 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 352 "defaultTags": [ # Dynamic floodlight tags. 353 { # Dynamic Tag 354 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 355 "name": "A String", # Name of this tag. 356 "tag": "A String", # Tag code. 357 }, 358 ], 359 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 360 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 361 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 362 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 363 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 364 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. 365 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 366 "dimensionName": "A String", # The name of the dimension. 367 "etag": "A String", # The eTag of this response for caching purposes. 368 "id": "A String", # The ID associated with the value if available. 369 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 370 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 371 "value": "A String", # The value of the dimension. 372 }, 373 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 374 "hidden": True or False, # Whether this activity is archived. 375 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 376 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 377 "dimensionName": "A String", # The name of the dimension. 378 "etag": "A String", # The eTag of this response for caching purposes. 379 "id": "A String", # The ID associated with the value if available. 380 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 381 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 382 "value": "A String", # The value of the dimension. 383 }, 384 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 385 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 386 "notes": "A String", # General notes or implementation instructions for the tag. 387 "publisherTags": [ # Publisher dynamic floodlight tags. 388 { # Publisher Dynamic Tag 389 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 390 "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. 391 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 392 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 393 "name": "A String", # Name of this tag. 394 "tag": "A String", # Tag code. 395 }, 396 "siteId": "A String", # Site ID of this dynamic tag. 397 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 398 "dimensionName": "A String", # The name of the dimension. 399 "etag": "A String", # The eTag of this response for caching purposes. 400 "id": "A String", # The ID associated with the value if available. 401 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 402 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 403 "value": "A String", # The value of the dimension. 404 }, 405 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 406 }, 407 ], 408 "secure": True or False, # Whether this tag should use SSL. 409 "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. 410 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 411 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 412 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 413 "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 414 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. 415 "A String", 416 ], 417}</pre> 418</div> 419 420<div class="method"> 421 <code class="details" id="list">list(profileId, advertiserId=None, floodlightActivityGroupIds=None, floodlightActivityGroupName=None, floodlightActivityGroupTagString=None, floodlightActivityGroupType=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, tagString=None, x__xgafv=None)</code> 422 <pre>Retrieves a list of floodlight activities, possibly filtered. This method supports paging. 423 424Args: 425 profileId: string, User profile ID associated with this request. (required) 426 advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. 427 floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated) 428 floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name. 429 floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string. 430 floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type. 431 Allowed values 432 COUNTER - 433 SALE - 434 floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. 435 ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated) 436 maxResults: integer, Maximum number of results to return. 437 pageToken: string, Value of the nextPageToken from the previous result page. 438 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity". 439 sortField: string, Field by which to sort the list. 440 Allowed values 441 ID - 442 NAME - 443 sortOrder: string, Order of sorted results. 444 Allowed values 445 ASCENDING - 446 DESCENDING - 447 tagString: string, Select only floodlight activities with the specified tag string. 448 x__xgafv: string, V1 error format. 449 Allowed values 450 1 - v1 error format 451 2 - v2 error format 452 453Returns: 454 An object of the form: 455 456 { # Floodlight Activity List Response 457 "floodlightActivities": [ # Floodlight activity collection. 458 { # Contains properties of a Floodlight activity. 459 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 460 "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. 461 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 462 "dimensionName": "A String", # The name of the dimension. 463 "etag": "A String", # The eTag of this response for caching purposes. 464 "id": "A String", # The ID associated with the value if available. 465 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 466 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 467 "value": "A String", # The value of the dimension. 468 }, 469 "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. 470 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 471 "defaultTags": [ # Dynamic floodlight tags. 472 { # Dynamic Tag 473 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 474 "name": "A String", # Name of this tag. 475 "tag": "A String", # Tag code. 476 }, 477 ], 478 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 479 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 480 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 481 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 482 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 483 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. 484 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 485 "dimensionName": "A String", # The name of the dimension. 486 "etag": "A String", # The eTag of this response for caching purposes. 487 "id": "A String", # The ID associated with the value if available. 488 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 489 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 490 "value": "A String", # The value of the dimension. 491 }, 492 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 493 "hidden": True or False, # Whether this activity is archived. 494 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 495 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 496 "dimensionName": "A String", # The name of the dimension. 497 "etag": "A String", # The eTag of this response for caching purposes. 498 "id": "A String", # The ID associated with the value if available. 499 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 500 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 501 "value": "A String", # The value of the dimension. 502 }, 503 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 504 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 505 "notes": "A String", # General notes or implementation instructions for the tag. 506 "publisherTags": [ # Publisher dynamic floodlight tags. 507 { # Publisher Dynamic Tag 508 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 509 "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. 510 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 511 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 512 "name": "A String", # Name of this tag. 513 "tag": "A String", # Tag code. 514 }, 515 "siteId": "A String", # Site ID of this dynamic tag. 516 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 517 "dimensionName": "A String", # The name of the dimension. 518 "etag": "A String", # The eTag of this response for caching purposes. 519 "id": "A String", # The ID associated with the value if available. 520 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 521 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 522 "value": "A String", # The value of the dimension. 523 }, 524 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 525 }, 526 ], 527 "secure": True or False, # Whether this tag should use SSL. 528 "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. 529 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 530 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 531 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 532 "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 533 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. 534 "A String", 535 ], 536 }, 537 ], 538 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". 539 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 540}</pre> 541</div> 542 543<div class="method"> 544 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 545 <pre>Retrieves the next page of results. 546 547Args: 548 previous_request: The request for the previous page. (required) 549 previous_response: The response from the request for the previous page. (required) 550 551Returns: 552 A request object that you can call 'execute()' on to request the next 553 page. Returns None if there are no more items in the collection. 554 </pre> 555</div> 556 557<div class="method"> 558 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 559 <pre>Updates an existing floodlight activity. This method supports patch semantics. 560 561Args: 562 profileId: string, User profile ID associated with this request. (required) 563 id: string, FloodlightActivity ID. (required) 564 body: object, The request body. 565 The object takes the form of: 566 567{ # Contains properties of a Floodlight activity. 568 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 569 "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. 570 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 571 "dimensionName": "A String", # The name of the dimension. 572 "etag": "A String", # The eTag of this response for caching purposes. 573 "id": "A String", # The ID associated with the value if available. 574 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 575 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 576 "value": "A String", # The value of the dimension. 577 }, 578 "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. 579 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 580 "defaultTags": [ # Dynamic floodlight tags. 581 { # Dynamic Tag 582 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 583 "name": "A String", # Name of this tag. 584 "tag": "A String", # Tag code. 585 }, 586 ], 587 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 588 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 589 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 590 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 591 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 592 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. 593 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 594 "dimensionName": "A String", # The name of the dimension. 595 "etag": "A String", # The eTag of this response for caching purposes. 596 "id": "A String", # The ID associated with the value if available. 597 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 598 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 599 "value": "A String", # The value of the dimension. 600 }, 601 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 602 "hidden": True or False, # Whether this activity is archived. 603 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 604 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 605 "dimensionName": "A String", # The name of the dimension. 606 "etag": "A String", # The eTag of this response for caching purposes. 607 "id": "A String", # The ID associated with the value if available. 608 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 609 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 610 "value": "A String", # The value of the dimension. 611 }, 612 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 613 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 614 "notes": "A String", # General notes or implementation instructions for the tag. 615 "publisherTags": [ # Publisher dynamic floodlight tags. 616 { # Publisher Dynamic Tag 617 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 618 "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. 619 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 620 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 621 "name": "A String", # Name of this tag. 622 "tag": "A String", # Tag code. 623 }, 624 "siteId": "A String", # Site ID of this dynamic tag. 625 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 626 "dimensionName": "A String", # The name of the dimension. 627 "etag": "A String", # The eTag of this response for caching purposes. 628 "id": "A String", # The ID associated with the value if available. 629 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 630 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 631 "value": "A String", # The value of the dimension. 632 }, 633 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 634 }, 635 ], 636 "secure": True or False, # Whether this tag should use SSL. 637 "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. 638 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 639 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 640 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 641 "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 642 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. 643 "A String", 644 ], 645} 646 647 x__xgafv: string, V1 error format. 648 Allowed values 649 1 - v1 error format 650 2 - v2 error format 651 652Returns: 653 An object of the form: 654 655 { # Contains properties of a Floodlight activity. 656 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 657 "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. 658 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 659 "dimensionName": "A String", # The name of the dimension. 660 "etag": "A String", # The eTag of this response for caching purposes. 661 "id": "A String", # The ID associated with the value if available. 662 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 663 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 664 "value": "A String", # The value of the dimension. 665 }, 666 "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. 667 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 668 "defaultTags": [ # Dynamic floodlight tags. 669 { # Dynamic Tag 670 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 671 "name": "A String", # Name of this tag. 672 "tag": "A String", # Tag code. 673 }, 674 ], 675 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 676 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 677 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 678 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 679 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 680 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. 681 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 682 "dimensionName": "A String", # The name of the dimension. 683 "etag": "A String", # The eTag of this response for caching purposes. 684 "id": "A String", # The ID associated with the value if available. 685 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 686 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 687 "value": "A String", # The value of the dimension. 688 }, 689 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 690 "hidden": True or False, # Whether this activity is archived. 691 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 692 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 693 "dimensionName": "A String", # The name of the dimension. 694 "etag": "A String", # The eTag of this response for caching purposes. 695 "id": "A String", # The ID associated with the value if available. 696 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 697 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 698 "value": "A String", # The value of the dimension. 699 }, 700 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 701 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 702 "notes": "A String", # General notes or implementation instructions for the tag. 703 "publisherTags": [ # Publisher dynamic floodlight tags. 704 { # Publisher Dynamic Tag 705 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 706 "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. 707 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 708 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 709 "name": "A String", # Name of this tag. 710 "tag": "A String", # Tag code. 711 }, 712 "siteId": "A String", # Site ID of this dynamic tag. 713 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 714 "dimensionName": "A String", # The name of the dimension. 715 "etag": "A String", # The eTag of this response for caching purposes. 716 "id": "A String", # The ID associated with the value if available. 717 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 718 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 719 "value": "A String", # The value of the dimension. 720 }, 721 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 722 }, 723 ], 724 "secure": True or False, # Whether this tag should use SSL. 725 "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. 726 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 727 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 728 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 729 "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 730 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. 731 "A String", 732 ], 733}</pre> 734</div> 735 736<div class="method"> 737 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 738 <pre>Updates an existing floodlight activity. 739 740Args: 741 profileId: string, User profile ID associated with this request. (required) 742 body: object, The request body. 743 The object takes the form of: 744 745{ # Contains properties of a Floodlight activity. 746 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 747 "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. 748 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 749 "dimensionName": "A String", # The name of the dimension. 750 "etag": "A String", # The eTag of this response for caching purposes. 751 "id": "A String", # The ID associated with the value if available. 752 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 753 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 754 "value": "A String", # The value of the dimension. 755 }, 756 "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. 757 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 758 "defaultTags": [ # Dynamic floodlight tags. 759 { # Dynamic Tag 760 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 761 "name": "A String", # Name of this tag. 762 "tag": "A String", # Tag code. 763 }, 764 ], 765 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 766 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 767 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 768 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 769 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 770 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. 771 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 772 "dimensionName": "A String", # The name of the dimension. 773 "etag": "A String", # The eTag of this response for caching purposes. 774 "id": "A String", # The ID associated with the value if available. 775 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 776 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 777 "value": "A String", # The value of the dimension. 778 }, 779 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 780 "hidden": True or False, # Whether this activity is archived. 781 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 782 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 783 "dimensionName": "A String", # The name of the dimension. 784 "etag": "A String", # The eTag of this response for caching purposes. 785 "id": "A String", # The ID associated with the value if available. 786 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 787 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 788 "value": "A String", # The value of the dimension. 789 }, 790 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 791 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 792 "notes": "A String", # General notes or implementation instructions for the tag. 793 "publisherTags": [ # Publisher dynamic floodlight tags. 794 { # Publisher Dynamic Tag 795 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 796 "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. 797 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 798 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 799 "name": "A String", # Name of this tag. 800 "tag": "A String", # Tag code. 801 }, 802 "siteId": "A String", # Site ID of this dynamic tag. 803 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 804 "dimensionName": "A String", # The name of the dimension. 805 "etag": "A String", # The eTag of this response for caching purposes. 806 "id": "A String", # The ID associated with the value if available. 807 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 808 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 809 "value": "A String", # The value of the dimension. 810 }, 811 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 812 }, 813 ], 814 "secure": True or False, # Whether this tag should use SSL. 815 "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. 816 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 817 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 818 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 819 "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 820 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. 821 "A String", 822 ], 823} 824 825 x__xgafv: string, V1 error format. 826 Allowed values 827 1 - v1 error format 828 2 - v2 error format 829 830Returns: 831 An object of the form: 832 833 { # Contains properties of a Floodlight activity. 834 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 835 "advertiserId": "A String", # Advertiser ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's advertiser or the existing activity's advertiser. 836 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 837 "dimensionName": "A String", # The name of the dimension. 838 "etag": "A String", # The eTag of this response for caching purposes. 839 "id": "A String", # The ID associated with the value if available. 840 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 841 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 842 "value": "A String", # The value of the dimension. 843 }, 844 "cacheBustingType": "A String", # Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. 845 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 846 "defaultTags": [ # Dynamic floodlight tags. 847 { # Dynamic Tag 848 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 849 "name": "A String", # Name of this tag. 850 "tag": "A String", # Tag code. 851 }, 852 ], 853 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 854 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 855 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 856 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 857 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 858 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity. If this field is left blank, the value will be copied over either from the activity group's floodlight configuration or from the existing activity's floodlight configuration. 859 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 860 "dimensionName": "A String", # The name of the dimension. 861 "etag": "A String", # The eTag of this response for caching purposes. 862 "id": "A String", # The ID associated with the value if available. 863 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 864 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 865 "value": "A String", # The value of the dimension. 866 }, 867 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 868 "hidden": True or False, # Whether this activity is archived. 869 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 870 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 871 "dimensionName": "A String", # The name of the dimension. 872 "etag": "A String", # The eTag of this response for caching purposes. 873 "id": "A String", # The ID associated with the value if available. 874 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 875 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 876 "value": "A String", # The value of the dimension. 877 }, 878 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 879 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 880 "notes": "A String", # General notes or implementation instructions for the tag. 881 "publisherTags": [ # Publisher dynamic floodlight tags. 882 { # Publisher Dynamic Tag 883 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 884 "directorySiteId": "A String", # Directory site ID of this dynamic tag. This is a write-only field that can be used as an alternative to the siteId field. When this resource is retrieved, only the siteId field will be populated. 885 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 886 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 887 "name": "A String", # Name of this tag. 888 "tag": "A String", # Tag code. 889 }, 890 "siteId": "A String", # Site ID of this dynamic tag. 891 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 892 "dimensionName": "A String", # The name of the dimension. 893 "etag": "A String", # The eTag of this response for caching purposes. 894 "id": "A String", # The ID associated with the value if available. 895 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 896 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 897 "value": "A String", # The value of the dimension. 898 }, 899 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 900 }, 901 ], 902 "secure": True or False, # Whether this tag should use SSL. 903 "sslCompliant": True or False, # Whether the floodlight activity is SSL-compliant. This is a read-only field, its value detected by the system from the floodlight tags. 904 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 905 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 906 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 907 "tagString": "A String", # Value of the cat= parameter in the floodlight tag, which the ad servers use to identify the activity. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 908 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-100]=" in the tags. Each of these can have a user defined type. Acceptable values are U1 to U100, inclusive. 909 "A String", 910 ], 911}</pre> 912</div> 913 914</body></html>