1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="dfareporting_v3_3.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_3.floodlightActivityGroups.html">floodlightActivityGroups</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(profileId, id, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets one floodlight activity group by ID.</p> 83<p class="toc_element"> 84 <code><a href="#insert">insert(profileId, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Inserts a new floodlight activity group.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(profileId, advertiserId=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, type=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<p class="toc_element"> 93 <code><a href="#patch">patch(profileId, id, body=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Updates an existing floodlight activity group. This method supports patch semantics.</p> 95<p class="toc_element"> 96 <code><a href="#update">update(profileId, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Updates an existing floodlight activity group.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="get">get(profileId, id, x__xgafv=None)</code> 106 <pre>Gets one floodlight activity group by ID. 107 108Args: 109 profileId: string, User profile ID associated with this request. (required) 110 id: string, Floodlight activity Group ID. (required) 111 x__xgafv: string, V1 error format. 112 Allowed values 113 1 - v1 error format 114 2 - v2 error format 115 116Returns: 117 An object of the form: 118 119 { # Contains properties of a Floodlight activity group. 120 "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank. 121 "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. 122 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 123 "dimensionName": "A String", # The name of the dimension. 124 "etag": "A String", # The eTag of this response for caching purposes. 125 "id": "A String", # The ID associated with the value if available. 126 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 127 "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. 128 "value": "A String", # The value of the dimension. 129 }, 130 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field. 131 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 132 "dimensionName": "A String", # The name of the dimension. 133 "etag": "A String", # The eTag of this response for caching purposes. 134 "id": "A String", # The ID associated with the value if available. 135 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 136 "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. 137 "value": "A String", # The value of the dimension. 138 }, 139 "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field. 140 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. 141 "dimensionName": "A String", # The name of the dimension. 142 "etag": "A String", # The eTag of this response for caching purposes. 143 "id": "A String", # The ID associated with the value if available. 144 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 145 "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. 146 "value": "A String", # The value of the dimension. 147 }, 148 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". 149 "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. 150 "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. 151 "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. 152 "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion. 153}</pre> 154</div> 155 156<div class="method"> 157 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 158 <pre>Inserts a new floodlight activity group. 159 160Args: 161 profileId: string, User profile ID associated with this request. (required) 162 body: object, The request body. 163 The object takes the form of: 164 165{ # Contains properties of a Floodlight activity group. 166 "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank. 167 "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. 168 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 169 "dimensionName": "A String", # The name of the dimension. 170 "etag": "A String", # The eTag of this response for caching purposes. 171 "id": "A String", # The ID associated with the value if available. 172 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 173 "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. 174 "value": "A String", # The value of the dimension. 175 }, 176 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field. 177 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 178 "dimensionName": "A String", # The name of the dimension. 179 "etag": "A String", # The eTag of this response for caching purposes. 180 "id": "A String", # The ID associated with the value if available. 181 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 182 "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. 183 "value": "A String", # The value of the dimension. 184 }, 185 "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field. 186 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. 187 "dimensionName": "A String", # The name of the dimension. 188 "etag": "A String", # The eTag of this response for caching purposes. 189 "id": "A String", # The ID associated with the value if available. 190 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 191 "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. 192 "value": "A String", # The value of the dimension. 193 }, 194 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". 195 "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. 196 "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. 197 "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. 198 "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion. 199} 200 201 x__xgafv: string, V1 error format. 202 Allowed values 203 1 - v1 error format 204 2 - v2 error format 205 206Returns: 207 An object of the form: 208 209 { # Contains properties of a Floodlight activity group. 210 "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank. 211 "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. 212 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 213 "dimensionName": "A String", # The name of the dimension. 214 "etag": "A String", # The eTag of this response for caching purposes. 215 "id": "A String", # The ID associated with the value if available. 216 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 217 "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. 218 "value": "A String", # The value of the dimension. 219 }, 220 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field. 221 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 222 "dimensionName": "A String", # The name of the dimension. 223 "etag": "A String", # The eTag of this response for caching purposes. 224 "id": "A String", # The ID associated with the value if available. 225 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 226 "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. 227 "value": "A String", # The value of the dimension. 228 }, 229 "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field. 230 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. 231 "dimensionName": "A String", # The name of the dimension. 232 "etag": "A String", # The eTag of this response for caching purposes. 233 "id": "A String", # The ID associated with the value if available. 234 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 235 "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. 236 "value": "A String", # The value of the dimension. 237 }, 238 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". 239 "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. 240 "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. 241 "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. 242 "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion. 243}</pre> 244</div> 245 246<div class="method"> 247 <code class="details" id="list">list(profileId, advertiserId=None, floodlightConfigurationId=None, ids=None, maxResults=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, type=None, x__xgafv=None)</code> 248 <pre>Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. 249 250Args: 251 profileId: string, User profile ID associated with this request. (required) 252 advertiserId: string, Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. 253 floodlightConfigurationId: string, Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result. 254 ids: string, Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result. (repeated) 255 maxResults: integer, Maximum number of results to return. 256 pageToken: string, Value of the nextPageToken from the previous result page. 257 searchString: string, Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 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 "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup". 258 sortField: string, Field by which to sort the list. 259 Allowed values 260 ID - 261 NAME - 262 sortOrder: string, Order of sorted results. 263 Allowed values 264 ASCENDING - 265 DESCENDING - 266 type: string, Select only floodlight activity groups with the specified floodlight activity group type. 267 Allowed values 268 COUNTER - 269 SALE - 270 x__xgafv: string, V1 error format. 271 Allowed values 272 1 - v1 error format 273 2 - v2 error format 274 275Returns: 276 An object of the form: 277 278 { # Floodlight Activity Group List Response 279 "floodlightActivityGroups": [ # Floodlight activity group collection. 280 { # Contains properties of a Floodlight activity group. 281 "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank. 282 "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. 283 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 284 "dimensionName": "A String", # The name of the dimension. 285 "etag": "A String", # The eTag of this response for caching purposes. 286 "id": "A String", # The ID associated with the value if available. 287 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 288 "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. 289 "value": "A String", # The value of the dimension. 290 }, 291 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field. 292 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 293 "dimensionName": "A String", # The name of the dimension. 294 "etag": "A String", # The eTag of this response for caching purposes. 295 "id": "A String", # The ID associated with the value if available. 296 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 297 "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. 298 "value": "A String", # The value of the dimension. 299 }, 300 "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field. 301 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. 302 "dimensionName": "A String", # The name of the dimension. 303 "etag": "A String", # The eTag of this response for caching purposes. 304 "id": "A String", # The ID associated with the value if available. 305 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 306 "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. 307 "value": "A String", # The value of the dimension. 308 }, 309 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". 310 "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. 311 "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. 312 "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. 313 "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion. 314 }, 315 ], 316 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroupsListResponse". 317 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 318}</pre> 319</div> 320 321<div class="method"> 322 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 323 <pre>Retrieves the next page of results. 324 325Args: 326 previous_request: The request for the previous page. (required) 327 previous_response: The response from the request for the previous page. (required) 328 329Returns: 330 A request object that you can call 'execute()' on to request the next 331 page. Returns None if there are no more items in the collection. 332 </pre> 333</div> 334 335<div class="method"> 336 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 337 <pre>Updates an existing floodlight activity group. This method supports patch semantics. 338 339Args: 340 profileId: string, User profile ID associated with this request. (required) 341 id: string, FloodlightActivityGroup ID. (required) 342 body: object, The request body. 343 The object takes the form of: 344 345{ # Contains properties of a Floodlight activity group. 346 "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank. 347 "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. 348 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 349 "dimensionName": "A String", # The name of the dimension. 350 "etag": "A String", # The eTag of this response for caching purposes. 351 "id": "A String", # The ID associated with the value if available. 352 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 353 "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. 354 "value": "A String", # The value of the dimension. 355 }, 356 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field. 357 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 358 "dimensionName": "A String", # The name of the dimension. 359 "etag": "A String", # The eTag of this response for caching purposes. 360 "id": "A String", # The ID associated with the value if available. 361 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 362 "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. 363 "value": "A String", # The value of the dimension. 364 }, 365 "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field. 366 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. 367 "dimensionName": "A String", # The name of the dimension. 368 "etag": "A String", # The eTag of this response for caching purposes. 369 "id": "A String", # The ID associated with the value if available. 370 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 371 "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. 372 "value": "A String", # The value of the dimension. 373 }, 374 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". 375 "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. 376 "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. 377 "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. 378 "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion. 379} 380 381 x__xgafv: string, V1 error format. 382 Allowed values 383 1 - v1 error format 384 2 - v2 error format 385 386Returns: 387 An object of the form: 388 389 { # Contains properties of a Floodlight activity group. 390 "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank. 391 "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. 392 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 393 "dimensionName": "A String", # The name of the dimension. 394 "etag": "A String", # The eTag of this response for caching purposes. 395 "id": "A String", # The ID associated with the value if available. 396 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 397 "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. 398 "value": "A String", # The value of the dimension. 399 }, 400 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field. 401 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 402 "dimensionName": "A String", # The name of the dimension. 403 "etag": "A String", # The eTag of this response for caching purposes. 404 "id": "A String", # The ID associated with the value if available. 405 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 406 "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. 407 "value": "A String", # The value of the dimension. 408 }, 409 "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field. 410 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. 411 "dimensionName": "A String", # The name of the dimension. 412 "etag": "A String", # The eTag of this response for caching purposes. 413 "id": "A String", # The ID associated with the value if available. 414 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 415 "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. 416 "value": "A String", # The value of the dimension. 417 }, 418 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". 419 "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. 420 "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. 421 "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. 422 "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion. 423}</pre> 424</div> 425 426<div class="method"> 427 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 428 <pre>Updates an existing floodlight activity group. 429 430Args: 431 profileId: string, User profile ID associated with this request. (required) 432 body: object, The request body. 433 The object takes the form of: 434 435{ # Contains properties of a Floodlight activity group. 436 "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank. 437 "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. 438 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 439 "dimensionName": "A String", # The name of the dimension. 440 "etag": "A String", # The eTag of this response for caching purposes. 441 "id": "A String", # The ID associated with the value if available. 442 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 443 "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. 444 "value": "A String", # The value of the dimension. 445 }, 446 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field. 447 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 448 "dimensionName": "A String", # The name of the dimension. 449 "etag": "A String", # The eTag of this response for caching purposes. 450 "id": "A String", # The ID associated with the value if available. 451 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 452 "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. 453 "value": "A String", # The value of the dimension. 454 }, 455 "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field. 456 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. 457 "dimensionName": "A String", # The name of the dimension. 458 "etag": "A String", # The eTag of this response for caching purposes. 459 "id": "A String", # The ID associated with the value if available. 460 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 461 "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. 462 "value": "A String", # The value of the dimension. 463 }, 464 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". 465 "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. 466 "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. 467 "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. 468 "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion. 469} 470 471 x__xgafv: string, V1 error format. 472 Allowed values 473 1 - v1 error format 474 2 - v2 error format 475 476Returns: 477 An object of the form: 478 479 { # Contains properties of a Floodlight activity group. 480 "accountId": "A String", # Account ID of this floodlight activity group. This is a read-only field that can be left blank. 481 "advertiserId": "A String", # Advertiser ID of this floodlight activity group. If this field is left blank, the value will be copied over either from the floodlight configuration's advertiser or from the existing activity group's advertiser. 482 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the advertiser. This is a read-only, auto-generated field. 483 "dimensionName": "A String", # The name of the dimension. 484 "etag": "A String", # The eTag of this response for caching purposes. 485 "id": "A String", # The ID associated with the value if available. 486 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 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 "value": "A String", # The value of the dimension. 489 }, 490 "floodlightConfigurationId": "A String", # Floodlight configuration ID of this floodlight activity group. This is a required field. 491 "floodlightConfigurationIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field. 492 "dimensionName": "A String", # The name of the dimension. 493 "etag": "A String", # The eTag of this response for caching purposes. 494 "id": "A String", # The ID associated with the value if available. 495 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 496 "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. 497 "value": "A String", # The value of the dimension. 498 }, 499 "id": "A String", # ID of this floodlight activity group. This is a read-only, auto-generated field. 500 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this floodlight activity group. This is a read-only, auto-generated field. 501 "dimensionName": "A String", # The name of the dimension. 502 "etag": "A String", # The eTag of this response for caching purposes. 503 "id": "A String", # The ID associated with the value if available. 504 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 505 "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. 506 "value": "A String", # The value of the dimension. 507 }, 508 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivityGroup". 509 "name": "A String", # Name of this floodlight activity group. This is a required field. Must be less than 65 characters long and cannot contain quotes. 510 "subaccountId": "A String", # Subaccount ID of this floodlight activity group. This is a read-only field that can be left blank. 511 "tagString": "A String", # Value of the type= parameter in the floodlight tag, which the ad servers use to identify the activity group that the activity belongs to. This is optional: if empty, a new tag string will be generated for you. This string must be 1 to 8 characters long, with valid characters being a-z0-9[ _ ]. This tag string must also be unique among activity groups of the same floodlight configuration. This field is read-only after insertion. 512 "type": "A String", # Type of the floodlight activity group. This is a required field that is read-only after insertion. 513}</pre> 514</div> 515 516</body></html>