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