REST Resource: dynamicProfiles

  • DynamicProfile contains information about a dynamic profile, including its ID, advertiser ID, name, description, status, archive status, creation and modification timestamps, and draft and active versions.

  • DynamicProfileVersion holds dynamic profile version information, including the version ID and associated dynamic feed settings.

  • DynamicProfileFeedSettings specifies settings for a dynamic feed linked to a dynamic profile version, including the feed ID, quantity of rows needed, and dynamic rules for row selection.

  • DynamicRules define how rows are selected from a dynamic feed, specifying the rule type (open, auto, custom, proximity targeting), rotation type (random, optimized, weighted), and various filters like custom rules, proximity filters, weighted fields, auto-targeted fields, custom value fields, and remarketing value attributes.

  • The document outlines various components and enums used within dynamic profiles, such as Status, ArchiveStatus, RuleType, RotationType, MatchType, ValueType, RadiusUnitType, and RadiusBucketType, along with details about CustomRule, RuleBlock, FieldFilter, RequestValue, DependentFieldValue, ProximityFilter, CustomValueField, and RemarketingValueAttribute.

Resource: DynamicProfile

Contains dynamic profile information.

JSON representation 
{
  "dynamicProfileId": string,
  "studioAdvertiserId": string,
  "name": string,
  "description": string,
  "status": enum (Status),
  "archiveStatus": enum (ArchiveStatus),
  "createInfo": {
    object (LastModifiedInfo)
  },
  "lastModifiedInfo": {
    object (LastModifiedInfo)
  },
  "draft": {
    object (DynamicProfileVersion)
  },
  "active": {
    object (DynamicProfileVersion)
  },
  "kind": string
}
Fields
dynamicProfileId

string (int64 format)

Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
studioAdvertiserId

string (int64 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 (Status)

Optional. Status of this dynamic profile.
archiveStatus

enum (ArchiveStatus)

Optional. Archive status of this dynamic profile.
createInfo

object (LastModifiedInfo)

Output only. The creation timestamp of the dynamic profile. This is a read-only field.
lastModifiedInfo

object (LastModifiedInfo)

Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
draft

object (DynamicProfileVersion)

Optional. Draft version of the dynamic profile.
active

object (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 (DynamicProfileFeedSettings)
    }
  ]
}
Fields
versionId

string (int64 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 (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 (DynamicRules)
  }
}
Fields
dynamicFeedId

string (int64 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 (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 (RuleType),
  "rotationType": enum (RotationType),
  "customRules": [
    {
      object (CustomRule)
    }
  ],
  "proximityFilter": {
    object (ProximityFilter)
  },
  "weightFieldId": integer,
  "autoTargetedFieldIds": [
    integer
  ],
  "customValueFields": [
    {
      object (CustomValueField)
    }
  ],
  "remarketingValueAttributes": [
    {
      object (RemarketingValueAttribute)
    }
  ]
}
Fields
ruleType

enum (RuleType)

Optional. The type of the rule, the default value is OPEN.
rotationType

enum (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 (CustomRule)

Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
proximityFilter

object (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 (CustomValueField)

Optional. Mapping between field ID and custom key that are used to match for auto filtering.
remarketingValueAttributes[]

object (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 (RuleBlock)
    }
  ]
}
Fields
priority

integer

Optional. Priority of the custom rule.
name

string

Optional. Name of this custom rule.
ruleBlocks[]

object (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 (FieldFilter)
    }
  ]
}
Fields
fieldFilter[]

object (FieldFilter)

Optional. A list of non-auto field filters

FieldFilter

Contains field filter information.

JSON representation 
{
  "fieldId": integer,
  "matchType": enum (MatchType),
  "valueType": enum (ValueType),
  "stringValue": string,
  "boolValue": boolean,
  "requestValue": {
    object (RequestValue)
  },
  "dependentFieldValue": {
    object (DependentFieldValue)
  }
}
Fields
fieldId

integer

Optional. The field ID on the left hand side of the expression.
matchType

enum (MatchType)

Optional. Left hand side of the expression match type.
valueType

enum (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 (RequestValue)

Optional. The request value, only applicable when rhs_value_type is REQUEST.
dependentFieldValue

object (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 (int64 format)

Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
excludeFromUserAttributeIds[]

string (int64 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
}
Fields
elementId

string (int64 format)

Optional. The ID of the element that value's field will match against.
fieldId

integer

Optional. The field id of the dependent field.

ProximityFilter

Contains proximity filter information.

JSON representation 
{
  "fieldId": integer,
  "radiusValue": integer,
  "radiusUnitType": enum (RadiusUnitType),
  "radiusBucketType": enum (RadiusBucketType)
}
Fields
fieldId

integer

Optional. Field ID in the element.
radiusValue

integer

Optional. Radius length in units defined by radius_units.
radiusUnitType

enum (RadiusUnitType)

Optional. The units of the radius value
radiusBucketType

enum (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 (int64 format)

Optional. Remarketing user attribute IDs for auto filtering.

Methods

get

 Gets a dynamic profile by ID.

insert

 Inserts a new dynamic profile.

update

 Updates an existing dynamic profile.