List
|
|||||
|
|
||||
Retrieves a list of targetable 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 8 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
advertiserId Required |
INTEGER |
Select only targetable remarketing lists targetable by these advertisers |
active |
BOOLEAN |
Select only active or only inactive targetable remarketing lists |
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 targetable remarketing lists targetable by these advertisers |
|
active BOOLEAN Select only active or only inactive targetable remarketing lists |
|
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 21 output parameters
| Name | Format | Description |
|---|---|---|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingListsListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
targetableRemarketingLists[] |
OBJECT |
Contains properties of a targetable 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 is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource |
targetableRemarketingLists[].accountId |
INTEGER |
Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
targetableRemarketingLists[].active |
BOOLEAN |
Whether this targetable remarketing list is active |
targetableRemarketingLists[].advertiserId |
INTEGER |
Dimension value for the advertiser ID that owns this targetable remarketing list |
targetableRemarketingLists[].advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
targetableRemarketingLists[].advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
targetableRemarketingLists[].advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
targetableRemarketingLists[].advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
targetableRemarketingLists[].advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
targetableRemarketingLists[].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 |
targetableRemarketingLists[].advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
targetableRemarketingLists[].description |
STRING |
Targetable remarketing list description |
targetableRemarketingLists[].id |
INTEGER |
Targetable remarketing list ID |
targetableRemarketingLists[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList" |
targetableRemarketingLists[].lifeSpan |
INTEGER |
Number of days that a user should remain in the targetable remarketing list without an impression |
targetableRemarketingLists[].listSize |
INTEGER |
Number of users currently in the list. This is a read-only field |
targetableRemarketingLists[].listSource |
ENUMERATION |
Product from which this targetable remarketing list was originated |
targetableRemarketingLists[].name |
STRING |
Name of the targetable remarketing list. Is no greater than 128 characters long |
targetableRemarketingLists[].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#targetableRemarketingListsListResponse" |
|
nextPageToken STRING Pagination token to be used for the next list operation |
|
targetableRemarketingLists[] OBJECT Contains properties of a targetable 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 is a read-only view of a remarketing list to be used to faciliate targeting ads to specific lists. Remarketing lists that are owned by your advertisers and those that are shared to your advertisers or account are accessible via this resource. To manage remarketing lists that are owned by your advertisers, use the RemarketingLists resource |
|
targetableRemarketingLists[].accountId INTEGER Account ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |
|
targetableRemarketingLists[].active BOOLEAN Whether this targetable remarketing list is active |
|
targetableRemarketingLists[].advertiserId INTEGER Dimension value for the advertiser ID that owns this targetable remarketing list |
|
targetableRemarketingLists[].advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
targetableRemarketingLists[].advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
targetableRemarketingLists[].advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
targetableRemarketingLists[].advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
targetableRemarketingLists[].advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
targetableRemarketingLists[].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 |
|
targetableRemarketingLists[].advertiserIdDimensionValue.value STRING The value of the dimension |
|
targetableRemarketingLists[].description STRING Targetable remarketing list description |
|
targetableRemarketingLists[].id INTEGER Targetable remarketing list ID |
|
targetableRemarketingLists[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#targetableRemarketingList" |
|
targetableRemarketingLists[].lifeSpan INTEGER Number of days that a user should remain in the targetable remarketing list without an impression |
|
targetableRemarketingLists[].listSize INTEGER Number of users currently in the list. This is a read-only field |
|
targetableRemarketingLists[].listSource ENUMERATION Product from which this targetable remarketing list was originated |
|
targetableRemarketingLists[].name STRING Name of the targetable remarketing list. Is no greater than 128 characters long |
|
targetableRemarketingLists[].subaccountId INTEGER Subaccount ID of this remarketing list. This is a read-only, auto-generated field that is only returned in GET requests |