Method: targetableRemarketingLists.list

  • This method retrieves a list of targetable remarketing lists, with options for filtering and pagination.

  • The request uses a GET HTTP method and requires a user profileId in the path.

  • The request supports several query parameters to filter the results, including advertiserId, active, maxResults, and name.

  • The response body includes a list of targetableRemarketingLists, a nextPageToken for pagination, and a kind field.

  • Authorization requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

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

HTTP request

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

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 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 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"

.
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

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
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.

Authorization scopes

Requires the following OAuth scope:

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