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.campaigns.html">campaigns</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 campaign 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 campaign.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(profileId, advertiserGroupIds=None, advertiserIds=None, archived=None, atLeastOneOptimizationActivity=None, excludedIds=None, ids=None, maxResults=None, overriddenEventTagId=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves a list of campaigns, 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 campaign. 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 campaign.</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 campaign by ID. 107 108Args: 109 profileId: string, User profile ID associated with this request. (required) 110 id: string, Campaign 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 Campaign Manager campaign. 120 "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank. 121 "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign. 122 "clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. 123 "creativeBundleId": "A String", # ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. 124 "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. 125 "overrideClickThroughUrl": True or False, # Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. 126 }, 127 "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign. 128 { # Creative optimization settings. 129 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 130 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 131 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 132 { # Creative optimization activity. 133 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 134 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 135 "dimensionName": "A String", # The name of the dimension. 136 "etag": "A String", # The eTag of this response for caching purposes. 137 "id": "A String", # The ID associated with the value if available. 138 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 139 "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. 140 "value": "A String", # The value of the dimension. 141 }, 142 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 143 }, 144 ], 145 "optimizationModel": "A String", # Optimization model for this configuration. 146 }, 147 ], 148 "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser. 149 "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field. 150 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. 151 "dimensionName": "A String", # The name of the dimension. 152 "etag": "A String", # The eTag of this response for caching purposes. 153 "id": "A String", # The ID associated with the value if available. 154 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 155 "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. 156 "value": "A String", # The value of the dimension. 157 }, 158 "archived": True or False, # Whether this campaign has been archived. 159 "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. 160 { # Audience Segment Group. 161 "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100. 162 { # Audience Segment. 163 "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. 164 "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field. 165 "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long. 166 }, 167 ], 168 "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field. 169 "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long. 170 }, 171 ], 172 "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. 173 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign. 174 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 175 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 176 }, 177 "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long. 178 "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field. 179 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 180 }, 181 "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign. 182 "A String", 183 ], 184 "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign. 185 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 186 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 187 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 188 { # Creative optimization activity. 189 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 190 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 191 "dimensionName": "A String", # The name of the dimension. 192 "etag": "A String", # The eTag of this response for caching purposes. 193 "id": "A String", # The ID associated with the value if available. 194 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 195 "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. 196 "value": "A String", # The value of the dimension. 197 }, 198 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 199 }, 200 ], 201 "optimizationModel": "A String", # Optimization model for this configuration. 202 }, 203 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign. 204 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 205 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 206 }, 207 "defaultLandingPageId": "A String", # The default landing page ID for this campaign. 208 "endDate": "A String", 209 "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags. 210 { # Event tag override information. 211 "enabled": True or False, # Whether this override is enabled. 212 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 213 }, 214 ], 215 "externalId": "A String", # External ID for this campaign. 216 "id": "A String", # ID of this campaign. This is a read-only auto-generated field. 217 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field. 218 "dimensionName": "A String", # The name of the dimension. 219 "etag": "A String", # The eTag of this response for caching purposes. 220 "id": "A String", # The ID associated with the value if available. 221 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 222 "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. 223 "value": "A String", # The value of the dimension. 224 }, 225 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". 226 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field. 227 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 228 }, 229 "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. 230 "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign. 231 "startDate": "A String", 232 "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank. 233 "traffickerEmails": [ # Campaign trafficker contact emails. 234 "A String", 235 ], 236}</pre> 237</div> 238 239<div class="method"> 240 <code class="details" id="insert">insert(profileId, body=None, x__xgafv=None)</code> 241 <pre>Inserts a new campaign. 242 243Args: 244 profileId: string, User profile ID associated with this request. (required) 245 body: object, The request body. 246 The object takes the form of: 247 248{ # Contains properties of a Campaign Manager campaign. 249 "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank. 250 "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign. 251 "clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. 252 "creativeBundleId": "A String", # ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. 253 "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. 254 "overrideClickThroughUrl": True or False, # Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. 255 }, 256 "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign. 257 { # Creative optimization settings. 258 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 259 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 260 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 261 { # Creative optimization activity. 262 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 263 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 264 "dimensionName": "A String", # The name of the dimension. 265 "etag": "A String", # The eTag of this response for caching purposes. 266 "id": "A String", # The ID associated with the value if available. 267 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 268 "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. 269 "value": "A String", # The value of the dimension. 270 }, 271 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 272 }, 273 ], 274 "optimizationModel": "A String", # Optimization model for this configuration. 275 }, 276 ], 277 "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser. 278 "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field. 279 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. 280 "dimensionName": "A String", # The name of the dimension. 281 "etag": "A String", # The eTag of this response for caching purposes. 282 "id": "A String", # The ID associated with the value if available. 283 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 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 "value": "A String", # The value of the dimension. 286 }, 287 "archived": True or False, # Whether this campaign has been archived. 288 "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. 289 { # Audience Segment Group. 290 "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100. 291 { # Audience Segment. 292 "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. 293 "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field. 294 "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long. 295 }, 296 ], 297 "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field. 298 "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long. 299 }, 300 ], 301 "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. 302 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign. 303 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 304 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 305 }, 306 "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long. 307 "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field. 308 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 309 }, 310 "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign. 311 "A String", 312 ], 313 "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign. 314 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 315 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 316 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 317 { # Creative optimization activity. 318 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 319 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 320 "dimensionName": "A String", # The name of the dimension. 321 "etag": "A String", # The eTag of this response for caching purposes. 322 "id": "A String", # The ID associated with the value if available. 323 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 324 "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. 325 "value": "A String", # The value of the dimension. 326 }, 327 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 328 }, 329 ], 330 "optimizationModel": "A String", # Optimization model for this configuration. 331 }, 332 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign. 333 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 334 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 335 }, 336 "defaultLandingPageId": "A String", # The default landing page ID for this campaign. 337 "endDate": "A String", 338 "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags. 339 { # Event tag override information. 340 "enabled": True or False, # Whether this override is enabled. 341 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 342 }, 343 ], 344 "externalId": "A String", # External ID for this campaign. 345 "id": "A String", # ID of this campaign. This is a read-only auto-generated field. 346 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field. 347 "dimensionName": "A String", # The name of the dimension. 348 "etag": "A String", # The eTag of this response for caching purposes. 349 "id": "A String", # The ID associated with the value if available. 350 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 351 "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. 352 "value": "A String", # The value of the dimension. 353 }, 354 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". 355 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field. 356 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 357 }, 358 "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. 359 "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign. 360 "startDate": "A String", 361 "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank. 362 "traffickerEmails": [ # Campaign trafficker contact emails. 363 "A String", 364 ], 365} 366 367 x__xgafv: string, V1 error format. 368 Allowed values 369 1 - v1 error format 370 2 - v2 error format 371 372Returns: 373 An object of the form: 374 375 { # Contains properties of a Campaign Manager campaign. 376 "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank. 377 "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign. 378 "clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. 379 "creativeBundleId": "A String", # ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. 380 "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. 381 "overrideClickThroughUrl": True or False, # Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. 382 }, 383 "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign. 384 { # Creative optimization settings. 385 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 386 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 387 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 388 { # Creative optimization activity. 389 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 390 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 391 "dimensionName": "A String", # The name of the dimension. 392 "etag": "A String", # The eTag of this response for caching purposes. 393 "id": "A String", # The ID associated with the value if available. 394 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 395 "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. 396 "value": "A String", # The value of the dimension. 397 }, 398 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 399 }, 400 ], 401 "optimizationModel": "A String", # Optimization model for this configuration. 402 }, 403 ], 404 "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser. 405 "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field. 406 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. 407 "dimensionName": "A String", # The name of the dimension. 408 "etag": "A String", # The eTag of this response for caching purposes. 409 "id": "A String", # The ID associated with the value if available. 410 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 411 "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. 412 "value": "A String", # The value of the dimension. 413 }, 414 "archived": True or False, # Whether this campaign has been archived. 415 "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. 416 { # Audience Segment Group. 417 "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100. 418 { # Audience Segment. 419 "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. 420 "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field. 421 "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long. 422 }, 423 ], 424 "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field. 425 "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long. 426 }, 427 ], 428 "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. 429 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign. 430 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 431 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 432 }, 433 "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long. 434 "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field. 435 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 436 }, 437 "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign. 438 "A String", 439 ], 440 "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign. 441 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 442 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 443 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 444 { # Creative optimization activity. 445 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 446 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 447 "dimensionName": "A String", # The name of the dimension. 448 "etag": "A String", # The eTag of this response for caching purposes. 449 "id": "A String", # The ID associated with the value if available. 450 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 451 "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. 452 "value": "A String", # The value of the dimension. 453 }, 454 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 455 }, 456 ], 457 "optimizationModel": "A String", # Optimization model for this configuration. 458 }, 459 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign. 460 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 461 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 462 }, 463 "defaultLandingPageId": "A String", # The default landing page ID for this campaign. 464 "endDate": "A String", 465 "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags. 466 { # Event tag override information. 467 "enabled": True or False, # Whether this override is enabled. 468 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 469 }, 470 ], 471 "externalId": "A String", # External ID for this campaign. 472 "id": "A String", # ID of this campaign. This is a read-only auto-generated field. 473 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field. 474 "dimensionName": "A String", # The name of the dimension. 475 "etag": "A String", # The eTag of this response for caching purposes. 476 "id": "A String", # The ID associated with the value if available. 477 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 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 "value": "A String", # The value of the dimension. 480 }, 481 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". 482 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field. 483 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 484 }, 485 "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. 486 "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign. 487 "startDate": "A String", 488 "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank. 489 "traffickerEmails": [ # Campaign trafficker contact emails. 490 "A String", 491 ], 492}</pre> 493</div> 494 495<div class="method"> 496 <code class="details" id="list">list(profileId, advertiserGroupIds=None, advertiserIds=None, archived=None, atLeastOneOptimizationActivity=None, excludedIds=None, ids=None, maxResults=None, overriddenEventTagId=None, pageToken=None, searchString=None, sortField=None, sortOrder=None, subaccountId=None, x__xgafv=None)</code> 497 <pre>Retrieves a list of campaigns, possibly filtered. This method supports paging. 498 499Args: 500 profileId: string, User profile ID associated with this request. (required) 501 advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated) 502 advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated) 503 archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns. 504 atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity. 505 excludedIds: string, Exclude campaigns with these IDs. (repeated) 506 ids: string, Select only campaigns with these IDs. (repeated) 507 maxResults: integer, Maximum number of results to return. 508 overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID. 509 pageToken: string, Value of the nextPageToken from the previous result page. 510 searchString: string, Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 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 "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign". 511 sortField: string, Field by which to sort the list. 512 Allowed values 513 ID - 514 NAME - 515 sortOrder: string, Order of sorted results. 516 Allowed values 517 ASCENDING - 518 DESCENDING - 519 subaccountId: string, Select only campaigns that belong to this subaccount. 520 x__xgafv: string, V1 error format. 521 Allowed values 522 1 - v1 error format 523 2 - v2 error format 524 525Returns: 526 An object of the form: 527 528 { # Campaign List Response 529 "campaigns": [ # Campaign collection. 530 { # Contains properties of a Campaign Manager campaign. 531 "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank. 532 "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign. 533 "clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. 534 "creativeBundleId": "A String", # ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. 535 "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. 536 "overrideClickThroughUrl": True or False, # Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. 537 }, 538 "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign. 539 { # Creative optimization settings. 540 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 541 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 542 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 543 { # Creative optimization activity. 544 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 545 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 546 "dimensionName": "A String", # The name of the dimension. 547 "etag": "A String", # The eTag of this response for caching purposes. 548 "id": "A String", # The ID associated with the value if available. 549 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 550 "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. 551 "value": "A String", # The value of the dimension. 552 }, 553 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 554 }, 555 ], 556 "optimizationModel": "A String", # Optimization model for this configuration. 557 }, 558 ], 559 "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser. 560 "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field. 561 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. 562 "dimensionName": "A String", # The name of the dimension. 563 "etag": "A String", # The eTag of this response for caching purposes. 564 "id": "A String", # The ID associated with the value if available. 565 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 566 "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. 567 "value": "A String", # The value of the dimension. 568 }, 569 "archived": True or False, # Whether this campaign has been archived. 570 "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. 571 { # Audience Segment Group. 572 "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100. 573 { # Audience Segment. 574 "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. 575 "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field. 576 "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long. 577 }, 578 ], 579 "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field. 580 "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long. 581 }, 582 ], 583 "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. 584 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign. 585 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 586 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 587 }, 588 "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long. 589 "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field. 590 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 591 }, 592 "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign. 593 "A String", 594 ], 595 "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign. 596 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 597 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 598 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 599 { # Creative optimization activity. 600 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 601 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 602 "dimensionName": "A String", # The name of the dimension. 603 "etag": "A String", # The eTag of this response for caching purposes. 604 "id": "A String", # The ID associated with the value if available. 605 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 606 "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. 607 "value": "A String", # The value of the dimension. 608 }, 609 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 610 }, 611 ], 612 "optimizationModel": "A String", # Optimization model for this configuration. 613 }, 614 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign. 615 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 616 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 617 }, 618 "defaultLandingPageId": "A String", # The default landing page ID for this campaign. 619 "endDate": "A String", 620 "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags. 621 { # Event tag override information. 622 "enabled": True or False, # Whether this override is enabled. 623 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 624 }, 625 ], 626 "externalId": "A String", # External ID for this campaign. 627 "id": "A String", # ID of this campaign. This is a read-only auto-generated field. 628 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field. 629 "dimensionName": "A String", # The name of the dimension. 630 "etag": "A String", # The eTag of this response for caching purposes. 631 "id": "A String", # The ID associated with the value if available. 632 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 633 "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. 634 "value": "A String", # The value of the dimension. 635 }, 636 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". 637 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field. 638 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 639 }, 640 "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. 641 "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign. 642 "startDate": "A String", 643 "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank. 644 "traffickerEmails": [ # Campaign trafficker contact emails. 645 "A String", 646 ], 647 }, 648 ], 649 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse". 650 "nextPageToken": "A String", # Pagination token to be used for the next list operation. 651}</pre> 652</div> 653 654<div class="method"> 655 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 656 <pre>Retrieves the next page of results. 657 658Args: 659 previous_request: The request for the previous page. (required) 660 previous_response: The response from the request for the previous page. (required) 661 662Returns: 663 A request object that you can call 'execute()' on to request the next 664 page. Returns None if there are no more items in the collection. 665 </pre> 666</div> 667 668<div class="method"> 669 <code class="details" id="patch">patch(profileId, id, body=None, x__xgafv=None)</code> 670 <pre>Updates an existing campaign. This method supports patch semantics. 671 672Args: 673 profileId: string, User profile ID associated with this request. (required) 674 id: string, Campaign ID. (required) 675 body: object, The request body. 676 The object takes the form of: 677 678{ # Contains properties of a Campaign Manager campaign. 679 "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank. 680 "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign. 681 "clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. 682 "creativeBundleId": "A String", # ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. 683 "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. 684 "overrideClickThroughUrl": True or False, # Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. 685 }, 686 "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign. 687 { # Creative optimization settings. 688 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 689 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 690 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 691 { # Creative optimization activity. 692 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 693 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 694 "dimensionName": "A String", # The name of the dimension. 695 "etag": "A String", # The eTag of this response for caching purposes. 696 "id": "A String", # The ID associated with the value if available. 697 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 698 "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. 699 "value": "A String", # The value of the dimension. 700 }, 701 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 702 }, 703 ], 704 "optimizationModel": "A String", # Optimization model for this configuration. 705 }, 706 ], 707 "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser. 708 "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field. 709 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. 710 "dimensionName": "A String", # The name of the dimension. 711 "etag": "A String", # The eTag of this response for caching purposes. 712 "id": "A String", # The ID associated with the value if available. 713 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 714 "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. 715 "value": "A String", # The value of the dimension. 716 }, 717 "archived": True or False, # Whether this campaign has been archived. 718 "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. 719 { # Audience Segment Group. 720 "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100. 721 { # Audience Segment. 722 "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. 723 "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field. 724 "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long. 725 }, 726 ], 727 "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field. 728 "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long. 729 }, 730 ], 731 "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. 732 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign. 733 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 734 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 735 }, 736 "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long. 737 "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field. 738 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 739 }, 740 "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign. 741 "A String", 742 ], 743 "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign. 744 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 745 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 746 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 747 { # Creative optimization activity. 748 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 749 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 750 "dimensionName": "A String", # The name of the dimension. 751 "etag": "A String", # The eTag of this response for caching purposes. 752 "id": "A String", # The ID associated with the value if available. 753 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 754 "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. 755 "value": "A String", # The value of the dimension. 756 }, 757 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 758 }, 759 ], 760 "optimizationModel": "A String", # Optimization model for this configuration. 761 }, 762 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign. 763 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 764 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 765 }, 766 "defaultLandingPageId": "A String", # The default landing page ID for this campaign. 767 "endDate": "A String", 768 "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags. 769 { # Event tag override information. 770 "enabled": True or False, # Whether this override is enabled. 771 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 772 }, 773 ], 774 "externalId": "A String", # External ID for this campaign. 775 "id": "A String", # ID of this campaign. This is a read-only auto-generated field. 776 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field. 777 "dimensionName": "A String", # The name of the dimension. 778 "etag": "A String", # The eTag of this response for caching purposes. 779 "id": "A String", # The ID associated with the value if available. 780 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 781 "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. 782 "value": "A String", # The value of the dimension. 783 }, 784 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". 785 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field. 786 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 787 }, 788 "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. 789 "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign. 790 "startDate": "A String", 791 "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank. 792 "traffickerEmails": [ # Campaign trafficker contact emails. 793 "A String", 794 ], 795} 796 797 x__xgafv: string, V1 error format. 798 Allowed values 799 1 - v1 error format 800 2 - v2 error format 801 802Returns: 803 An object of the form: 804 805 { # Contains properties of a Campaign Manager campaign. 806 "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank. 807 "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign. 808 "clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. 809 "creativeBundleId": "A String", # ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. 810 "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. 811 "overrideClickThroughUrl": True or False, # Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. 812 }, 813 "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign. 814 { # Creative optimization settings. 815 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 816 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 817 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 818 { # Creative optimization activity. 819 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 820 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 821 "dimensionName": "A String", # The name of the dimension. 822 "etag": "A String", # The eTag of this response for caching purposes. 823 "id": "A String", # The ID associated with the value if available. 824 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 825 "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. 826 "value": "A String", # The value of the dimension. 827 }, 828 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 829 }, 830 ], 831 "optimizationModel": "A String", # Optimization model for this configuration. 832 }, 833 ], 834 "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser. 835 "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field. 836 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. 837 "dimensionName": "A String", # The name of the dimension. 838 "etag": "A String", # The eTag of this response for caching purposes. 839 "id": "A String", # The ID associated with the value if available. 840 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 841 "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. 842 "value": "A String", # The value of the dimension. 843 }, 844 "archived": True or False, # Whether this campaign has been archived. 845 "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. 846 { # Audience Segment Group. 847 "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100. 848 { # Audience Segment. 849 "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. 850 "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field. 851 "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long. 852 }, 853 ], 854 "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field. 855 "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long. 856 }, 857 ], 858 "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. 859 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign. 860 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 861 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 862 }, 863 "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long. 864 "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field. 865 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 866 }, 867 "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign. 868 "A String", 869 ], 870 "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign. 871 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 872 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 873 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 874 { # Creative optimization activity. 875 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 876 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 877 "dimensionName": "A String", # The name of the dimension. 878 "etag": "A String", # The eTag of this response for caching purposes. 879 "id": "A String", # The ID associated with the value if available. 880 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 881 "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. 882 "value": "A String", # The value of the dimension. 883 }, 884 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 885 }, 886 ], 887 "optimizationModel": "A String", # Optimization model for this configuration. 888 }, 889 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign. 890 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 891 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 892 }, 893 "defaultLandingPageId": "A String", # The default landing page ID for this campaign. 894 "endDate": "A String", 895 "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags. 896 { # Event tag override information. 897 "enabled": True or False, # Whether this override is enabled. 898 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 899 }, 900 ], 901 "externalId": "A String", # External ID for this campaign. 902 "id": "A String", # ID of this campaign. This is a read-only auto-generated field. 903 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field. 904 "dimensionName": "A String", # The name of the dimension. 905 "etag": "A String", # The eTag of this response for caching purposes. 906 "id": "A String", # The ID associated with the value if available. 907 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 908 "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. 909 "value": "A String", # The value of the dimension. 910 }, 911 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". 912 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field. 913 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 914 }, 915 "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. 916 "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign. 917 "startDate": "A String", 918 "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank. 919 "traffickerEmails": [ # Campaign trafficker contact emails. 920 "A String", 921 ], 922}</pre> 923</div> 924 925<div class="method"> 926 <code class="details" id="update">update(profileId, body=None, x__xgafv=None)</code> 927 <pre>Updates an existing campaign. 928 929Args: 930 profileId: string, User profile ID associated with this request. (required) 931 body: object, The request body. 932 The object takes the form of: 933 934{ # Contains properties of a Campaign Manager campaign. 935 "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank. 936 "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign. 937 "clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. 938 "creativeBundleId": "A String", # ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. 939 "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. 940 "overrideClickThroughUrl": True or False, # Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. 941 }, 942 "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign. 943 { # Creative optimization settings. 944 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 945 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 946 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 947 { # Creative optimization activity. 948 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 949 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 950 "dimensionName": "A String", # The name of the dimension. 951 "etag": "A String", # The eTag of this response for caching purposes. 952 "id": "A String", # The ID associated with the value if available. 953 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 954 "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. 955 "value": "A String", # The value of the dimension. 956 }, 957 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 958 }, 959 ], 960 "optimizationModel": "A String", # Optimization model for this configuration. 961 }, 962 ], 963 "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser. 964 "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field. 965 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. 966 "dimensionName": "A String", # The name of the dimension. 967 "etag": "A String", # The eTag of this response for caching purposes. 968 "id": "A String", # The ID associated with the value if available. 969 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 970 "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. 971 "value": "A String", # The value of the dimension. 972 }, 973 "archived": True or False, # Whether this campaign has been archived. 974 "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. 975 { # Audience Segment Group. 976 "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100. 977 { # Audience Segment. 978 "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. 979 "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field. 980 "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long. 981 }, 982 ], 983 "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field. 984 "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long. 985 }, 986 ], 987 "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. 988 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign. 989 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 990 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 991 }, 992 "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long. 993 "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field. 994 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 995 }, 996 "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign. 997 "A String", 998 ], 999 "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign. 1000 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 1001 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 1002 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 1003 { # Creative optimization activity. 1004 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 1005 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 1006 "dimensionName": "A String", # The name of the dimension. 1007 "etag": "A String", # The eTag of this response for caching purposes. 1008 "id": "A String", # The ID associated with the value if available. 1009 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1010 "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. 1011 "value": "A String", # The value of the dimension. 1012 }, 1013 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 1014 }, 1015 ], 1016 "optimizationModel": "A String", # Optimization model for this configuration. 1017 }, 1018 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign. 1019 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 1020 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 1021 }, 1022 "defaultLandingPageId": "A String", # The default landing page ID for this campaign. 1023 "endDate": "A String", 1024 "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags. 1025 { # Event tag override information. 1026 "enabled": True or False, # Whether this override is enabled. 1027 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 1028 }, 1029 ], 1030 "externalId": "A String", # External ID for this campaign. 1031 "id": "A String", # ID of this campaign. This is a read-only auto-generated field. 1032 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field. 1033 "dimensionName": "A String", # The name of the dimension. 1034 "etag": "A String", # The eTag of this response for caching purposes. 1035 "id": "A String", # The ID associated with the value if available. 1036 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1037 "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. 1038 "value": "A String", # The value of the dimension. 1039 }, 1040 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". 1041 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field. 1042 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1043 }, 1044 "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. 1045 "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign. 1046 "startDate": "A String", 1047 "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank. 1048 "traffickerEmails": [ # Campaign trafficker contact emails. 1049 "A String", 1050 ], 1051} 1052 1053 x__xgafv: string, V1 error format. 1054 Allowed values 1055 1 - v1 error format 1056 2 - v2 error format 1057 1058Returns: 1059 An object of the form: 1060 1061 { # Contains properties of a Campaign Manager campaign. 1062 "accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank. 1063 "adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign. 1064 "clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true. 1065 "creativeBundleId": "A String", # ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used. 1066 "enabled": True or False, # Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings. 1067 "overrideClickThroughUrl": True or False, # Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured. 1068 }, 1069 "additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign. 1070 { # Creative optimization settings. 1071 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 1072 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 1073 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 1074 { # Creative optimization activity. 1075 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 1076 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 1077 "dimensionName": "A String", # The name of the dimension. 1078 "etag": "A String", # The eTag of this response for caching purposes. 1079 "id": "A String", # The ID associated with the value if available. 1080 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1081 "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. 1082 "value": "A String", # The value of the dimension. 1083 }, 1084 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 1085 }, 1086 ], 1087 "optimizationModel": "A String", # Optimization model for this configuration. 1088 }, 1089 ], 1090 "advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser. 1091 "advertiserId": "A String", # Advertiser ID of this campaign. This is a required field. 1092 "advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. 1093 "dimensionName": "A String", # The name of the dimension. 1094 "etag": "A String", # The eTag of this response for caching purposes. 1095 "id": "A String", # The ID associated with the value if available. 1096 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1097 "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. 1098 "value": "A String", # The value of the dimension. 1099 }, 1100 "archived": True or False, # Whether this campaign has been archived. 1101 "audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. 1102 { # Audience Segment Group. 1103 "audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100. 1104 { # Audience Segment. 1105 "allocation": 42, # Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are 1 to 1000, inclusive. 1106 "id": "A String", # ID of this audience segment. This is a read-only, auto-generated field. 1107 "name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long. 1108 }, 1109 ], 1110 "id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field. 1111 "name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long. 1112 }, 1113 ], 1114 "billingInvoiceCode": "A String", # Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. 1115 "clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign. 1116 "clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long. 1117 "overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value. 1118 }, 1119 "comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long. 1120 "createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field. 1121 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1122 }, 1123 "creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign. 1124 "A String", 1125 ], 1126 "creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign. 1127 "id": "A String", # ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns. 1128 "name": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long. 1129 "optimizationActivitys": [ # List of optimization activities associated with this configuration. 1130 { # Creative optimization activity. 1131 "floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field. 1132 "floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. 1133 "dimensionName": "A String", # The name of the dimension. 1134 "etag": "A String", # The eTag of this response for caching purposes. 1135 "id": "A String", # The ID associated with the value if available. 1136 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1137 "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. 1138 "value": "A String", # The value of the dimension. 1139 }, 1140 "weight": 42, # Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to 1. 1141 }, 1142 ], 1143 "optimizationModel": "A String", # Optimization model for this configuration. 1144 }, 1145 "defaultClickThroughEventTagProperties": { # Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further. # Click-through event tag ID override properties for this campaign. 1146 "defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope. 1147 "overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value. 1148 }, 1149 "defaultLandingPageId": "A String", # The default landing page ID for this campaign. 1150 "endDate": "A String", 1151 "eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags. 1152 { # Event tag override information. 1153 "enabled": True or False, # Whether this override is enabled. 1154 "id": "A String", # ID of this event tag override. This is a read-only, auto-generated field. 1155 }, 1156 ], 1157 "externalId": "A String", # External ID for this campaign. 1158 "id": "A String", # ID of this campaign. This is a read-only auto-generated field. 1159 "idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field. 1160 "dimensionName": "A String", # The name of the dimension. 1161 "etag": "A String", # The eTag of this response for caching purposes. 1162 "id": "A String", # The ID associated with the value if available. 1163 "kind": "A String", # The kind of resource this is, in this case dfareporting#dimensionValue. 1164 "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. 1165 "value": "A String", # The value of the dimension. 1166 }, 1167 "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign". 1168 "lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field. 1169 "time": "A String", # Timestamp of the last change in milliseconds since epoch. 1170 }, 1171 "name": "A String", # Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser. 1172 "nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign. 1173 "startDate": "A String", 1174 "subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank. 1175 "traffickerEmails": [ # Campaign trafficker contact emails. 1176 "A String", 1177 ], 1178}</pre> 1179</div> 1180 1181</body></html>