Debian Codegraph @

docs/dyn/dfareporting_v4.campaigns.html

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