Method: remarketingLists.list

AI-generated Key Takeaways

This method retrieves a list of remarketing lists, which can be filtered and supports paging.
The HTTP request uses a GET method with a URL structure that includes a profileId path parameter.
The method accepts various query parameters for filtering and sorting the results, such as advertiserId , name , active , and maxResults .
The request body for this method must be empty.
The response body contains a JSON structure with kind , nextPageToken , and an array of remarketingLists .
Authorization requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

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

GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/remarketingLists

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 remarketing lists owned by this advertiser.
`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"` .
`active`	`boolean` Select only active or only inactive remarketing lists.
`floodlightActivityId`	`string ( int64 format)` Select only remarketing lists that have this floodlight activity ID.
`maxResults`	`integer` Maximum number of results to return.
`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.

Remarketing list response

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

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

Fields

Fields
`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 ( RemarketingList )` Remarketing list collection.

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

Remarketing list collection.

Requires the following OAuth scope: