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