1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="dfareporting_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.floodlightActivities.html">floodlightActivities</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(profileId, id)</a></code></p> 79 <p class="firstline">Deletes an existing floodlight activity.</p> 80 <p class="toc_element"> 81 <code><a href="#generatetag">generatetag(profileId, floodlightActivityId=None)</a></code></p> 82 <p class="firstline">Generates a tag for a floodlight activity.</p> 83 <p class="toc_element"> 84 <code><a href="#get">get(profileId, id)</a></code></p> 85 <p class="firstline">Gets one floodlight activity by ID.</p> 86 <p class="toc_element"> 87 <code><a href="#insert">insert(profileId, body)</a></code></p> 88 <p class="firstline">Inserts a new floodlight activity.</p> 89 <p class="toc_element"> 90 <code><a href="#list">list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)</a></code></p> 91 <p class="firstline">Retrieves a list of floodlight activities, possibly filtered. This method supports paging.</p> 92 <p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94 <p class="firstline">Retrieves the next page of results.</p> 95 <p class="toc_element"> 96 <code><a href="#patch">patch(profileId, id, body)</a></code></p> 97 <p class="firstline">Updates an existing floodlight activity. This method supports patch semantics.</p> 98 <p class="toc_element"> 99 <code><a href="#update">update(profileId, body)</a></code></p> 100 <p class="firstline">Updates an existing floodlight activity.</p> 101 <h3>Method Details</h3> 102 <div class="method"> 103 <code class="details" id="delete">delete(profileId, id)</code> 104 <pre>Deletes an existing floodlight activity. 105 106 Args: 107 profileId: string, User profile ID associated with this request. (required) 108 id: string, Floodlight activity ID. (required) 109 </pre> 110 </div> 111 112 <div class="method"> 113 <code class="details" id="generatetag">generatetag(profileId, floodlightActivityId=None)</code> 114 <pre>Generates a tag for a floodlight activity. 115 116 Args: 117 profileId: string, User profile ID associated with this request. (required) 118 floodlightActivityId: string, Floodlight activity ID for which we want to generate a tag. 119 120 Returns: 121 An object of the form: 122 123 { # Floodlight Activity GenerateTag Response 124 "kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". 125 "floodlightActivityTag": "A String", # Generated tag for this floodlight activity. 126 }</pre> 127 </div> 128 129 <div class="method"> 130 <code class="details" id="get">get(profileId, id)</code> 131 <pre>Gets one floodlight activity by ID. 132 133 Args: 134 profileId: string, User profile ID associated with this request. (required) 135 id: string, Floodlight activity ID. (required) 136 137 Returns: 138 An object of the form: 139 140 { # Contains properties of a Floodlight activity. 141 "tagString": "A String", # Value of the cat= paramter 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-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 142 "secure": True or False, # Whether this tag should use SSL. 143 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 144 "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity. 145 "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. 146 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 147 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 148 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 149 "value": "A String", # The value of the dimension. 150 "dimensionName": "A String", # The name of the dimension. 151 "etag": "A String", # The eTag of this response for caching purposes. 152 "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. 153 "id": "A String", # The ID associated with the value if available. 154 }, 155 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 156 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 157 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 158 "publisherTags": [ # Publisher dynamic floodlight tags. 159 { # Publisher Dynamic Tag 160 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 161 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 162 "siteId": "A String", # Site ID of this dynamic tag. 163 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 164 "tag": "A String", # Tag code. 165 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 166 "name": "A String", # Name of this tag. 167 }, 168 "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. 169 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 170 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 171 "value": "A String", # The value of the dimension. 172 "dimensionName": "A String", # The name of the dimension. 173 "etag": "A String", # The eTag of this response for caching purposes. 174 "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. 175 "id": "A String", # The ID associated with the value if available. 176 }, 177 }, 178 ], 179 "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. 180 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 181 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 182 "value": "A String", # The value of the dimension. 183 "dimensionName": "A String", # The name of the dimension. 184 "etag": "A String", # The eTag of this response for caching purposes. 185 "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. 186 "id": "A String", # The ID associated with the value if available. 187 }, 188 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 189 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 190 "value": "A String", # The value of the dimension. 191 "dimensionName": "A String", # The name of the dimension. 192 "etag": "A String", # The eTag of this response for caching purposes. 193 "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. 194 "id": "A String", # The ID associated with the value if available. 195 }, 196 "hidden": True or False, # Whether this activity is archived. 197 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 198 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 199 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 200 "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. 201 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 202 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 203 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 204 "notes": "A String", # General notes or implementation instructions for the tag. 205 "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. 206 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. 207 # Acceptable values are: 208 # - "U1" 209 # - "U2" 210 # - "U3" 211 # - "U4" 212 # - "U5" 213 # - "U6" 214 # - "U7" 215 # - "U8" 216 # - "U9" 217 # - "U10" 218 # - "U11" 219 # - "U12" 220 # - "U13" 221 # - "U14" 222 # - "U15" 223 # - "U16" 224 # - "U17" 225 # - "U18" 226 # - "U19" 227 # - "U20" 228 "A String", 229 ], 230 "defaultTags": [ # Dynamic floodlight tags. 231 { # Dynamic Tag 232 "tag": "A String", # Tag code. 233 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 234 "name": "A String", # Name of this tag. 235 }, 236 ], 237 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 238 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 239 }</pre> 240 </div> 241 242 <div class="method"> 243 <code class="details" id="insert">insert(profileId, body)</code> 244 <pre>Inserts a new floodlight activity. 245 246 Args: 247 profileId: string, User profile ID associated with this request. (required) 248 body: object, The request body. (required) 249 The object takes the form of: 250 251 { # Contains properties of a Floodlight activity. 252 "tagString": "A String", # Value of the cat= paramter 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-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 253 "secure": True or False, # Whether this tag should use SSL. 254 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 255 "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity. 256 "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. 257 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 258 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 259 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 260 "value": "A String", # The value of the dimension. 261 "dimensionName": "A String", # The name of the dimension. 262 "etag": "A String", # The eTag of this response for caching purposes. 263 "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. 264 "id": "A String", # The ID associated with the value if available. 265 }, 266 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 267 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 268 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 269 "publisherTags": [ # Publisher dynamic floodlight tags. 270 { # Publisher Dynamic Tag 271 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 272 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 273 "siteId": "A String", # Site ID of this dynamic tag. 274 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 275 "tag": "A String", # Tag code. 276 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 277 "name": "A String", # Name of this tag. 278 }, 279 "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. 280 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 281 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 282 "value": "A String", # The value of the dimension. 283 "dimensionName": "A String", # The name of the dimension. 284 "etag": "A String", # The eTag of this response for caching purposes. 285 "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. 286 "id": "A String", # The ID associated with the value if available. 287 }, 288 }, 289 ], 290 "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. 291 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 292 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 293 "value": "A String", # The value of the dimension. 294 "dimensionName": "A String", # The name of the dimension. 295 "etag": "A String", # The eTag of this response for caching purposes. 296 "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. 297 "id": "A String", # The ID associated with the value if available. 298 }, 299 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 300 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 301 "value": "A String", # The value of the dimension. 302 "dimensionName": "A String", # The name of the dimension. 303 "etag": "A String", # The eTag of this response for caching purposes. 304 "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. 305 "id": "A String", # The ID associated with the value if available. 306 }, 307 "hidden": True or False, # Whether this activity is archived. 308 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 309 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 310 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 311 "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. 312 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 313 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 314 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 315 "notes": "A String", # General notes or implementation instructions for the tag. 316 "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. 317 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. 318 # Acceptable values are: 319 # - "U1" 320 # - "U2" 321 # - "U3" 322 # - "U4" 323 # - "U5" 324 # - "U6" 325 # - "U7" 326 # - "U8" 327 # - "U9" 328 # - "U10" 329 # - "U11" 330 # - "U12" 331 # - "U13" 332 # - "U14" 333 # - "U15" 334 # - "U16" 335 # - "U17" 336 # - "U18" 337 # - "U19" 338 # - "U20" 339 "A String", 340 ], 341 "defaultTags": [ # Dynamic floodlight tags. 342 { # Dynamic Tag 343 "tag": "A String", # Tag code. 344 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 345 "name": "A String", # Name of this tag. 346 }, 347 ], 348 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 349 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 350 } 351 352 353 Returns: 354 An object of the form: 355 356 { # Contains properties of a Floodlight activity. 357 "tagString": "A String", # Value of the cat= paramter 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-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 358 "secure": True or False, # Whether this tag should use SSL. 359 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 360 "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity. 361 "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. 362 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 363 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 364 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 365 "value": "A String", # The value of the dimension. 366 "dimensionName": "A String", # The name of the dimension. 367 "etag": "A String", # The eTag of this response for caching purposes. 368 "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. 369 "id": "A String", # The ID associated with the value if available. 370 }, 371 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 372 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 373 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 374 "publisherTags": [ # Publisher dynamic floodlight tags. 375 { # Publisher Dynamic Tag 376 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 377 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 378 "siteId": "A String", # Site ID of this dynamic tag. 379 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 380 "tag": "A String", # Tag code. 381 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 382 "name": "A String", # Name of this tag. 383 }, 384 "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. 385 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 386 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 387 "value": "A String", # The value of the dimension. 388 "dimensionName": "A String", # The name of the dimension. 389 "etag": "A String", # The eTag of this response for caching purposes. 390 "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. 391 "id": "A String", # The ID associated with the value if available. 392 }, 393 }, 394 ], 395 "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. 396 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 397 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 398 "value": "A String", # The value of the dimension. 399 "dimensionName": "A String", # The name of the dimension. 400 "etag": "A String", # The eTag of this response for caching purposes. 401 "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. 402 "id": "A String", # The ID associated with the value if available. 403 }, 404 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 405 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 406 "value": "A String", # The value of the dimension. 407 "dimensionName": "A String", # The name of the dimension. 408 "etag": "A String", # The eTag of this response for caching purposes. 409 "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. 410 "id": "A String", # The ID associated with the value if available. 411 }, 412 "hidden": True or False, # Whether this activity is archived. 413 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 414 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 415 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 416 "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. 417 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 418 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 419 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 420 "notes": "A String", # General notes or implementation instructions for the tag. 421 "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. 422 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. 423 # Acceptable values are: 424 # - "U1" 425 # - "U2" 426 # - "U3" 427 # - "U4" 428 # - "U5" 429 # - "U6" 430 # - "U7" 431 # - "U8" 432 # - "U9" 433 # - "U10" 434 # - "U11" 435 # - "U12" 436 # - "U13" 437 # - "U14" 438 # - "U15" 439 # - "U16" 440 # - "U17" 441 # - "U18" 442 # - "U19" 443 # - "U20" 444 "A String", 445 ], 446 "defaultTags": [ # Dynamic floodlight tags. 447 { # Dynamic Tag 448 "tag": "A String", # Tag code. 449 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 450 "name": "A String", # Name of this tag. 451 }, 452 ], 453 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 454 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 455 }</pre> 456 </div> 457 458 <div class="method"> 459 <code class="details" id="list">list(profileId, floodlightActivityGroupName=None, advertiserId=None, tagString=None, floodlightActivityGroupTagString=None, floodlightActivityGroupIds=None, pageToken=None, sortOrder=None, maxResults=None, searchString=None, sortField=None, floodlightConfigurationId=None, ids=None, floodlightActivityGroupType=None)</code> 460 <pre>Retrieves a list of floodlight activities, possibly filtered. This method supports paging. 461 462 Args: 463 profileId: string, User profile ID associated with this request. (required) 464 floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name. 465 advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. 466 tagString: string, Select only floodlight activities with the specified tag string. 467 floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string. 468 floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated) 469 pageToken: string, Value of the nextPageToken from the previous result page. 470 sortOrder: string, Order of sorted results. 471 Allowed values 472 ASCENDING - 473 DESCENDING - 474 maxResults: integer, Maximum number of results to return. 475 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". 476 sortField: string, Field by which to sort the list. 477 Allowed values 478 ID - 479 NAME - 480 floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. 481 ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated) 482 floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type. 483 Allowed values 484 COUNTER - 485 SALE - 486 487 Returns: 488 An object of the form: 489 490 { # Floodlight Activity List Response 491 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 492 "kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". 493 "floodlightActivities": [ # Floodlight activity collection. 494 { # Contains properties of a Floodlight activity. 495 "tagString": "A String", # Value of the cat= paramter 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-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 496 "secure": True or False, # Whether this tag should use SSL. 497 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 498 "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity. 499 "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. 500 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 501 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 502 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 503 "value": "A String", # The value of the dimension. 504 "dimensionName": "A String", # The name of the dimension. 505 "etag": "A String", # The eTag of this response for caching purposes. 506 "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. 507 "id": "A String", # The ID associated with the value if available. 508 }, 509 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 510 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 511 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 512 "publisherTags": [ # Publisher dynamic floodlight tags. 513 { # Publisher Dynamic Tag 514 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 515 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 516 "siteId": "A String", # Site ID of this dynamic tag. 517 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 518 "tag": "A String", # Tag code. 519 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 520 "name": "A String", # Name of this tag. 521 }, 522 "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. 523 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 524 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 525 "value": "A String", # The value of the dimension. 526 "dimensionName": "A String", # The name of the dimension. 527 "etag": "A String", # The eTag of this response for caching purposes. 528 "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. 529 "id": "A String", # The ID associated with the value if available. 530 }, 531 }, 532 ], 533 "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. 534 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 535 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 536 "value": "A String", # The value of the dimension. 537 "dimensionName": "A String", # The name of the dimension. 538 "etag": "A String", # The eTag of this response for caching purposes. 539 "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. 540 "id": "A String", # The ID associated with the value if available. 541 }, 542 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 543 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 544 "value": "A String", # The value of the dimension. 545 "dimensionName": "A String", # The name of the dimension. 546 "etag": "A String", # The eTag of this response for caching purposes. 547 "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. 548 "id": "A String", # The ID associated with the value if available. 549 }, 550 "hidden": True or False, # Whether this activity is archived. 551 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 552 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 553 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 554 "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. 555 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 556 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 557 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 558 "notes": "A String", # General notes or implementation instructions for the tag. 559 "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. 560 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. 561 # Acceptable values are: 562 # - "U1" 563 # - "U2" 564 # - "U3" 565 # - "U4" 566 # - "U5" 567 # - "U6" 568 # - "U7" 569 # - "U8" 570 # - "U9" 571 # - "U10" 572 # - "U11" 573 # - "U12" 574 # - "U13" 575 # - "U14" 576 # - "U15" 577 # - "U16" 578 # - "U17" 579 # - "U18" 580 # - "U19" 581 # - "U20" 582 "A String", 583 ], 584 "defaultTags": [ # Dynamic floodlight tags. 585 { # Dynamic Tag 586 "tag": "A String", # Tag code. 587 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 588 "name": "A String", # Name of this tag. 589 }, 590 ], 591 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 592 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 593 }, 594 ], 595 }</pre> 596 </div> 597 598 <div class="method"> 599 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 600 <pre>Retrieves the next page of results. 601 602 Args: 603 previous_request: The request for the previous page. (required) 604 previous_response: The response from the request for the previous page. (required) 605 606 Returns: 607 A request object that you can call 'execute()' on to request the next 608 page. Returns None if there are no more items in the collection. 609 </pre> 610 </div> 611 612 <div class="method"> 613 <code class="details" id="patch">patch(profileId, id, body)</code> 614 <pre>Updates an existing floodlight activity. This method supports patch semantics. 615 616 Args: 617 profileId: string, User profile ID associated with this request. (required) 618 id: string, Floodlight activity ID. (required) 619 body: object, The request body. (required) 620 The object takes the form of: 621 622 { # Contains properties of a Floodlight activity. 623 "tagString": "A String", # Value of the cat= paramter 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-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 624 "secure": True or False, # Whether this tag should use SSL. 625 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 626 "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity. 627 "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. 628 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 629 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 630 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 631 "value": "A String", # The value of the dimension. 632 "dimensionName": "A String", # The name of the dimension. 633 "etag": "A String", # The eTag of this response for caching purposes. 634 "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. 635 "id": "A String", # The ID associated with the value if available. 636 }, 637 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 638 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 639 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 640 "publisherTags": [ # Publisher dynamic floodlight tags. 641 { # Publisher Dynamic Tag 642 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 643 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 644 "siteId": "A String", # Site ID of this dynamic tag. 645 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 646 "tag": "A String", # Tag code. 647 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 648 "name": "A String", # Name of this tag. 649 }, 650 "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. 651 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 652 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 653 "value": "A String", # The value of the dimension. 654 "dimensionName": "A String", # The name of the dimension. 655 "etag": "A String", # The eTag of this response for caching purposes. 656 "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. 657 "id": "A String", # The ID associated with the value if available. 658 }, 659 }, 660 ], 661 "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. 662 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 663 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 664 "value": "A String", # The value of the dimension. 665 "dimensionName": "A String", # The name of the dimension. 666 "etag": "A String", # The eTag of this response for caching purposes. 667 "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. 668 "id": "A String", # The ID associated with the value if available. 669 }, 670 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 671 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 672 "value": "A String", # The value of the dimension. 673 "dimensionName": "A String", # The name of the dimension. 674 "etag": "A String", # The eTag of this response for caching purposes. 675 "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. 676 "id": "A String", # The ID associated with the value if available. 677 }, 678 "hidden": True or False, # Whether this activity is archived. 679 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 680 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 681 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 682 "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. 683 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 684 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 685 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 686 "notes": "A String", # General notes or implementation instructions for the tag. 687 "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. 688 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. 689 # Acceptable values are: 690 # - "U1" 691 # - "U2" 692 # - "U3" 693 # - "U4" 694 # - "U5" 695 # - "U6" 696 # - "U7" 697 # - "U8" 698 # - "U9" 699 # - "U10" 700 # - "U11" 701 # - "U12" 702 # - "U13" 703 # - "U14" 704 # - "U15" 705 # - "U16" 706 # - "U17" 707 # - "U18" 708 # - "U19" 709 # - "U20" 710 "A String", 711 ], 712 "defaultTags": [ # Dynamic floodlight tags. 713 { # Dynamic Tag 714 "tag": "A String", # Tag code. 715 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 716 "name": "A String", # Name of this tag. 717 }, 718 ], 719 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 720 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 721 } 722 723 724 Returns: 725 An object of the form: 726 727 { # Contains properties of a Floodlight activity. 728 "tagString": "A String", # Value of the cat= paramter 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-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 729 "secure": True or False, # Whether this tag should use SSL. 730 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 731 "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity. 732 "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. 733 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 734 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 735 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 736 "value": "A String", # The value of the dimension. 737 "dimensionName": "A String", # The name of the dimension. 738 "etag": "A String", # The eTag of this response for caching purposes. 739 "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. 740 "id": "A String", # The ID associated with the value if available. 741 }, 742 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 743 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 744 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 745 "publisherTags": [ # Publisher dynamic floodlight tags. 746 { # Publisher Dynamic Tag 747 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 748 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 749 "siteId": "A String", # Site ID of this dynamic tag. 750 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 751 "tag": "A String", # Tag code. 752 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 753 "name": "A String", # Name of this tag. 754 }, 755 "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. 756 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 757 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 758 "value": "A String", # The value of the dimension. 759 "dimensionName": "A String", # The name of the dimension. 760 "etag": "A String", # The eTag of this response for caching purposes. 761 "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. 762 "id": "A String", # The ID associated with the value if available. 763 }, 764 }, 765 ], 766 "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. 767 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 768 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 769 "value": "A String", # The value of the dimension. 770 "dimensionName": "A String", # The name of the dimension. 771 "etag": "A String", # The eTag of this response for caching purposes. 772 "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. 773 "id": "A String", # The ID associated with the value if available. 774 }, 775 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 776 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 777 "value": "A String", # The value of the dimension. 778 "dimensionName": "A String", # The name of the dimension. 779 "etag": "A String", # The eTag of this response for caching purposes. 780 "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. 781 "id": "A String", # The ID associated with the value if available. 782 }, 783 "hidden": True or False, # Whether this activity is archived. 784 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 785 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 786 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 787 "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. 788 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 789 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 790 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 791 "notes": "A String", # General notes or implementation instructions for the tag. 792 "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. 793 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. 794 # Acceptable values are: 795 # - "U1" 796 # - "U2" 797 # - "U3" 798 # - "U4" 799 # - "U5" 800 # - "U6" 801 # - "U7" 802 # - "U8" 803 # - "U9" 804 # - "U10" 805 # - "U11" 806 # - "U12" 807 # - "U13" 808 # - "U14" 809 # - "U15" 810 # - "U16" 811 # - "U17" 812 # - "U18" 813 # - "U19" 814 # - "U20" 815 "A String", 816 ], 817 "defaultTags": [ # Dynamic floodlight tags. 818 { # Dynamic Tag 819 "tag": "A String", # Tag code. 820 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 821 "name": "A String", # Name of this tag. 822 }, 823 ], 824 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 825 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 826 }</pre> 827 </div> 828 829 <div class="method"> 830 <code class="details" id="update">update(profileId, body)</code> 831 <pre>Updates an existing floodlight activity. 832 833 Args: 834 profileId: string, User profile ID associated with this request. (required) 835 body: object, The request body. (required) 836 The object takes the form of: 837 838 { # Contains properties of a Floodlight activity. 839 "tagString": "A String", # Value of the cat= paramter 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-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 840 "secure": True or False, # Whether this tag should use SSL. 841 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 842 "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity. 843 "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. 844 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 845 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 846 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 847 "value": "A String", # The value of the dimension. 848 "dimensionName": "A String", # The name of the dimension. 849 "etag": "A String", # The eTag of this response for caching purposes. 850 "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. 851 "id": "A String", # The ID associated with the value if available. 852 }, 853 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 854 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 855 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 856 "publisherTags": [ # Publisher dynamic floodlight tags. 857 { # Publisher Dynamic Tag 858 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 859 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 860 "siteId": "A String", # Site ID of this dynamic tag. 861 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 862 "tag": "A String", # Tag code. 863 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 864 "name": "A String", # Name of this tag. 865 }, 866 "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. 867 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 868 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 869 "value": "A String", # The value of the dimension. 870 "dimensionName": "A String", # The name of the dimension. 871 "etag": "A String", # The eTag of this response for caching purposes. 872 "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. 873 "id": "A String", # The ID associated with the value if available. 874 }, 875 }, 876 ], 877 "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. 878 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 879 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 880 "value": "A String", # The value of the dimension. 881 "dimensionName": "A String", # The name of the dimension. 882 "etag": "A String", # The eTag of this response for caching purposes. 883 "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. 884 "id": "A String", # The ID associated with the value if available. 885 }, 886 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 887 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 888 "value": "A String", # The value of the dimension. 889 "dimensionName": "A String", # The name of the dimension. 890 "etag": "A String", # The eTag of this response for caching purposes. 891 "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. 892 "id": "A String", # The ID associated with the value if available. 893 }, 894 "hidden": True or False, # Whether this activity is archived. 895 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 896 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 897 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 898 "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. 899 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 900 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 901 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 902 "notes": "A String", # General notes or implementation instructions for the tag. 903 "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. 904 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. 905 # Acceptable values are: 906 # - "U1" 907 # - "U2" 908 # - "U3" 909 # - "U4" 910 # - "U5" 911 # - "U6" 912 # - "U7" 913 # - "U8" 914 # - "U9" 915 # - "U10" 916 # - "U11" 917 # - "U12" 918 # - "U13" 919 # - "U14" 920 # - "U15" 921 # - "U16" 922 # - "U17" 923 # - "U18" 924 # - "U19" 925 # - "U20" 926 "A String", 927 ], 928 "defaultTags": [ # Dynamic floodlight tags. 929 { # Dynamic Tag 930 "tag": "A String", # Tag code. 931 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 932 "name": "A String", # Name of this tag. 933 }, 934 ], 935 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 936 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 937 } 938 939 940 Returns: 941 An object of the form: 942 943 { # Contains properties of a Floodlight activity. 944 "tagString": "A String", # Value of the cat= paramter 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-z][A-Z][0-9][-][ _ ]. This tag string must also be unique among activities of the same activity group. This field is read-only after insertion. 945 "secure": True or False, # Whether this tag should use SSL. 946 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 947 "imageTagEnabled": True or False, # Whether the image tag is enabled for this activity. 948 "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. 949 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 950 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 951 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 952 "value": "A String", # The value of the dimension. 953 "dimensionName": "A String", # The name of the dimension. 954 "etag": "A String", # The eTag of this response for caching purposes. 955 "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. 956 "id": "A String", # The ID associated with the value if available. 957 }, 958 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 959 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 960 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 961 "publisherTags": [ # Publisher dynamic floodlight tags. 962 { # Publisher Dynamic Tag 963 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 964 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 965 "siteId": "A String", # Site ID of this dynamic tag. 966 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 967 "tag": "A String", # Tag code. 968 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 969 "name": "A String", # Name of this tag. 970 }, 971 "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. 972 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 973 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 974 "value": "A String", # The value of the dimension. 975 "dimensionName": "A String", # The name of the dimension. 976 "etag": "A String", # The eTag of this response for caching purposes. 977 "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. 978 "id": "A String", # The ID associated with the value if available. 979 }, 980 }, 981 ], 982 "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. 983 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 984 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 985 "value": "A String", # The value of the dimension. 986 "dimensionName": "A String", # The name of the dimension. 987 "etag": "A String", # The eTag of this response for caching purposes. 988 "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. 989 "id": "A String", # The ID associated with the value if available. 990 }, 991 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 992 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 993 "value": "A String", # The value of the dimension. 994 "dimensionName": "A String", # The name of the dimension. 995 "etag": "A String", # The eTag of this response for caching purposes. 996 "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. 997 "id": "A String", # The ID associated with the value if available. 998 }, 999 "hidden": True or False, # Whether this activity is archived. 1000 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 1001 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 1002 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 1003 "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. 1004 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 1005 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 1006 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 1007 "notes": "A String", # General notes or implementation instructions for the tag. 1008 "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. 1009 "userDefinedVariableTypes": [ # List of the user-defined variables used by this conversion tag. These map to the "u[1-20]=" in the tags. Each of these can have a user defined type. 1010 # Acceptable values are: 1011 # - "U1" 1012 # - "U2" 1013 # - "U3" 1014 # - "U4" 1015 # - "U5" 1016 # - "U6" 1017 # - "U7" 1018 # - "U8" 1019 # - "U9" 1020 # - "U10" 1021 # - "U11" 1022 # - "U12" 1023 # - "U13" 1024 # - "U14" 1025 # - "U15" 1026 # - "U16" 1027 # - "U17" 1028 # - "U18" 1029 # - "U19" 1030 # - "U20" 1031 "A String", 1032 ], 1033 "defaultTags": [ # Dynamic floodlight tags. 1034 { # Dynamic Tag 1035 "tag": "A String", # Tag code. 1036 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 1037 "name": "A String", # Name of this tag. 1038 }, 1039 ], 1040 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 1041 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 1042 }</pre> 1043 </div> 1044 1045 </body></html>
