Method: targetableRemarketingLists.list

AI-generated Key Takeaways

This method retrieves a list of targetable remarketing lists, with optional filtering and paging.
The HTTP request uses a GET method to a specific URL containing the user's profile ID.
Path parameters include the mandatory profileId for the request.
Query parameters allow filtering the results by advertiser ID, active status, name, and managing pagination and sorting.
The request body must be empty, and the successful response body contains a JSON representation of the list of targetable remarketing lists, including a next page token for pagination.

Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging .

GET https://dfareporting.googleapis.com/dfareporting/v5/userprofiles/{profileId}/targetableRemarketingLists

The URL uses gRPC Transcoding syntax.

Parameters

Parameters
`profileId`	`string ( int64 format)` User profile ID associated with this request.

profileId

string ( int64 format)

User profile ID associated with this request.

Parameters
`advertiserId`	`string ( int64 format)` 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`	`enum ( SortField )` Field by which to sort the list.
`sortOrder`	`enum ( SortOrder )` Order of sorted results.

The request body must be empty.

Targetable remarketing list response

If successful, the response body contains data with the following structure:

JSON representation
{ "kind" : string , "nextPageToken" : string , "targetableRemarketingLists" : [ { object ( `TargetableRemarketingList` ) } ] }

Fields

Fields
`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 ( TargetableRemarketingList )` Targetable remarketing list collection.

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[]

Targetable remarketing list collection.

Requires the following OAuth scope: