Close httplib2 connections.
get(dynamicProfileId, x__xgafv=None)
Gets a dynamic profile by ID.
insert(body=None, x__xgafv=None)
Inserts a new dynamic profile.
update(body=None, x__xgafv=None)
Updates an existing dynamic profile.
close()
Close httplib2 connections.
get(dynamicProfileId, x__xgafv=None)
Gets a dynamic profile by ID.
Args:
dynamicProfileId: string, Required. Dynamic profile ID. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"description": "A String", # Optional. Description of this dynamic profile.
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile".
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
"status": "A String", # Optional. Status of this dynamic profile.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
}
insert(body=None, x__xgafv=None)
Inserts a new dynamic profile.
Args:
body: object, The request body.
The object takes the form of:
{ # Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"description": "A String", # Optional. Description of this dynamic profile.
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile".
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
"status": "A String", # Optional. Status of this dynamic profile.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"description": "A String", # Optional. Description of this dynamic profile.
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile".
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
"status": "A String", # Optional. Status of this dynamic profile.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
}
update(body=None, x__xgafv=None)
Updates an existing dynamic profile.
Args:
body: object, The request body.
The object takes the form of:
{ # Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"description": "A String", # Optional. Description of this dynamic profile.
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile".
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
"status": "A String", # Optional. Status of this dynamic profile.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains dynamic profile information.
"active": { # Contains dynamic profile version information. # Optional. Active version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"archiveStatus": "A String", # Optional. Archive status of this dynamic profile.
"createInfo": { # Modification timestamp. # Output only. The creation timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"description": "A String", # Optional. Description of this dynamic profile.
"draft": { # Contains dynamic profile version information. # Optional. Draft version of the dynamic profile.
"dynamicProfileFeedSettings": [ # Optional. Associated dynamic feeds and their settings (including dynamic rules) for this dynamic profile version.
{ # Contains dynamic profile specific settings for an associated dynamic feed.
"dynamicFeedId": "A String", # Optional. Dynamic feed ID associated with dynamic profile version.
"dynamicRules": { # Contains dynamic rules information. # Optional. Dynamic rules for row selection for the given dynamic feed in the given dynamic profile.
"autoTargetedFieldIds": [ # Optional. List of field IDs in this element that should be auto-targeted. Applicable when rule type is AUTO.
42,
],
"customRules": [ # Optional. The custom rules of the dynamic feed, only applicable when rule type is CUSTOM.
{ # Contains custom rule information.
"name": "A String", # Optional. Name of this custom rule.
"priority": 42, # Optional. Priority of the custom rule.
"ruleBlocks": [ # Optional. A list of field filter, the custom rule will apply.
{ # Contains a list of field filters that the given custom rule will apply.
"fieldFilter": [ # Optional. A list of non-auto field filters
{ # Contains field filter information.
"boolValue": True or False, # Optional. The boolean values, only applicable when rhs_value_type is BOOL.
"dependentFieldValue": { # Contains dependent field value information. # Optional. The dependent values, only applicable when rhs_value_type is DEPENDENT.
"elementId": "A String", # Optional. The ID of the element that value's field will match against.
"fieldId": 42, # Optional. The field id of the dependent field.
},
"fieldId": 42, # Optional. The field ID on the left hand side of the expression.
"matchType": "A String", # Optional. Left hand side of the expression match type.
"requestValue": { # Contains request value information. # Optional. The request value, only applicable when rhs_value_type is REQUEST.
"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.
"A String",
],
"key": "A String", # Optional. Custom key in the request. Used only when the field type is CUSTOM_VALUE.
"userAttributeIds": [ # Optional. User attribute IDs in the request. Used only when the field type is REMARKETING_VALUE or USER_ATTRIBUTE_ID.
"A String",
],
},
"stringValue": "A String", # Optional. The string value, only applicable when rhs_value_type is STRING.
"valueType": "A String", # Optional. Right hand side of the expression.
},
],
},
],
},
],
"customValueFields": [ # Optional. Mapping between field ID and custom key that are used to match for auto filtering.
{ # Contains custom value field information.
"fieldId": 42, # Optional. Field ID in the element.
"requestKey": "A String", # Optional. Custom key used to match for auto filtering.
},
],
"proximityFilter": { # Contains proximity filter information. # Optional. The proximity targeting rules of the dynamic feed, only applicable when rule type is PROXIMITY_TARGETING.
"fieldId": 42, # Optional. Field ID in the element.
"radiusBucketType": "A String", # Optional. The radius bucket type of the proximity filter
"radiusUnitType": "A String", # Optional. The units of the radius value
"radiusValue": 42, # Optional. Radius length in units defined by radius_units.
},
"remarketingValueAttributes": [ # Optional. The link between an element field ID and a list of user attribute IDs.
{ # Contains remarketing value attribute information.
"fieldId": 42, # Optional. Field ID in the element.
"userAttributeIds": [ # Optional. Remarketing user attribute IDs for auto filtering.
"A String",
],
},
],
"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.
"ruleType": "A String", # Optional. The type of the rule, the default value is OPEN.
"weightFieldId": 42, # Optional. The field ID for the feed that will be used for weighted rotation, only applicable when rotation type is WEIGHTED.
},
"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.
},
],
"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.
},
"dynamicProfileId": "A String", # Output only. Unique ID of this dynamic profile. This is a read-only, auto-generated field.
"kind": "A String", # Output only. Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicProfile".
"lastModifiedInfo": { # Modification timestamp. # Output only. The last modified timestamp of the dynamic profile. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"name": "A String", # Required. Identifier. Name of this dynamic profile. This is a required field and must be less than 256 characters long.
"status": "A String", # Optional. Status of this dynamic profile.
"studioAdvertiserId": "A String", # Required. Advertiser ID of this dynamic profile. This is a required field on insertion.
}