Patch
|
|||||
|
|
||||
Updates an existing remarketing list. This method supports patch semantics
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 25 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
id Required |
INTEGER |
Remarketing list ID |
accountId |
INTEGER |
Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
active |
BOOLEAN |
Whether this remarketing list is active |
advertiserId |
INTEGER |
Dimension value for the advertiser ID that owns this remarketing list. This is a required field |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertiserIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
description |
STRING |
Remarketing list description |
id |
INTEGER |
Remarketing list ID. This is a read-only, auto-generated field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList" |
lifeSpan |
INTEGER |
Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive |
listPopulationRule |
OBJECT |
Remarketing List Population Rule |
listPopulationRule.floodlightActivityId |
INTEGER |
Floodlight activity ID associated with this rule. This field can be left blank |
listPopulationRule.floodlightActivityName |
STRING |
Name of floodlight activity associated with this rule. This is a read-only, auto-generated field |
listPopulationRule.listPopulationClauses[] |
OBJECT |
A group clause made up of list population terms representing constraints joined by ORs |
listPopulationRule.listPopulationClauses[].terms[] |
OBJECT |
Remarketing List Population Rule Term |
listSize |
INTEGER |
Number of users currently in the list. This is a read-only field |
listSource |
ENUMERATION |
Product from which this remarketing list was originated |
name |
STRING |
Name of the remarketing list. This is a required field. Must be no greater than 128 characters long |
subaccountId |
INTEGER |
Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
id INTEGER Required Remarketing list ID |
|
accountId INTEGER Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
|
active BOOLEAN Whether this remarketing list is active |
|
advertiserId INTEGER Dimension value for the advertiser ID that owns this remarketing list. This is a required field |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
advertiserIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
description STRING Remarketing list description |
|
id INTEGER Remarketing list ID. This is a read-only, auto-generated field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList" |
|
lifeSpan INTEGER Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive |
|
listPopulationRule OBJECT Remarketing List Population Rule |
|
listPopulationRule.floodlightActivityId INTEGER Floodlight activity ID associated with this rule. This field can be left blank |
|
listPopulationRule.floodlightActivityName STRING Name of floodlight activity associated with this rule. This is a read-only, auto-generated field |
|
listPopulationRule.listPopulationClauses[] OBJECT A group clause made up of list population terms representing constraints joined by ORs |
|
listPopulationRule.listPopulationClauses[].terms[] OBJECT Remarketing List Population Rule Term |
|
listSize INTEGER Number of users currently in the list. This is a read-only field |
|
listSource ENUMERATION Product from which this remarketing list was originated |
|
name STRING Name of the remarketing list. This is a required field. Must be no greater than 128 characters long |
|
subaccountId INTEGER Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
Output
This building block provides 23 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
active |
BOOLEAN |
Whether this remarketing list is active |
advertiserId |
INTEGER |
Dimension value for the advertiser ID that owns this remarketing list. This is a required field |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
advertiserIdDimensionValue.matchType |
ENUMERATION |
Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
description |
STRING |
Remarketing list description |
id |
INTEGER |
Remarketing list ID. This is a read-only, auto-generated field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList" |
lifeSpan |
INTEGER |
Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive |
listPopulationRule |
OBJECT |
Remarketing List Population Rule |
listPopulationRule.floodlightActivityId |
INTEGER |
Floodlight activity ID associated with this rule. This field can be left blank |
listPopulationRule.floodlightActivityName |
STRING |
Name of floodlight activity associated with this rule. This is a read-only, auto-generated field |
listPopulationRule.listPopulationClauses[] |
OBJECT |
A group clause made up of list population terms representing constraints joined by ORs |
listPopulationRule.listPopulationClauses[].terms[] |
OBJECT |
Remarketing List Population Rule Term |
listSize |
INTEGER |
Number of users currently in the list. This is a read-only field |
listSource |
ENUMERATION |
Product from which this remarketing list was originated |
name |
STRING |
Name of the remarketing list. This is a required field. Must be no greater than 128 characters long |
subaccountId |
INTEGER |
Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
= Parameter name
= Format
|
accountId INTEGER Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
|
active BOOLEAN Whether this remarketing list is active |
|
advertiserId INTEGER Dimension value for the advertiser ID that owns this remarketing list. This is a required field |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
advertiserIdDimensionValue.matchType ENUMERATION Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
description STRING Remarketing list description |
|
id INTEGER Remarketing list ID. This is a read-only, auto-generated field |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList" |
|
lifeSpan INTEGER Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive |
|
listPopulationRule OBJECT Remarketing List Population Rule |
|
listPopulationRule.floodlightActivityId INTEGER Floodlight activity ID associated with this rule. This field can be left blank |
|
listPopulationRule.floodlightActivityName STRING Name of floodlight activity associated with this rule. This is a read-only, auto-generated field |
|
listPopulationRule.listPopulationClauses[] OBJECT A group clause made up of list population terms representing constraints joined by ORs |
|
listPopulationRule.listPopulationClauses[].terms[] OBJECT Remarketing List Population Rule Term |
|
listSize INTEGER Number of users currently in the list. This is a read-only field |
|
listSource ENUMERATION Product from which this remarketing list was originated |
|
name STRING Name of the remarketing list. This is a required field. Must be no greater than 128 characters long |
|
subaccountId INTEGER Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |