Method: remarketingLists.list
Stay organized with collections
Save and categorize content based on your preferences.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of remarketing lists, filtered by optional parameters like advertiser ID, name, status, and floodlight activity ID, supporting pagination for large result sets.\u003c/p\u003e\n"],["\u003cp\u003eAllows sorting the list by a specified field and order, and limits the maximum number of results returned per request using query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe API request uses a GET method with path and query parameters, requiring an empty request body and returning a JSON response containing remarketing list details and a pagination token.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses include a list of remarketing lists, a pagination token for retrieving subsequent pages, and an indicator of the resource type.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes the \u003ccode\u003edfatrafficking\u003c/code\u003e OAuth scope for authorization to access and retrieve remarketing list data.\u003c/p\u003e\n"]]],[],null,["# Method: remarketingLists.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.RemarketingListsListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of remarketing lists, possibly filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/remarketingLists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n\n### Query parameters\n\n| Parameters ||\n|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `advertiser``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. Select only remarketing lists owned by this advertiser. |\n| `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\"` . |\n| `active` | `boolean` Select only active or only inactive remarketing lists. |\n| `floodlight``Activity``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only remarketing lists that have this floodlight activity ID. |\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nRemarketing list response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"remarketingLists\": [ { object (/doubleclick-advertisers/rest/v4/remarketingLists#RemarketingList) } ] } ``` |\n\n| Fields ||\n|------------------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#remarketingListsListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `remarketing``Lists[]` | `object (`[RemarketingList](/doubleclick-advertisers/rest/v4/remarketingLists#RemarketingList)`)` Remarketing list collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]