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