Debian Codegraph @

docs/dyn/dfareporting_v4.dynamicProfiles.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.dynamicProfiles.html">dynamicProfiles</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="#generateCode">generateCode(dynamicProfileId, x__xgafv=None)</a></code></p>
82 <p class="firstline">Generates code for a dynamic profile, which will need unescaping.</p>
83 <p class="toc_element">
84 <code><a href="#get">get(dynamicProfileId, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets a dynamic profile by ID.</p>
86 <p class="toc_element">
87 <code><a href="#insert">insert(body=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Inserts a new dynamic profile.</p>
89 <p class="toc_element">
90 <code><a href="#publish">publish(dynamicProfileId, x__xgafv=None)</a></code></p>
91 <p class="firstline">Publish for a dynamic profile.</p>
92 <p class="toc_element">
93 <code><a href="#update">update(body=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Updates an existing dynamic profile.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="generateCode">generateCode(dynamicProfileId, x__xgafv=None)</code>
103 <pre>Generates code for a dynamic profile, which will need unescaping.
104
105 Args:
106 dynamicProfileId: string, Required. Dynamic profile ID. (required)
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
111
112 Returns:
113 An object of the form:
114
115 { # Response message for DfareportingDynamicProfiles.GenerateCode.
116 &quot;code&quot;: &quot;A String&quot;, # Generated code for the dynamic profile. The code will need to be unescaped.
117 }</pre>
118 </div>
119
120 <div class="method">
121 <code class="details" id="get">get(dynamicProfileId, x__xgafv=None)</code>
122 <pre>Gets a dynamic profile by ID.
123
124 Args:
125 dynamicProfileId: string, Required. Dynamic profile ID. (required)
126 x__xgafv: string, V1 error format.
127 Allowed values
128 1 - v1 error format
129 2 - v2 error format
130
131 Returns:
132 An object of the form:
133
134 { # *Beta:* This API resource is available only to a very limited number of customers. If you&#x27;d like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
135 &quot;active&quot;: { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
136 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
137 { # Contains dynamic profile specific settings for an associated dynamic feed.
138 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
139 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
140 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
141 42,
142 ],
143 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
144 { # Contains custom rule information.
145 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
146 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
147 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
148 { # Contains a list of field filters that the given custom rule will apply.
149 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
150 { # Contains field filter information.
151 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
152 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
153 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
154 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
155 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
156 },
157 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
158 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
159 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
160 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
161 &quot;A String&quot;,
162 ],
163 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
164 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
165 &quot;A String&quot;,
166 ],
167 },
168 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
169 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
170 },
171 ],
172 },
173 ],
174 },
175 ],
176 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
177 { # Contains custom value field information.
178 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
179 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
180 },
181 ],
182 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
183 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
184 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
185 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
186 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
187 },
188 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
189 { # Contains remarketing value attribute information.
190 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
191 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
192 &quot;A String&quot;,
193 ],
194 },
195 ],
196 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
197 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
198 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
199 },
200 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
201 },
202 ],
203 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
204 },
205 &quot;archiveStatus&quot;: &quot;A String&quot;, # Optional. Archive status of this dynamic profile.
206 &quot;createInfo&quot;: { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
207 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
208 },
209 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of this dynamic profile.
210 &quot;draft&quot;: { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
211 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
212 { # Contains dynamic profile specific settings for an associated dynamic feed.
213 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
214 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
215 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
216 42,
217 ],
218 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
219 { # Contains custom rule information.
220 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
221 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
222 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
223 { # Contains a list of field filters that the given custom rule will apply.
224 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
225 { # Contains field filter information.
226 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
227 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
228 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
229 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
230 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
231 },
232 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
233 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
234 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
235 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
236 &quot;A String&quot;,
237 ],
238 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
239 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
240 &quot;A String&quot;,
241 ],
242 },
243 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
244 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
245 },
246 ],
247 },
248 ],
249 },
250 ],
251 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
252 { # Contains custom value field information.
253 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
254 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
255 },
256 ],
257 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
258 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
259 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
260 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
261 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
262 },
263 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
264 { # Contains remarketing value attribute information.
265 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
266 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
267 &quot;A String&quot;,
268 ],
269 },
270 ],
271 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
272 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
273 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
274 },
275 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
276 },
277 ],
278 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
279 },
280 &quot;dynamicProfileId&quot;: &quot;A String&quot;, # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
281 &quot;kind&quot;: &quot;A String&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#dynamicProfile&quot;.
282 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
283 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
284 },
285 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
286 &quot;status&quot;: &quot;A String&quot;, # Optional. Status of this dynamic profile.
287 &quot;studioAdvertiserId&quot;: &quot;A String&quot;, # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
288 }</pre>
289 </div>
290
291 <div class="method">
292 <code class="details" id="insert">insert(body=None, x__xgafv=None)</code>
293 <pre>Inserts a new dynamic profile.
294
295 Args:
296 body: object, The request body.
297 The object takes the form of:
298
299 { # *Beta:* This API resource is available only to a very limited number of customers. If you&#x27;d like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
300 &quot;active&quot;: { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
301 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
302 { # Contains dynamic profile specific settings for an associated dynamic feed.
303 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
304 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
305 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
306 42,
307 ],
308 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
309 { # Contains custom rule information.
310 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
311 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
312 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
313 { # Contains a list of field filters that the given custom rule will apply.
314 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
315 { # Contains field filter information.
316 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
317 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
318 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
319 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
320 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
321 },
322 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
323 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
324 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
325 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
326 &quot;A String&quot;,
327 ],
328 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
329 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
330 &quot;A String&quot;,
331 ],
332 },
333 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
334 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
335 },
336 ],
337 },
338 ],
339 },
340 ],
341 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
342 { # Contains custom value field information.
343 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
344 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
345 },
346 ],
347 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
348 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
349 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
350 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
351 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
352 },
353 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
354 { # Contains remarketing value attribute information.
355 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
356 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
357 &quot;A String&quot;,
358 ],
359 },
360 ],
361 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
362 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
363 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
364 },
365 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
366 },
367 ],
368 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
369 },
370 &quot;archiveStatus&quot;: &quot;A String&quot;, # Optional. Archive status of this dynamic profile.
371 &quot;createInfo&quot;: { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
372 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
373 },
374 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of this dynamic profile.
375 &quot;draft&quot;: { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
376 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
377 { # Contains dynamic profile specific settings for an associated dynamic feed.
378 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
379 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
380 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
381 42,
382 ],
383 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
384 { # Contains custom rule information.
385 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
386 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
387 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
388 { # Contains a list of field filters that the given custom rule will apply.
389 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
390 { # Contains field filter information.
391 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
392 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
393 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
394 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
395 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
396 },
397 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
398 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
399 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
400 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
401 &quot;A String&quot;,
402 ],
403 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
404 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
405 &quot;A String&quot;,
406 ],
407 },
408 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
409 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
410 },
411 ],
412 },
413 ],
414 },
415 ],
416 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
417 { # Contains custom value field information.
418 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
419 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
420 },
421 ],
422 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
423 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
424 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
425 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
426 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
427 },
428 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
429 { # Contains remarketing value attribute information.
430 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
431 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
432 &quot;A String&quot;,
433 ],
434 },
435 ],
436 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
437 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
438 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
439 },
440 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
441 },
442 ],
443 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
444 },
445 &quot;dynamicProfileId&quot;: &quot;A String&quot;, # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
446 &quot;kind&quot;: &quot;A String&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#dynamicProfile&quot;.
447 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
448 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
449 },
450 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
451 &quot;status&quot;: &quot;A String&quot;, # Optional. Status of this dynamic profile.
452 &quot;studioAdvertiserId&quot;: &quot;A String&quot;, # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
453 }
454
455 x__xgafv: string, V1 error format.
456 Allowed values
457 1 - v1 error format
458 2 - v2 error format
459
460 Returns:
461 An object of the form:
462
463 { # *Beta:* This API resource is available only to a very limited number of customers. If you&#x27;d like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
464 &quot;active&quot;: { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
465 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
466 { # Contains dynamic profile specific settings for an associated dynamic feed.
467 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
468 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
469 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
470 42,
471 ],
472 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
473 { # Contains custom rule information.
474 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
475 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
476 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
477 { # Contains a list of field filters that the given custom rule will apply.
478 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
479 { # Contains field filter information.
480 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
481 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
482 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
483 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
484 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
485 },
486 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
487 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
488 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
489 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
490 &quot;A String&quot;,
491 ],
492 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
493 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
494 &quot;A String&quot;,
495 ],
496 },
497 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
498 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
499 },
500 ],
501 },
502 ],
503 },
504 ],
505 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
506 { # Contains custom value field information.
507 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
508 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
509 },
510 ],
511 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
512 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
513 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
514 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
515 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
516 },
517 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
518 { # Contains remarketing value attribute information.
519 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
520 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
521 &quot;A String&quot;,
522 ],
523 },
524 ],
525 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
526 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
527 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
528 },
529 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
530 },
531 ],
532 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
533 },
534 &quot;archiveStatus&quot;: &quot;A String&quot;, # Optional. Archive status of this dynamic profile.
535 &quot;createInfo&quot;: { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
536 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
537 },
538 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of this dynamic profile.
539 &quot;draft&quot;: { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
540 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
541 { # Contains dynamic profile specific settings for an associated dynamic feed.
542 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
543 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
544 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
545 42,
546 ],
547 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
548 { # Contains custom rule information.
549 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
550 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
551 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
552 { # Contains a list of field filters that the given custom rule will apply.
553 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
554 { # Contains field filter information.
555 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
556 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
557 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
558 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
559 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
560 },
561 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
562 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
563 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
564 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
565 &quot;A String&quot;,
566 ],
567 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
568 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
569 &quot;A String&quot;,
570 ],
571 },
572 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
573 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
574 },
575 ],
576 },
577 ],
578 },
579 ],
580 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
581 { # Contains custom value field information.
582 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
583 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
584 },
585 ],
586 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
587 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
588 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
589 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
590 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
591 },
592 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
593 { # Contains remarketing value attribute information.
594 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
595 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
596 &quot;A String&quot;,
597 ],
598 },
599 ],
600 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
601 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
602 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
603 },
604 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
605 },
606 ],
607 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
608 },
609 &quot;dynamicProfileId&quot;: &quot;A String&quot;, # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
610 &quot;kind&quot;: &quot;A String&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#dynamicProfile&quot;.
611 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
612 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
613 },
614 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
615 &quot;status&quot;: &quot;A String&quot;, # Optional. Status of this dynamic profile.
616 &quot;studioAdvertiserId&quot;: &quot;A String&quot;, # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
617 }</pre>
618 </div>
619
620 <div class="method">
621 <code class="details" id="publish">publish(dynamicProfileId, x__xgafv=None)</code>
622 <pre>Publish for a dynamic profile.
623
624 Args:
625 dynamicProfileId: string, Required. Dynamic profile ID. (required)
626 x__xgafv: string, V1 error format.
627 Allowed values
628 1 - v1 error format
629 2 - v2 error format
630 </pre>
631 </div>
632
633 <div class="method">
634 <code class="details" id="update">update(body=None, x__xgafv=None)</code>
635 <pre>Updates an existing dynamic profile.
636
637 Args:
638 body: object, The request body.
639 The object takes the form of:
640
641 { # *Beta:* This API resource is available only to a very limited number of customers. If you&#x27;d like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
642 &quot;active&quot;: { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
643 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
644 { # Contains dynamic profile specific settings for an associated dynamic feed.
645 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
646 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
647 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
648 42,
649 ],
650 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
651 { # Contains custom rule information.
652 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
653 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
654 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
655 { # Contains a list of field filters that the given custom rule will apply.
656 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
657 { # Contains field filter information.
658 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
659 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
660 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
661 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
662 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
663 },
664 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
665 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
666 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
667 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
668 &quot;A String&quot;,
669 ],
670 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
671 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
672 &quot;A String&quot;,
673 ],
674 },
675 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
676 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
677 },
678 ],
679 },
680 ],
681 },
682 ],
683 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
684 { # Contains custom value field information.
685 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
686 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
687 },
688 ],
689 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
690 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
691 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
692 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
693 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
694 },
695 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
696 { # Contains remarketing value attribute information.
697 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
698 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
699 &quot;A String&quot;,
700 ],
701 },
702 ],
703 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
704 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
705 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
706 },
707 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
708 },
709 ],
710 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
711 },
712 &quot;archiveStatus&quot;: &quot;A String&quot;, # Optional. Archive status of this dynamic profile.
713 &quot;createInfo&quot;: { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
714 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
715 },
716 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of this dynamic profile.
717 &quot;draft&quot;: { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
718 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
719 { # Contains dynamic profile specific settings for an associated dynamic feed.
720 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
721 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
722 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
723 42,
724 ],
725 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
726 { # Contains custom rule information.
727 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
728 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
729 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
730 { # Contains a list of field filters that the given custom rule will apply.
731 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
732 { # Contains field filter information.
733 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
734 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
735 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
736 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
737 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
738 },
739 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
740 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
741 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
742 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
743 &quot;A String&quot;,
744 ],
745 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
746 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
747 &quot;A String&quot;,
748 ],
749 },
750 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
751 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
752 },
753 ],
754 },
755 ],
756 },
757 ],
758 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
759 { # Contains custom value field information.
760 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
761 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
762 },
763 ],
764 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
765 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
766 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
767 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
768 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
769 },
770 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
771 { # Contains remarketing value attribute information.
772 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
773 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
774 &quot;A String&quot;,
775 ],
776 },
777 ],
778 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
779 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
780 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
781 },
782 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
783 },
784 ],
785 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
786 },
787 &quot;dynamicProfileId&quot;: &quot;A String&quot;, # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
788 &quot;kind&quot;: &quot;A String&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#dynamicProfile&quot;.
789 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
790 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
791 },
792 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
793 &quot;status&quot;: &quot;A String&quot;, # Optional. Status of this dynamic profile.
794 &quot;studioAdvertiserId&quot;: &quot;A String&quot;, # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
795 }
796
797 x__xgafv: string, V1 error format.
798 Allowed values
799 1 - v1 error format
800 2 - v2 error format
801
802 Returns:
803 An object of the form:
804
805 { # *Beta:* This API resource is available only to a very limited number of customers. If you&#x27;d like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information.
806 &quot;active&quot;: { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
807 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
808 { # Contains dynamic profile specific settings for an associated dynamic feed.
809 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
810 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
811 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
812 42,
813 ],
814 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
815 { # Contains custom rule information.
816 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
817 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
818 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
819 { # Contains a list of field filters that the given custom rule will apply.
820 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
821 { # Contains field filter information.
822 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
823 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
824 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
825 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
826 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
827 },
828 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
829 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
830 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
831 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
832 &quot;A String&quot;,
833 ],
834 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
835 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
836 &quot;A String&quot;,
837 ],
838 },
839 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
840 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
841 },
842 ],
843 },
844 ],
845 },
846 ],
847 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
848 { # Contains custom value field information.
849 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
850 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
851 },
852 ],
853 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
854 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
855 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
856 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
857 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
858 },
859 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
860 { # Contains remarketing value attribute information.
861 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
862 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
863 &quot;A String&quot;,
864 ],
865 },
866 ],
867 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
868 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
869 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
870 },
871 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
872 },
873 ],
874 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
875 },
876 &quot;archiveStatus&quot;: &quot;A String&quot;, # Optional. Archive status of this dynamic profile.
877 &quot;createInfo&quot;: { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
878 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
879 },
880 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of this dynamic profile.
881 &quot;draft&quot;: { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
882 &quot;dynamicProfileFeedSettings&quot;: [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
883 { # Contains dynamic profile specific settings for an associated dynamic feed.
884 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. Dynamic feed ID associated with dynamic profile version.
885 &quot;dynamicRules&quot;: { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
886 &quot;autoTargetedFieldIds&quot;: [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
887 42,
888 ],
889 &quot;customRules&quot;: [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
890 { # Contains custom rule information.
891 &quot;name&quot;: &quot;A String&quot;, # Optional. Name of this custom rule.
892 &quot;priority&quot;: 42, # Optional. Priority of the custom rule.
893 &quot;ruleBlocks&quot;: [ # Optional. A list of field filter, the custom rule will apply.
894 { # Contains a list of field filters that the given custom rule will apply.
895 &quot;fieldFilter&quot;: [ # Optional. A list of non-auto field filters
896 { # Contains field filter information.
897 &quot;boolValue&quot;: True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
898 &quot;dependentFieldValue&quot;: { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
899 &quot;dynamicFeedId&quot;: &quot;A String&quot;, # Optional. The ID of the dynamic feed that value&#x27;s field will match against.
900 &quot;elementId&quot;: &quot;A String&quot;, # Optional. The ID of the element that value&#x27;s field will match against.
901 &quot;fieldId&quot;: 42, # Optional. The field id of the dependent field.
902 },
903 &quot;fieldId&quot;: 42, # Optional. The field ID on the left hand side of the expression.
904 &quot;matchType&quot;: &quot;A String&quot;, # Optional. Left hand side of the expression match type.
905 &quot;requestValue&quot;: { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
906 &quot;excludeFromUserAttributeIds&quot;: [ # Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
907 &quot;A String&quot;,
908 ],
909 &quot;key&quot;: &quot;A String&quot;, # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
910 &quot;userAttributeIds&quot;: [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
911 &quot;A String&quot;,
912 ],
913 },
914 &quot;stringValue&quot;: &quot;A String&quot;, # Optional. The string value, only applicable when rhs_value_type is STRING.
915 &quot;valueType&quot;: &quot;A String&quot;, # Optional. Right hand side of the expression.
916 },
917 ],
918 },
919 ],
920 },
921 ],
922 &quot;customValueFields&quot;: [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
923 { # Contains custom value field information.
924 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
925 &quot;requestKey&quot;: &quot;A String&quot;, # Optional. Custom key used to match for auto filtering.
926 },
927 ],
928 &quot;proximityFilter&quot;: { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
929 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
930 &quot;radiusBucketType&quot;: &quot;A String&quot;, # Optional. The radius bucket type of the proximity filter
931 &quot;radiusUnitType&quot;: &quot;A String&quot;, # Optional. The units of the radius value
932 &quot;radiusValue&quot;: 42, # Optional. Radius length in units defined by radius_units.
933 },
934 &quot;remarketingValueAttributes&quot;: [ # Optional. The link between an element field ID and a list of user attribute IDs.
935 { # Contains remarketing value attribute information.
936 &quot;fieldId&quot;: 42, # Optional. Field ID in the element.
937 &quot;userAttributeIds&quot;: [ # Optional. Remarketing user attribute IDs for auto filtering.
938 &quot;A String&quot;,
939 ],
940 },
941 ],
942 &quot;rotationType&quot;: &quot;A String&quot;, # Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows.
943 &quot;ruleType&quot;: &quot;A String&quot;, # Optional. The type of the rule, the default value is OPEN.
944 &quot;weightFieldId&quot;: 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
945 },
946 &quot;quantity&quot;: 42, # Optional. The number of this dynamic feed rows needed by the dynamic profile, default value is 1. Acceptable values are between 1 to 99, inclusive.
947 },
948 ],
949 &quot;versionId&quot;: &quot;A String&quot;, # Output only. Version ID of this dynamic profile version. This is a read-only, auto-generated field. -1 for draft version, 0+ for published versions.
950 },
951 &quot;dynamicProfileId&quot;: &quot;A String&quot;, # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
952 &quot;kind&quot;: &quot;A String&quot;, # Output only. Identifies what kind of resource this is. Value: the fixed string &quot;dfareporting#dynamicProfile&quot;.
953 &quot;lastModifiedInfo&quot;: { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
954 &quot;time&quot;: &quot;A String&quot;, # Timestamp of the last change in milliseconds since epoch.
955 },
956 &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
957 &quot;status&quot;: &quot;A String&quot;, # Optional. Status of this dynamic profile.
958 &quot;studioAdvertiserId&quot;: &quot;A String&quot;, # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
959 }</pre>
960 </div>
961
962 </body></html>