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_2.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v3_2.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 106Args: 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 116Args: 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 120Returns: 121 An object of the form: 122 123 { # Floodlight Activity GenerateTag Response 124 "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. 125 "floodlightActivityTag": "A String", # Generated tag for this Floodlight activity. For global site tags, this is the event snippet. 126 "kind": "dfareporting#floodlightActivitiesGenerateTagResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". 127 }</pre> 128</div> 129 130<div class="method"> 131 <code class="details" id="get">get(profileId, id)</code> 132 <pre>Gets one floodlight activity by ID. 133 134Args: 135 profileId: string, User profile ID associated with this request. (required) 136 id: string, Floodlight activity ID. (required) 137 138Returns: 139 An object of the form: 140 141 { # Contains properties of a Floodlight activity. 142 "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-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. 143 "secure": True or False, # Whether this tag should use SSL. 144 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 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 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 200 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 201 "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. 202 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 203 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 204 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 205 "notes": "A String", # General notes or implementation instructions for the tag. 206 "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. 207 "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. 208 # Acceptable values are U1 to U100, inclusive. 209 "A String", 210 ], 211 "defaultTags": [ # Dynamic floodlight tags. 212 { # Dynamic Tag 213 "tag": "A String", # Tag code. 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 }, 217 ], 218 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 219 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 220 }</pre> 221</div> 222 223<div class="method"> 224 <code class="details" id="insert">insert(profileId, body)</code> 225 <pre>Inserts a new floodlight activity. 226 227Args: 228 profileId: string, User profile ID associated with this request. (required) 229 body: object, The request body. (required) 230 The object takes the form of: 231 232{ # Contains properties of a Floodlight activity. 233 "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-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. 234 "secure": True or False, # Whether this tag should use SSL. 235 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 236 "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. 237 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 238 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 239 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 240 "value": "A String", # The value of the dimension. 241 "dimensionName": "A String", # The name of the dimension. 242 "etag": "A String", # The eTag of this response for caching purposes. 243 "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. 244 "id": "A String", # The ID associated with the value if available. 245 }, 246 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 247 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 248 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 249 "publisherTags": [ # Publisher dynamic floodlight tags. 250 { # Publisher Dynamic Tag 251 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 252 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 253 "siteId": "A String", # Site ID of this dynamic tag. 254 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 255 "tag": "A String", # Tag code. 256 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 257 "name": "A String", # Name of this tag. 258 }, 259 "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. 260 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 261 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 262 "value": "A String", # The value of the dimension. 263 "dimensionName": "A String", # The name of the dimension. 264 "etag": "A String", # The eTag of this response for caching purposes. 265 "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. 266 "id": "A String", # The ID associated with the value if available. 267 }, 268 }, 269 ], 270 "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. 271 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 272 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 273 "value": "A String", # The value of the dimension. 274 "dimensionName": "A String", # The name of the dimension. 275 "etag": "A String", # The eTag of this response for caching purposes. 276 "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. 277 "id": "A String", # The ID associated with the value if available. 278 }, 279 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 280 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 281 "value": "A String", # The value of the dimension. 282 "dimensionName": "A String", # The name of the dimension. 283 "etag": "A String", # The eTag of this response for caching purposes. 284 "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. 285 "id": "A String", # The ID associated with the value if available. 286 }, 287 "hidden": True or False, # Whether this activity is archived. 288 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 289 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 290 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 291 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 292 "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. 293 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 294 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 295 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 296 "notes": "A String", # General notes or implementation instructions for the tag. 297 "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. 298 "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. 299 # Acceptable values are U1 to U100, inclusive. 300 "A String", 301 ], 302 "defaultTags": [ # Dynamic floodlight tags. 303 { # Dynamic Tag 304 "tag": "A String", # Tag code. 305 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 306 "name": "A String", # Name of this tag. 307 }, 308 ], 309 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 310 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 311 } 312 313 314Returns: 315 An object of the form: 316 317 { # Contains properties of a Floodlight activity. 318 "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-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. 319 "secure": True or False, # Whether this tag should use SSL. 320 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 321 "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. 322 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 323 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 324 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 325 "value": "A String", # The value of the dimension. 326 "dimensionName": "A String", # The name of the dimension. 327 "etag": "A String", # The eTag of this response for caching purposes. 328 "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. 329 "id": "A String", # The ID associated with the value if available. 330 }, 331 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 332 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 333 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 334 "publisherTags": [ # Publisher dynamic floodlight tags. 335 { # Publisher Dynamic Tag 336 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 337 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 338 "siteId": "A String", # Site ID of this dynamic tag. 339 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 340 "tag": "A String", # Tag code. 341 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 342 "name": "A String", # Name of this tag. 343 }, 344 "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. 345 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 346 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 347 "value": "A String", # The value of the dimension. 348 "dimensionName": "A String", # The name of the dimension. 349 "etag": "A String", # The eTag of this response for caching purposes. 350 "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. 351 "id": "A String", # The ID associated with the value if available. 352 }, 353 }, 354 ], 355 "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. 356 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 357 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 358 "value": "A String", # The value of the dimension. 359 "dimensionName": "A String", # The name of the dimension. 360 "etag": "A String", # The eTag of this response for caching purposes. 361 "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. 362 "id": "A String", # The ID associated with the value if available. 363 }, 364 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 365 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 366 "value": "A String", # The value of the dimension. 367 "dimensionName": "A String", # The name of the dimension. 368 "etag": "A String", # The eTag of this response for caching purposes. 369 "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. 370 "id": "A String", # The ID associated with the value if available. 371 }, 372 "hidden": True or False, # Whether this activity is archived. 373 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 374 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 375 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 376 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 377 "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. 378 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 379 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 380 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 381 "notes": "A String", # General notes or implementation instructions for the tag. 382 "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. 383 "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. 384 # Acceptable values are U1 to U100, inclusive. 385 "A String", 386 ], 387 "defaultTags": [ # Dynamic floodlight tags. 388 { # Dynamic Tag 389 "tag": "A String", # Tag code. 390 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 391 "name": "A String", # Name of this tag. 392 }, 393 ], 394 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 395 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 396 }</pre> 397</div> 398 399<div class="method"> 400 <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> 401 <pre>Retrieves a list of floodlight activities, possibly filtered. This method supports paging. 402 403Args: 404 profileId: string, User profile ID associated with this request. (required) 405 floodlightActivityGroupName: string, Select only floodlight activities with the specified floodlight activity group name. 406 advertiserId: string, Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. 407 tagString: string, Select only floodlight activities with the specified tag string. 408 floodlightActivityGroupTagString: string, Select only floodlight activities with the specified floodlight activity group tag string. 409 floodlightActivityGroupIds: string, Select only floodlight activities with the specified floodlight activity group IDs. (repeated) 410 pageToken: string, Value of the nextPageToken from the previous result page. 411 sortOrder: string, Order of sorted results. 412 Allowed values 413 ASCENDING - 414 DESCENDING - 415 maxResults: integer, Maximum number of results to return. 416 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". 417 sortField: string, Field by which to sort the list. 418 Allowed values 419 ID - 420 NAME - 421 floodlightConfigurationId: string, Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. 422 ids: string, Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result. (repeated) 423 floodlightActivityGroupType: string, Select only floodlight activities with the specified floodlight activity group type. 424 Allowed values 425 COUNTER - 426 SALE - 427 428Returns: 429 An object of the form: 430 431 { # Floodlight Activity List Response 432 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 433 "kind": "dfareporting#floodlightActivitiesListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesListResponse". 434 "floodlightActivities": [ # Floodlight activity collection. 435 { # Contains properties of a Floodlight activity. 436 "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-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. 437 "secure": True or False, # Whether this tag should use SSL. 438 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 439 "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. 440 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 441 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 442 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 443 "value": "A String", # The value of the dimension. 444 "dimensionName": "A String", # The name of the dimension. 445 "etag": "A String", # The eTag of this response for caching purposes. 446 "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. 447 "id": "A String", # The ID associated with the value if available. 448 }, 449 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 450 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 451 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 452 "publisherTags": [ # Publisher dynamic floodlight tags. 453 { # Publisher Dynamic Tag 454 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 455 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 456 "siteId": "A String", # Site ID of this dynamic tag. 457 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 458 "tag": "A String", # Tag code. 459 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 460 "name": "A String", # Name of this tag. 461 }, 462 "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. 463 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 464 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 465 "value": "A String", # The value of the dimension. 466 "dimensionName": "A String", # The name of the dimension. 467 "etag": "A String", # The eTag of this response for caching purposes. 468 "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. 469 "id": "A String", # The ID associated with the value if available. 470 }, 471 }, 472 ], 473 "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. 474 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 475 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 476 "value": "A String", # The value of the dimension. 477 "dimensionName": "A String", # The name of the dimension. 478 "etag": "A String", # The eTag of this response for caching purposes. 479 "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. 480 "id": "A String", # The ID associated with the value if available. 481 }, 482 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 483 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 484 "value": "A String", # The value of the dimension. 485 "dimensionName": "A String", # The name of the dimension. 486 "etag": "A String", # The eTag of this response for caching purposes. 487 "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. 488 "id": "A String", # The ID associated with the value if available. 489 }, 490 "hidden": True or False, # Whether this activity is archived. 491 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 492 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 493 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 494 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 495 "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. 496 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 497 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 498 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 499 "notes": "A String", # General notes or implementation instructions for the tag. 500 "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. 501 "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. 502 # Acceptable values are U1 to U100, inclusive. 503 "A String", 504 ], 505 "defaultTags": [ # Dynamic floodlight tags. 506 { # Dynamic Tag 507 "tag": "A String", # Tag code. 508 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 509 "name": "A String", # Name of this tag. 510 }, 511 ], 512 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 513 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 514 }, 515 ], 516 }</pre> 517</div> 518 519<div class="method"> 520 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 521 <pre>Retrieves the next page of results. 522 523Args: 524 previous_request: The request for the previous page. (required) 525 previous_response: The response from the request for the previous page. (required) 526 527Returns: 528 A request object that you can call 'execute()' on to request the next 529 page. Returns None if there are no more items in the collection. 530 </pre> 531</div> 532 533<div class="method"> 534 <code class="details" id="patch">patch(profileId, id, body)</code> 535 <pre>Updates an existing floodlight activity. This method supports patch semantics. 536 537Args: 538 profileId: string, User profile ID associated with this request. (required) 539 id: string, Floodlight activity ID. (required) 540 body: object, The request body. (required) 541 The object takes the form of: 542 543{ # Contains properties of a Floodlight activity. 544 "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-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. 545 "secure": True or False, # Whether this tag should use SSL. 546 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 547 "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. 548 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 549 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 550 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 551 "value": "A String", # The value of the dimension. 552 "dimensionName": "A String", # The name of the dimension. 553 "etag": "A String", # The eTag of this response for caching purposes. 554 "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. 555 "id": "A String", # The ID associated with the value if available. 556 }, 557 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 558 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 559 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 560 "publisherTags": [ # Publisher dynamic floodlight tags. 561 { # Publisher Dynamic Tag 562 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 563 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 564 "siteId": "A String", # Site ID of this dynamic tag. 565 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 566 "tag": "A String", # Tag code. 567 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 568 "name": "A String", # Name of this tag. 569 }, 570 "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. 571 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 572 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 573 "value": "A String", # The value of the dimension. 574 "dimensionName": "A String", # The name of the dimension. 575 "etag": "A String", # The eTag of this response for caching purposes. 576 "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. 577 "id": "A String", # The ID associated with the value if available. 578 }, 579 }, 580 ], 581 "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. 582 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 583 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 584 "value": "A String", # The value of the dimension. 585 "dimensionName": "A String", # The name of the dimension. 586 "etag": "A String", # The eTag of this response for caching purposes. 587 "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. 588 "id": "A String", # The ID associated with the value if available. 589 }, 590 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 591 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 592 "value": "A String", # The value of the dimension. 593 "dimensionName": "A String", # The name of the dimension. 594 "etag": "A String", # The eTag of this response for caching purposes. 595 "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. 596 "id": "A String", # The ID associated with the value if available. 597 }, 598 "hidden": True or False, # Whether this activity is archived. 599 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 600 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 601 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 602 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 603 "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. 604 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 605 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 606 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 607 "notes": "A String", # General notes or implementation instructions for the tag. 608 "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. 609 "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. 610 # Acceptable values are U1 to U100, inclusive. 611 "A String", 612 ], 613 "defaultTags": [ # Dynamic floodlight tags. 614 { # Dynamic Tag 615 "tag": "A String", # Tag code. 616 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 617 "name": "A String", # Name of this tag. 618 }, 619 ], 620 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 621 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 622 } 623 624 625Returns: 626 An object of the form: 627 628 { # Contains properties of a Floodlight activity. 629 "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-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. 630 "secure": True or False, # Whether this tag should use SSL. 631 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 632 "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. 633 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 634 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 635 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 636 "value": "A String", # The value of the dimension. 637 "dimensionName": "A String", # The name of the dimension. 638 "etag": "A String", # The eTag of this response for caching purposes. 639 "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. 640 "id": "A String", # The ID associated with the value if available. 641 }, 642 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 643 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 644 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 645 "publisherTags": [ # Publisher dynamic floodlight tags. 646 { # Publisher Dynamic Tag 647 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 648 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 649 "siteId": "A String", # Site ID of this dynamic tag. 650 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 651 "tag": "A String", # Tag code. 652 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 653 "name": "A String", # Name of this tag. 654 }, 655 "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. 656 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 657 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 658 "value": "A String", # The value of the dimension. 659 "dimensionName": "A String", # The name of the dimension. 660 "etag": "A String", # The eTag of this response for caching purposes. 661 "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. 662 "id": "A String", # The ID associated with the value if available. 663 }, 664 }, 665 ], 666 "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. 667 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 668 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 669 "value": "A String", # The value of the dimension. 670 "dimensionName": "A String", # The name of the dimension. 671 "etag": "A String", # The eTag of this response for caching purposes. 672 "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. 673 "id": "A String", # The ID associated with the value if available. 674 }, 675 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 676 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 677 "value": "A String", # The value of the dimension. 678 "dimensionName": "A String", # The name of the dimension. 679 "etag": "A String", # The eTag of this response for caching purposes. 680 "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. 681 "id": "A String", # The ID associated with the value if available. 682 }, 683 "hidden": True or False, # Whether this activity is archived. 684 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 685 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 686 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 687 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 688 "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. 689 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 690 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 691 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 692 "notes": "A String", # General notes or implementation instructions for the tag. 693 "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. 694 "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. 695 # Acceptable values are U1 to U100, inclusive. 696 "A String", 697 ], 698 "defaultTags": [ # Dynamic floodlight tags. 699 { # Dynamic Tag 700 "tag": "A String", # Tag code. 701 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 702 "name": "A String", # Name of this tag. 703 }, 704 ], 705 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 706 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 707 }</pre> 708</div> 709 710<div class="method"> 711 <code class="details" id="update">update(profileId, body)</code> 712 <pre>Updates an existing floodlight activity. 713 714Args: 715 profileId: string, User profile ID associated with this request. (required) 716 body: object, The request body. (required) 717 The object takes the form of: 718 719{ # Contains properties of a Floodlight activity. 720 "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-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. 721 "secure": True or False, # Whether this tag should use SSL. 722 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 723 "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. 724 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 725 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 726 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 727 "value": "A String", # The value of the dimension. 728 "dimensionName": "A String", # The name of the dimension. 729 "etag": "A String", # The eTag of this response for caching purposes. 730 "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. 731 "id": "A String", # The ID associated with the value if available. 732 }, 733 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 734 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 735 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 736 "publisherTags": [ # Publisher dynamic floodlight tags. 737 { # Publisher Dynamic Tag 738 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 739 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 740 "siteId": "A String", # Site ID of this dynamic tag. 741 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 742 "tag": "A String", # Tag code. 743 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 744 "name": "A String", # Name of this tag. 745 }, 746 "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. 747 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 748 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 749 "value": "A String", # The value of the dimension. 750 "dimensionName": "A String", # The name of the dimension. 751 "etag": "A String", # The eTag of this response for caching purposes. 752 "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. 753 "id": "A String", # The ID associated with the value if available. 754 }, 755 }, 756 ], 757 "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. 758 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 759 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 760 "value": "A String", # The value of the dimension. 761 "dimensionName": "A String", # The name of the dimension. 762 "etag": "A String", # The eTag of this response for caching purposes. 763 "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. 764 "id": "A String", # The ID associated with the value if available. 765 }, 766 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 767 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 768 "value": "A String", # The value of the dimension. 769 "dimensionName": "A String", # The name of the dimension. 770 "etag": "A String", # The eTag of this response for caching purposes. 771 "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. 772 "id": "A String", # The ID associated with the value if available. 773 }, 774 "hidden": True or False, # Whether this activity is archived. 775 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 776 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 777 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 778 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 779 "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. 780 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 781 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 782 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 783 "notes": "A String", # General notes or implementation instructions for the tag. 784 "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. 785 "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. 786 # Acceptable values are U1 to U100, inclusive. 787 "A String", 788 ], 789 "defaultTags": [ # Dynamic floodlight tags. 790 { # Dynamic Tag 791 "tag": "A String", # Tag code. 792 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 793 "name": "A String", # Name of this tag. 794 }, 795 ], 796 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 797 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 798 } 799 800 801Returns: 802 An object of the form: 803 804 { # Contains properties of a Floodlight activity. 805 "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-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. 806 "secure": True or False, # Whether this tag should use SSL. 807 "floodlightActivityGroupName": "A String", # Name of the associated floodlight activity group. This is a read-only field. 808 "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. 809 "tagFormat": "A String", # Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. 810 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 811 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 812 "value": "A String", # The value of the dimension. 813 "dimensionName": "A String", # The name of the dimension. 814 "etag": "A String", # The eTag of this response for caching purposes. 815 "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. 816 "id": "A String", # The ID associated with the value if available. 817 }, 818 "floodlightActivityGroupId": "A String", # Floodlight activity group ID of this floodlight activity. This is a required field. 819 "id": "A String", # ID of this floodlight activity. This is a read-only, auto-generated field. 820 "floodlightActivityGroupTagString": "A String", # Tag string of the associated floodlight activity group. This is a read-only field. 821 "publisherTags": [ # Publisher dynamic floodlight tags. 822 { # Publisher Dynamic Tag 823 "viewThrough": True or False, # Whether this tag is applicable only for view-throughs. 824 "clickThrough": True or False, # Whether this tag is applicable only for click-throughs. 825 "siteId": "A String", # Site ID of this dynamic tag. 826 "dynamicTag": { # Dynamic Tag # Dynamic floodlight tag. 827 "tag": "A String", # Tag code. 828 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 829 "name": "A String", # Name of this tag. 830 }, 831 "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. 832 "siteIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the site. This is a read-only, auto-generated field. 833 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 834 "value": "A String", # The value of the dimension. 835 "dimensionName": "A String", # The name of the dimension. 836 "etag": "A String", # The eTag of this response for caching purposes. 837 "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. 838 "id": "A String", # The ID associated with the value if available. 839 }, 840 }, 841 ], 842 "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. 843 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 844 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 845 "value": "A String", # The value of the dimension. 846 "dimensionName": "A String", # The name of the dimension. 847 "etag": "A String", # The eTag of this response for caching purposes. 848 "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. 849 "id": "A String", # The ID associated with the value if available. 850 }, 851 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity. This is a read-only, auto-generated field. 852 "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue. 853 "value": "A String", # The value of the dimension. 854 "dimensionName": "A String", # The name of the dimension. 855 "etag": "A String", # The eTag of this response for caching purposes. 856 "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. 857 "id": "A String", # The ID associated with the value if available. 858 }, 859 "hidden": True or False, # Whether this activity is archived. 860 "accountId": "A String", # Account ID of this floodlight activity. This is a read-only field that can be left blank. 861 "sslRequired": True or False, # Whether this floodlight activity must be SSL-compliant. 862 "floodlightTagType": "A String", # The type of Floodlight tag this activity will generate. This is a required field. 863 "expectedUrl": "A String", # URL where this tag will be deployed. If specified, must be less than 256 characters long. 864 "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. 865 "kind": "dfareporting#floodlightActivity", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivity". 866 "subaccountId": "A String", # Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. 867 "name": "A String", # Name of this floodlight activity. This is a required field. Must be less than 129 characters long and cannot contain quotes. 868 "notes": "A String", # General notes or implementation instructions for the tag. 869 "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. 870 "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. 871 # Acceptable values are U1 to U100, inclusive. 872 "A String", 873 ], 874 "defaultTags": [ # Dynamic floodlight tags. 875 { # Dynamic Tag 876 "tag": "A String", # Tag code. 877 "id": "A String", # ID of this dynamic tag. This is a read-only, auto-generated field. 878 "name": "A String", # Name of this tag. 879 }, 880 ], 881 "countingMethod": "A String", # Counting method for conversions for this floodlight activity. This is a required field. 882 "floodlightActivityGroupType": "A String", # Type of the associated floodlight activity group. This is a read-only field. 883 }</pre> 884</div> 885 886</body></html>