List
|
|||||
|
|
||||
Retrieves a list of remarketing lists, possibly filtered. This method supports paging
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 9 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
advertiserId Required |
INTEGER |
Select only remarketing lists owned by this advertiser |
active |
BOOLEAN |
Select only active or only inactive remarketing lists |
floodlightActivityId |
INTEGER |
Select only remarketing lists that have this floodlight activity ID |
maxResults |
INTEGER |
Maximum number of results to return |
name |
STRING |
Allows searching for objects by name or ID. Wildcards () are allowed. For example, "remarketing list2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list" |
pageToken |
STRING |
Value of the nextPageToken from the previous result page |
sortField |
ENUMERATION |
Field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
advertiserId INTEGER Required Select only remarketing lists owned by this advertiser |
|
active BOOLEAN Select only active or only inactive remarketing lists |
|
floodlightActivityId INTEGER Select only remarketing lists that have this floodlight activity ID |
|
maxResults INTEGER Maximum number of results to return |
|
name STRING Allows searching for objects by name or ID. Wildcards () are allowed. For example, "remarketing list2015" will return objects with names like "remarketing list June 2015", "remarketing list April 2015", or simply "remarketing list 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "remarketing list" will match objects with name "my remarketing list", "remarketing list 2015", or simply "remarketing list" |
|
pageToken STRING Value of the nextPageToken from the previous result page |
|
sortField ENUMERATION Field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
Output
This building block provides 25 output parameters
| Name | Format | Description |
|---|---|---|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
remarketingLists[] |
OBJECT |
Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource |
remarketingLists[].accountId |
INTEGER |
Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
remarketingLists[].active |
BOOLEAN |
Whether this remarketing list is active |
remarketingLists[].advertiserId |
INTEGER |
Dimension value for the advertiser ID that owns this remarketing list. This is a required field |
remarketingLists[].advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
remarketingLists[].advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
remarketingLists[].advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
remarketingLists[].advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
remarketingLists[].advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
remarketingLists[].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 |
remarketingLists[].advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
remarketingLists[].description |
STRING |
Remarketing list description |
remarketingLists[].id |
INTEGER |
Remarketing list ID. This is a read-only, auto-generated field |
remarketingLists[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList" |
remarketingLists[].lifeSpan |
INTEGER |
Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive |
remarketingLists[].listPopulationRule |
OBJECT |
Remarketing List Population Rule |
remarketingLists[].listPopulationRule.floodlightActivityId |
INTEGER |
Floodlight activity ID associated with this rule. This field can be left blank |
remarketingLists[].listPopulationRule.floodlightActivityName |
STRING |
Name of floodlight activity associated with this rule. This is a read-only, auto-generated field |
remarketingLists[].listPopulationRule.listPopulationClauses[] |
OBJECT |
A group clause made up of list population terms representing constraints joined by ORs |
remarketingLists[].listSize |
INTEGER |
Number of users currently in the list. This is a read-only field |
remarketingLists[].listSource |
ENUMERATION |
Product from which this remarketing list was originated |
remarketingLists[].name |
STRING |
Name of the remarketing list. This is a required field. Must be no greater than 128 characters long |
remarketingLists[].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
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingListsListResponse" |
|
nextPageToken STRING Pagination token to be used for the next list operation |
|
remarketingLists[] OBJECT Contains properties of a remarketing list. Remarketing enables you to create lists of users who have performed specific actions on a site, then target ads to members of those lists. This resource can be used to manage remarketing lists that are owned by your advertisers. To see all remarketing lists that are visible to your advertisers, including those that are shared to your advertiser or account, use the TargetableRemarketingLists resource |
|
remarketingLists[].accountId INTEGER Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
|
remarketingLists[].active BOOLEAN Whether this remarketing list is active |
|
remarketingLists[].advertiserId INTEGER Dimension value for the advertiser ID that owns this remarketing list. This is a required field |
|
remarketingLists[].advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
remarketingLists[].advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
remarketingLists[].advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
remarketingLists[].advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
remarketingLists[].advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
remarketingLists[].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 |
|
remarketingLists[].advertiserIdDimensionValue.value STRING The value of the dimension |
|
remarketingLists[].description STRING Remarketing list description |
|
remarketingLists[].id INTEGER Remarketing list ID. This is a read-only, auto-generated field |
|
remarketingLists[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#remarketingList" |
|
remarketingLists[].lifeSpan INTEGER Number of days that a user should remain in the remarketing list without an impression. Acceptable values are 1 to 540, inclusive |
|
remarketingLists[].listPopulationRule OBJECT Remarketing List Population Rule |
|
remarketingLists[].listPopulationRule.floodlightActivityId INTEGER Floodlight activity ID associated with this rule. This field can be left blank |
|
remarketingLists[].listPopulationRule.floodlightActivityName STRING Name of floodlight activity associated with this rule. This is a read-only, auto-generated field |
|
remarketingLists[].listPopulationRule.listPopulationClauses[] OBJECT A group clause made up of list population terms representing constraints joined by ORs |
|
remarketingLists[].listSize INTEGER Number of users currently in the list. This is a read-only field |
|
remarketingLists[].listSource ENUMERATION Product from which this remarketing list was originated |
|
remarketingLists[].name STRING Name of the remarketing list. This is a required field. Must be no greater than 128 characters long |
|
remarketingLists[].subaccountId INTEGER Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |