Method: remarketingLists.list

  • The "list" method retrieves a list of remarketing lists, with support for paging and filtering.

  • The HTTP request uses a GET method to a specific URL containing the user profile ID.

  • Path parameters are required to identify the user profile, while query parameters allow for filtering and sorting the list of remarketing lists.

  • The request body must be empty, and the response body contains the retrieved remarketing lists and pagination information in a JSON format.

  • This operation requires the https://www.googleapis.com/auth/dfatrafficking authorization scope.

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

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
profileId

string (int64 format)

User profile ID associated with this request.

Query parameters

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 list*2015"

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.

Request body

The request body must be empty.

Response body

Remarketing list response

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

JSON representation 
{
  "kind": string,
  "nextPageToken": string,
  "remarketingLists": [
    {
      object (RemarketingList)
    }
  ]
}
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.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/dfatrafficking