- [Resource: DynamicProfile](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfile)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfile.SCHEMA_REPRESENTATION)
- [Status](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#Status)
- [ArchiveStatus](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ArchiveStatus)
- [DynamicProfileVersion](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileVersion)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileVersion.SCHEMA_REPRESENTATION)
- [DynamicProfileFeedSettings](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileFeedSettings)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileFeedSettings.SCHEMA_REPRESENTATION)
- [DynamicRules](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicRules)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicRules.SCHEMA_REPRESENTATION)
- [RuleType](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RuleType)
- [RotationType](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RotationType)
- [CustomRule](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#CustomRule)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#CustomRule.SCHEMA_REPRESENTATION)
- [RuleBlock](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RuleBlock)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RuleBlock.SCHEMA_REPRESENTATION)
- [FieldFilter](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#FieldFilter)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#FieldFilter.SCHEMA_REPRESENTATION)
- [MatchType](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#MatchType)
- [ValueType](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ValueType)
- [RequestValue](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RequestValue)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RequestValue.SCHEMA_REPRESENTATION)
- [DependentFieldValue](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DependentFieldValue)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DependentFieldValue.SCHEMA_REPRESENTATION)
- [ProximityFilter](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ProximityFilter)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ProximityFilter.SCHEMA_REPRESENTATION)
- [RadiusUnitType](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RadiusUnitType)
- [RadiusBucketType](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RadiusBucketType)
- [CustomValueField](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#CustomValueField)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#CustomValueField.SCHEMA_REPRESENTATION)
- [RemarketingValueAttribute](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RemarketingValueAttribute)
  - [JSON representation](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RemarketingValueAttribute.SCHEMA_REPRESENTATION)
- [Methods](https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#METHODS_SUMMARY)

## Resource: DynamicProfile

<br />

> [!WARNING]
> **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.

<br />

| JSON representation |
|---|
| ``` { "dynamicProfileId": string, "studioAdvertiserId": string, "name": string, "description": string, "status": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#Status`), "archiveStatus": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ArchiveStatus`), "createInfo": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/LastModifiedInfo`) }, "lastModifiedInfo": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/LastModifiedInfo`) }, "draft": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileVersion`) }, "active": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileVersion`) }, "kind": string } ``` |

| Fields ||
|---|---|
| `dynamicProfileId` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field. |
| `studioAdvertiserId` | `string (https://developers.google.com/discovery/v1/type-format format)` Required. Advertiser ID of this dynamic profile. This is a required field on insertion. |
| `name` | `string` Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long. |
| `description` | `string` Optional. Description of this dynamic profile. |
| `status` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#Status`)`` Optional. Status of this dynamic profile. |
| `archiveStatus` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ArchiveStatus`)`` Optional. Archive status of this dynamic profile. |
| `createInfo` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/LastModifiedInfo`)`` Output only. The creation timestamp of the dynamic profile. This is a read-only field. |
| `lastModifiedInfo` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/LastModifiedInfo`)`` Output only. The last modified timestamp of the dynamic profile. This is a read-only field. |
| `draft` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileVersion`)`` Optional. Draft version of the dynamic profile. |
| `active` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileVersion`)`` Optional. Active version of the dynamic profile. |
| `kind` | `string` Output only. Identifies what kind of resource this is. Value: the fixed string `"dfareporting#dynamicProfile"`. |

## Status

Status of this dynamic profile.

| Enums ||
|---|---|
| `STATUS_UNKNOWN` | The dynamic profile status is unknown. This value is unused. |
| `ACTIVE` | The dynamic profile is active. |
| `INACTIVE` | The dynamic profile is inactive. |
| `DELETED` | The dynamic profile is deleted. |

## ArchiveStatus

Archive status of this dynamic profile.

| Enums ||
|---|---|
| `ARCHIVE_STATUS_UNKNOWN` | The dynamic profile archive status is unknown. This value is unused. |
| `UNARCHIVED` | The dynamic profile archive status is unarchived. |
| `ARCHIVED` | The dynamic profile archive status is archived. |

## DynamicProfileVersion

Contains dynamic profile version information.

| JSON representation |
|---|
| ``` { "versionId": string, "dynamicProfileFeedSettings": [ { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileFeedSettings`) } ] } ``` |

| Fields ||
|---|---|
| `versionId` | `string (https://developers.google.com/discovery/v1/type-format format)` 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. |
| `dynamicProfileFeedSettings[]` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicProfileFeedSettings`)`` Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version. |

## DynamicProfileFeedSettings

Contains dynamic profile specific settings for an associated dynamic feed.

| JSON representation |
|---|
| ``` { "dynamicFeedId": string, "quantity": integer, "dynamicRules": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicRules`) } } ``` |

| Fields ||
|---|---|
| `dynamicFeedId` | `string (https://developers.google.com/discovery/v1/type-format format)` Optional. Dynamic feed ID associated with dynamic profile version. |
| `quantity` | `integer` 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. |
| `dynamicRules` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DynamicRules`)`` Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile. |

## DynamicRules

Contains dynamic rules information.

| JSON representation |
|---|
| ``` { "ruleType": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RuleType`), "rotationType": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RotationType`), "customRules": [ { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#CustomRule`) } ], "proximityFilter": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ProximityFilter`) }, "weightFieldId": integer, "autoTargetedFieldIds": [ integer ], "customValueFields": [ { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#CustomValueField`) } ], "remarketingValueAttributes": [ { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RemarketingValueAttribute`) } ] } ``` |

| Fields ||
|---|---|
| `ruleType` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RuleType`)`` Optional. The type of the rule, the default value is OPEN. |
| `rotationType` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RotationType`)`` Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows. |
| `customRules[]` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#CustomRule`)`` Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM. |
| `proximityFilter` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ProximityFilter`)`` Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING. |
| `weightFieldId` | `integer` Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED. |
| `autoTargetedFieldIds[]` | `integer` Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO. |
| `customValueFields[]` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#CustomValueField`)`` Optional. Mapping between field ID and custom key that are used to match for auto filtering. |
| `remarketingValueAttributes[]` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RemarketingValueAttribute`)`` Optional. The link between an element field ID and a list of user attribute IDs. |

## RuleType

The type of the dynamic rule.

| Enums ||
|---|---|
| `RULE_SET_TYPE_UNKNOWN` | The rule type is unknown. This value is unused. |
| `OPEN` | The rule type is open, all feed rows are eligible for selection. This is the default value. |
| `AUTO` | The rule type is auto, the feed rows are eligible for selection based on the automatic rules. |
| `CUSTOM` | The rule type is custom, the feed rows are eligible for selection based on the custom rules. |
| `PROXIMITY_TARGETING` | The rule type is proximity targeting, the feed rows are eligible for selection based on the proximity targeting rules. |

## RotationType

The rotation type of the rule.

| Enums ||
|---|---|
| `ROTATION_TYPE_UNKNOWN` | The rotation type is unknown. This value is unused. |
| `RANDOM` | The rotation type is random. It is the default value. |
| `OPTIMIZED` | The rotation type is optimized. |
| `WEIGHTED` | The rotation type is weighted. |

## CustomRule

Contains custom rule information.

| JSON representation |
|---|
| ``` { "priority": integer, "name": string, "ruleBlocks": [ { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RuleBlock`) } ] } ``` |

| Fields ||
|---|---|
| `priority` | `integer` Optional. Priority of the custom rule. |
| `name` | `string` Optional. Name of this custom rule. |
| `ruleBlocks[]` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RuleBlock`)`` Optional. A list of field filter, the custom rule will apply. |

## RuleBlock

Contains a list of field filters that the given custom rule will apply.

| JSON representation |
|---|
| ``` { "fieldFilter": [ { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#FieldFilter`) } ] } ``` |

| Fields ||
|---|---|
| `fieldFilter[]` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#FieldFilter`)`` Optional. A list of non-auto field filters |

## FieldFilter

Contains field filter information.

| JSON representation |
|---|
| ``` { "fieldId": integer, "matchType": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#MatchType`), "valueType": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ValueType`), "stringValue": string, "boolValue": boolean, "requestValue": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RequestValue`) }, "dependentFieldValue": { object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DependentFieldValue`) } } ``` |

| Fields ||
|---|---|
| `fieldId` | `integer` Optional. The field ID on the left hand side of the expression. |
| `matchType` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#MatchType`)`` Optional. Left hand side of the expression match type. |
| `valueType` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#ValueType`)`` Optional. Right hand side of the expression. |
| `stringValue` | `string` Optional. The string value, only applicable when rhs_value_type is STRING. |
| `boolValue` | `boolean` Optional. The boolean values, only applicable when rhs_value_type is BOOL. |
| `requestValue` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RequestValue`)`` Optional. The request value, only applicable when rhs_value_type is REQUEST. |
| `dependentFieldValue` | ``object (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#DependentFieldValue`)`` Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT. |

## MatchType

The type of the match type for the left hand side of the expression.

| Enums ||
|---|---|
| `LHS_MATCH_TYPE_UNKNOWN` | The left hand side of the expression is unknown. This value is unused. |
| `EQUALS_OR_UNRESTRICTED` | The left hand side of the expression is equals or unrestricted. It is the default value. |
| `EQUALS` | The left hand side of the expression is equals. |
| `UNRESTRICTED` | The left hand side of the expression is unrestricted. Unrestricted is used to target fields with no restrictions. For example, country targeting fields hold a list of countries. If the list is empty, we consider the element value to have no restrictions. |
| `NOT_EQUALS` | Left hand side of the expression is not equals. Not equals specifies which fields should not be targeted. |

## ValueType

The type of the right hand side of the expression.

| Enums ||
|---|---|
| `RHS_VALUE_TYPE_UNKNOWN` | The right hand side of the expression is unknown. This value is unused. |
| `STRING` | The right hand side of the expression is a string. |
| `REQUEST` | The right hand side of the expression is a request value. |
| `BOOL` | The right hand side of the expression is a boolean. |
| `DEPENDENT` | The right hand side of the expression is a dependent field value. |

## RequestValue

Contains request value information.

| JSON representation |
|---|
| ``` { "key": string, "userAttributeIds": [ string ], "excludeFromUserAttributeIds": [ string ] } ``` |

| Fields ||
|---|---|
| `key` | `string` Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE. |
| `userAttributeIds[]` | `string (https://developers.google.com/discovery/v1/type-format format)` Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |
| `excludeFromUserAttributeIds[]` | `string (https://developers.google.com/discovery/v1/type-format format)` Optional. User attribute IDs in the request that should be excluded. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID. |

## DependentFieldValue

Contains dependent field value information.

| JSON representation |
|---|
| ``` { "elementId": string, "fieldId": integer, "dynamicFeedId": string } ``` |

| Fields ||
|---|---|
| `elementId` | `string (https://developers.google.com/discovery/v1/type-format format)` Optional. The ID of the element that value's field will match against. |
| `fieldId` | `integer` Optional. The field id of the dependent field. |
| `dynamicFeedId` | `string (https://developers.google.com/discovery/v1/type-format format)` Optional. The ID of the dynamic feed that value's field will match against. |

## ProximityFilter

Contains proximity filter information.

| JSON representation |
|---|
| ``` { "fieldId": integer, "radiusValue": integer, "radiusUnitType": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RadiusUnitType`), "radiusBucketType": enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RadiusBucketType`) } ``` |

| Fields ||
|---|---|
| `fieldId` | `integer` Optional. Field ID in the element. |
| `radiusValue` | `integer` Optional. Radius length in units defined by radius_units. |
| `radiusUnitType` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RadiusUnitType`)`` Optional. The units of the radius value |
| `radiusBucketType` | ``enum (`https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles#RadiusBucketType`)`` Optional. The radius bucket type of the proximity filter |

## RadiusUnitType

The units of the radius value

| Enums ||
|---|---|
| `RADIUS_UNIT_TYPE_UNKNOWN` | The units of the radius value are unknown. This value is unused. |
| `KILOMETERS` | The units of the radius value are kilometers. |
| `MILES` | The units of the radius value are miles. |

## RadiusBucketType

The radius bucket type of the proximity filter

| Enums ||
|---|---|
| `RADIUS_BUCKET_TYPE_UNKNOWN` | The radius bucket type is unknown. |
| `SMALL` | The radius bucket type is small. |
| `MEDIUM` | The radius bucket type is medium. |
| `LARGE` | The radius bucket type is large. |
| `MULTI_REGIONAL` | The radius bucket type is multi-regional. |
| `NATIONAL` | The radius bucket type is national. |

## CustomValueField

Contains custom value field information.

| JSON representation |
|---|
| ``` { "fieldId": integer, "requestKey": string } ``` |

| Fields ||
|---|---|
| `fieldId` | `integer` Optional. Field ID in the element. |
| `requestKey` | `string` Optional. Custom key used to match for auto filtering. |

## RemarketingValueAttribute

Contains remarketing value attribute information.

| JSON representation |
|---|
| ``` { "fieldId": integer, "userAttributeIds": [ string ] } ``` |

| Fields ||
|---|---|
| `fieldId` | `integer` Optional. Field ID in the element. |
| `userAttributeIds[]` | `string (https://developers.google.com/discovery/v1/type-format format)` Optional. Remarketing user attribute IDs for auto filtering. |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles/generateCode` | Generates code for a dynamic profile, which will need unescaping. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles/get` | Gets a dynamic profile by ID. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles/insert` | Inserts a new dynamic profile. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles/publish` | Publish for a dynamic profile. |
| ### `https://developers.google.com/doubleclick-advertisers/rest/v5/dynamicProfiles/update` | Updates an existing dynamic profile. |