| 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_v5.html">Campaign Manager 360 API</a> . <a href="dfareporting_v5.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 |
"code": "A String", # 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'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information. |
| 135 |
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile. |
| 136 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 139 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 140 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 141 |
42, |
| 142 |
], |
| 143 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 144 |
{ # Contains custom rule information. |
| 145 |
"name": "A String", # Optional. Name of this custom rule. |
| 146 |
"priority": 42, # Optional. Priority of the custom rule. |
| 147 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 150 |
{ # Contains field filter information. |
| 151 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 152 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 153 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 154 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 155 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 156 |
}, |
| 157 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 158 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 159 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 160 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 162 |
], |
| 163 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 164 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 165 |
"A String", |
| 166 |
], |
| 167 |
}, |
| 168 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 169 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 170 |
}, |
| 171 |
], |
| 172 |
}, |
| 173 |
], |
| 174 |
}, |
| 175 |
], |
| 176 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 177 |
{ # Contains custom value field information. |
| 178 |
"fieldId": 42, # Optional. Field ID in the element. |
| 179 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 180 |
}, |
| 181 |
], |
| 182 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 183 |
"fieldId": 42, # Optional. Field ID in the element. |
| 184 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 185 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 186 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 187 |
}, |
| 188 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 189 |
{ # Contains remarketing value attribute information. |
| 190 |
"fieldId": 42, # Optional. Field ID in the element. |
| 191 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 192 |
"A String", |
| 193 |
], |
| 194 |
}, |
| 195 |
], |
| 196 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 198 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 199 |
}, |
| 200 |
"quantity": 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 |
"versionId": "A String", # 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 |
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile. |
| 206 |
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field. |
| 207 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 208 |
}, |
| 209 |
"description": "A String", # Optional. Description of this dynamic profile. |
| 210 |
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile. |
| 211 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 214 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 215 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 216 |
42, |
| 217 |
], |
| 218 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 219 |
{ # Contains custom rule information. |
| 220 |
"name": "A String", # Optional. Name of this custom rule. |
| 221 |
"priority": 42, # Optional. Priority of the custom rule. |
| 222 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 225 |
{ # Contains field filter information. |
| 226 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 227 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 228 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 229 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 230 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 231 |
}, |
| 232 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 233 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 234 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 235 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 237 |
], |
| 238 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 239 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 240 |
"A String", |
| 241 |
], |
| 242 |
}, |
| 243 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 244 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 245 |
}, |
| 246 |
], |
| 247 |
}, |
| 248 |
], |
| 249 |
}, |
| 250 |
], |
| 251 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 252 |
{ # Contains custom value field information. |
| 253 |
"fieldId": 42, # Optional. Field ID in the element. |
| 254 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 255 |
}, |
| 256 |
], |
| 257 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 258 |
"fieldId": 42, # Optional. Field ID in the element. |
| 259 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 260 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 261 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 262 |
}, |
| 263 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 264 |
{ # Contains remarketing value attribute information. |
| 265 |
"fieldId": 42, # Optional. Field ID in the element. |
| 266 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 267 |
"A String", |
| 268 |
], |
| 269 |
}, |
| 270 |
], |
| 271 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 273 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 274 |
}, |
| 275 |
"quantity": 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 |
"versionId": "A String", # 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 |
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field. |
| 281 |
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile". |
| 282 |
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field. |
| 283 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 284 |
}, |
| 285 |
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long. |
| 286 |
"status": "A String", # Optional. Status of this dynamic profile. |
| 287 |
"studioAdvertiserId": "A String", # 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'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information. |
| 300 |
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile. |
| 301 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 304 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 305 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 306 |
42, |
| 307 |
], |
| 308 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 309 |
{ # Contains custom rule information. |
| 310 |
"name": "A String", # Optional. Name of this custom rule. |
| 311 |
"priority": 42, # Optional. Priority of the custom rule. |
| 312 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 315 |
{ # Contains field filter information. |
| 316 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 317 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 318 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 319 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 320 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 321 |
}, |
| 322 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 323 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 324 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 325 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 327 |
], |
| 328 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 329 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 330 |
"A String", |
| 331 |
], |
| 332 |
}, |
| 333 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 334 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 335 |
}, |
| 336 |
], |
| 337 |
}, |
| 338 |
], |
| 339 |
}, |
| 340 |
], |
| 341 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 342 |
{ # Contains custom value field information. |
| 343 |
"fieldId": 42, # Optional. Field ID in the element. |
| 344 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 345 |
}, |
| 346 |
], |
| 347 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 348 |
"fieldId": 42, # Optional. Field ID in the element. |
| 349 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 350 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 351 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 352 |
}, |
| 353 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 354 |
{ # Contains remarketing value attribute information. |
| 355 |
"fieldId": 42, # Optional. Field ID in the element. |
| 356 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 357 |
"A String", |
| 358 |
], |
| 359 |
}, |
| 360 |
], |
| 361 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 363 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 364 |
}, |
| 365 |
"quantity": 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 |
"versionId": "A String", # 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 |
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile. |
| 371 |
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field. |
| 372 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 373 |
}, |
| 374 |
"description": "A String", # Optional. Description of this dynamic profile. |
| 375 |
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile. |
| 376 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 379 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 380 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 381 |
42, |
| 382 |
], |
| 383 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 384 |
{ # Contains custom rule information. |
| 385 |
"name": "A String", # Optional. Name of this custom rule. |
| 386 |
"priority": 42, # Optional. Priority of the custom rule. |
| 387 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 390 |
{ # Contains field filter information. |
| 391 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 392 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 393 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 394 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 395 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 396 |
}, |
| 397 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 398 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 399 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 400 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 402 |
], |
| 403 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 404 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 405 |
"A String", |
| 406 |
], |
| 407 |
}, |
| 408 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 409 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 410 |
}, |
| 411 |
], |
| 412 |
}, |
| 413 |
], |
| 414 |
}, |
| 415 |
], |
| 416 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 417 |
{ # Contains custom value field information. |
| 418 |
"fieldId": 42, # Optional. Field ID in the element. |
| 419 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 420 |
}, |
| 421 |
], |
| 422 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 423 |
"fieldId": 42, # Optional. Field ID in the element. |
| 424 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 425 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 426 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 427 |
}, |
| 428 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 429 |
{ # Contains remarketing value attribute information. |
| 430 |
"fieldId": 42, # Optional. Field ID in the element. |
| 431 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 432 |
"A String", |
| 433 |
], |
| 434 |
}, |
| 435 |
], |
| 436 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 438 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 439 |
}, |
| 440 |
"quantity": 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 |
"versionId": "A String", # 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 |
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field. |
| 446 |
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile". |
| 447 |
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field. |
| 448 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 449 |
}, |
| 450 |
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long. |
| 451 |
"status": "A String", # Optional. Status of this dynamic profile. |
| 452 |
"studioAdvertiserId": "A String", # 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'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information. |
| 464 |
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile. |
| 465 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 468 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 469 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 470 |
42, |
| 471 |
], |
| 472 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 473 |
{ # Contains custom rule information. |
| 474 |
"name": "A String", # Optional. Name of this custom rule. |
| 475 |
"priority": 42, # Optional. Priority of the custom rule. |
| 476 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 479 |
{ # Contains field filter information. |
| 480 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 481 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 482 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 483 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 484 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 485 |
}, |
| 486 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 487 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 488 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 489 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 491 |
], |
| 492 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 493 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 494 |
"A String", |
| 495 |
], |
| 496 |
}, |
| 497 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 498 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 499 |
}, |
| 500 |
], |
| 501 |
}, |
| 502 |
], |
| 503 |
}, |
| 504 |
], |
| 505 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 506 |
{ # Contains custom value field information. |
| 507 |
"fieldId": 42, # Optional. Field ID in the element. |
| 508 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 509 |
}, |
| 510 |
], |
| 511 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 512 |
"fieldId": 42, # Optional. Field ID in the element. |
| 513 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 514 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 515 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 516 |
}, |
| 517 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 518 |
{ # Contains remarketing value attribute information. |
| 519 |
"fieldId": 42, # Optional. Field ID in the element. |
| 520 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 521 |
"A String", |
| 522 |
], |
| 523 |
}, |
| 524 |
], |
| 525 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 527 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 528 |
}, |
| 529 |
"quantity": 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 |
"versionId": "A String", # 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 |
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile. |
| 535 |
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field. |
| 536 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 537 |
}, |
| 538 |
"description": "A String", # Optional. Description of this dynamic profile. |
| 539 |
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile. |
| 540 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 543 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 544 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 545 |
42, |
| 546 |
], |
| 547 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 548 |
{ # Contains custom rule information. |
| 549 |
"name": "A String", # Optional. Name of this custom rule. |
| 550 |
"priority": 42, # Optional. Priority of the custom rule. |
| 551 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 554 |
{ # Contains field filter information. |
| 555 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 556 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 557 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 558 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 559 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 560 |
}, |
| 561 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 562 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 563 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 564 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 566 |
], |
| 567 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 568 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 569 |
"A String", |
| 570 |
], |
| 571 |
}, |
| 572 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 573 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 574 |
}, |
| 575 |
], |
| 576 |
}, |
| 577 |
], |
| 578 |
}, |
| 579 |
], |
| 580 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 581 |
{ # Contains custom value field information. |
| 582 |
"fieldId": 42, # Optional. Field ID in the element. |
| 583 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 584 |
}, |
| 585 |
], |
| 586 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 587 |
"fieldId": 42, # Optional. Field ID in the element. |
| 588 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 589 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 590 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 591 |
}, |
| 592 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 593 |
{ # Contains remarketing value attribute information. |
| 594 |
"fieldId": 42, # Optional. Field ID in the element. |
| 595 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 596 |
"A String", |
| 597 |
], |
| 598 |
}, |
| 599 |
], |
| 600 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 602 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 603 |
}, |
| 604 |
"quantity": 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 |
"versionId": "A String", # 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 |
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field. |
| 610 |
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile". |
| 611 |
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field. |
| 612 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 613 |
}, |
| 614 |
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long. |
| 615 |
"status": "A String", # Optional. Status of this dynamic profile. |
| 616 |
"studioAdvertiserId": "A String", # 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'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information. |
| 642 |
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile. |
| 643 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 646 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 647 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 648 |
42, |
| 649 |
], |
| 650 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 651 |
{ # Contains custom rule information. |
| 652 |
"name": "A String", # Optional. Name of this custom rule. |
| 653 |
"priority": 42, # Optional. Priority of the custom rule. |
| 654 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 657 |
{ # Contains field filter information. |
| 658 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 659 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 660 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 661 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 662 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 663 |
}, |
| 664 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 665 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 666 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 667 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 669 |
], |
| 670 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 671 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 672 |
"A String", |
| 673 |
], |
| 674 |
}, |
| 675 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 676 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 677 |
}, |
| 678 |
], |
| 679 |
}, |
| 680 |
], |
| 681 |
}, |
| 682 |
], |
| 683 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 684 |
{ # Contains custom value field information. |
| 685 |
"fieldId": 42, # Optional. Field ID in the element. |
| 686 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 687 |
}, |
| 688 |
], |
| 689 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 690 |
"fieldId": 42, # Optional. Field ID in the element. |
| 691 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 692 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 693 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 694 |
}, |
| 695 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 696 |
{ # Contains remarketing value attribute information. |
| 697 |
"fieldId": 42, # Optional. Field ID in the element. |
| 698 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 699 |
"A String", |
| 700 |
], |
| 701 |
}, |
| 702 |
], |
| 703 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 705 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 706 |
}, |
| 707 |
"quantity": 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 |
"versionId": "A String", # 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 |
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile. |
| 713 |
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field. |
| 714 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 715 |
}, |
| 716 |
"description": "A String", # Optional. Description of this dynamic profile. |
| 717 |
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile. |
| 718 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 721 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 722 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 723 |
42, |
| 724 |
], |
| 725 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 726 |
{ # Contains custom rule information. |
| 727 |
"name": "A String", # Optional. Name of this custom rule. |
| 728 |
"priority": 42, # Optional. Priority of the custom rule. |
| 729 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 732 |
{ # Contains field filter information. |
| 733 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 734 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 735 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 736 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 737 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 738 |
}, |
| 739 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 740 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 741 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 742 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 744 |
], |
| 745 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 746 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 747 |
"A String", |
| 748 |
], |
| 749 |
}, |
| 750 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 751 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 752 |
}, |
| 753 |
], |
| 754 |
}, |
| 755 |
], |
| 756 |
}, |
| 757 |
], |
| 758 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 759 |
{ # Contains custom value field information. |
| 760 |
"fieldId": 42, # Optional. Field ID in the element. |
| 761 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 762 |
}, |
| 763 |
], |
| 764 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 765 |
"fieldId": 42, # Optional. Field ID in the element. |
| 766 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 767 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 768 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 769 |
}, |
| 770 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 771 |
{ # Contains remarketing value attribute information. |
| 772 |
"fieldId": 42, # Optional. Field ID in the element. |
| 773 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 774 |
"A String", |
| 775 |
], |
| 776 |
}, |
| 777 |
], |
| 778 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 780 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 781 |
}, |
| 782 |
"quantity": 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 |
"versionId": "A String", # 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 |
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field. |
| 788 |
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile". |
| 789 |
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field. |
| 790 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 791 |
}, |
| 792 |
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long. |
| 793 |
"status": "A String", # Optional. Status of this dynamic profile. |
| 794 |
"studioAdvertiserId": "A String", # 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'd like to use this resource, please reach out to your Google sales representative. Contains dynamic profile information. |
| 806 |
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile. |
| 807 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 810 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 811 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 812 |
42, |
| 813 |
], |
| 814 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 815 |
{ # Contains custom rule information. |
| 816 |
"name": "A String", # Optional. Name of this custom rule. |
| 817 |
"priority": 42, # Optional. Priority of the custom rule. |
| 818 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 821 |
{ # Contains field filter information. |
| 822 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 823 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 824 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 825 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 826 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 827 |
}, |
| 828 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 829 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 830 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 831 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 833 |
], |
| 834 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 835 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 836 |
"A String", |
| 837 |
], |
| 838 |
}, |
| 839 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 840 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 841 |
}, |
| 842 |
], |
| 843 |
}, |
| 844 |
], |
| 845 |
}, |
| 846 |
], |
| 847 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 848 |
{ # Contains custom value field information. |
| 849 |
"fieldId": 42, # Optional. Field ID in the element. |
| 850 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 851 |
}, |
| 852 |
], |
| 853 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 854 |
"fieldId": 42, # Optional. Field ID in the element. |
| 855 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 856 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 857 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 858 |
}, |
| 859 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 860 |
{ # Contains remarketing value attribute information. |
| 861 |
"fieldId": 42, # Optional. Field ID in the element. |
| 862 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 863 |
"A String", |
| 864 |
], |
| 865 |
}, |
| 866 |
], |
| 867 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 869 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 870 |
}, |
| 871 |
"quantity": 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 |
"versionId": "A String", # 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 |
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile. |
| 877 |
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field. |
| 878 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 879 |
}, |
| 880 |
"description": "A String", # Optional. Description of this dynamic profile. |
| 881 |
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile. |
| 882 |
"dynamicProfileFeedSettings": [ # 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 |
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version. |
| 885 |
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |
| 886 |
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| 887 |
42, |
| 888 |
], |
| 889 |
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| 890 |
{ # Contains custom rule information. |
| 891 |
"name": "A String", # Optional. Name of this custom rule. |
| 892 |
"priority": 42, # Optional. Priority of the custom rule. |
| 893 |
"ruleBlocks": [ # 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 |
"fieldFilter": [ # Optional. A list of non-auto field filters |
| 896 |
{ # Contains field filter information. |
| 897 |
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| 898 |
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |
| 899 |
"dynamicFeedId": "A String", # Optional. The ID of the dynamic feed that value's field will match against. |
| 900 |
"elementId": "A String", # Optional. The ID of the element that value's field will match against. |
| 901 |
"fieldId": 42, # Optional. The field id of the dependent field. |
| 902 |
}, |
| 903 |
"fieldId": 42, # Optional. The field ID on the left hand side of the expression. |
| 904 |
"matchType": "A String", # Optional. Left hand side of the expression match type. |
| 905 |
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| 906 |
"excludeFromUserAttributeIds": [ # 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 |
"A String", |
| 908 |
], |
| 909 |
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| 910 |
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| 911 |
"A String", |
| 912 |
], |
| 913 |
}, |
| 914 |
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING. |
| 915 |
"valueType": "A String", # Optional. Right hand side of the expression. |
| 916 |
}, |
| 917 |
], |
| 918 |
}, |
| 919 |
], |
| 920 |
}, |
| 921 |
], |
| 922 |
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| 923 |
{ # Contains custom value field information. |
| 924 |
"fieldId": 42, # Optional. Field ID in the element. |
| 925 |
"requestKey": "A String", # Optional. Custom key used to match for auto filtering. |
| 926 |
}, |
| 927 |
], |
| 928 |
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| 929 |
"fieldId": 42, # Optional. Field ID in the element. |
| 930 |
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter |
| 931 |
"radiusUnitType": "A String", # Optional. The units of the radius value |
| 932 |
"radiusValue": 42, # Optional. Radius length in units defined by radius_units. |
| 933 |
}, |
| 934 |
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs. |
| 935 |
{ # Contains remarketing value attribute information. |
| 936 |
"fieldId": 42, # Optional. Field ID in the element. |
| 937 |
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering. |
| 938 |
"A String", |
| 939 |
], |
| 940 |
}, |
| 941 |
], |
| 942 |
"rotationType": "A String", # 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 |
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN. |
| 944 |
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| 945 |
}, |
| 946 |
"quantity": 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 |
"versionId": "A String", # 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 |
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field. |
| 952 |
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile". |
| 953 |
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field. |
| 954 |
"time": "A String", # Timestamp of the last change in milliseconds since epoch. |
| 955 |
}, |
| 956 |
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long. |
| 957 |
"status": "A String", # Optional. Status of this dynamic profile. |
| 958 |
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic profile. This is a required field on insertion. |
| 959 |
}</pre> |
| 960 |
</div> |
| 961 |
|
| 962 |
</body></html> |