Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves a list of targetable remarketing lists, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.targetableRemarketingLists.list
.
- type TargetableRemarketingListsListResource = "dfareporting" :> ("v2.5" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("targetableRemarketingLists" :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "sortOrder" TargetableRemarketingListsListSortOrder :> (QueryParam "active" Bool :> (QueryParam "name" Text :> (QueryParam "pageToken" Text :> (QueryParam "sortField" TargetableRemarketingListsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] TargetableRemarketingListsListResponse))))))))))))
- targetableRemarketingListsList :: Int64 -> Int64 -> TargetableRemarketingListsList
- data TargetableRemarketingListsList
- trllAdvertiserId :: Lens' TargetableRemarketingListsList Int64
- trllProFileId :: Lens' TargetableRemarketingListsList Int64
- trllSortOrder :: Lens' TargetableRemarketingListsList (Maybe TargetableRemarketingListsListSortOrder)
- trllActive :: Lens' TargetableRemarketingListsList (Maybe Bool)
- trllName :: Lens' TargetableRemarketingListsList (Maybe Text)
- trllPageToken :: Lens' TargetableRemarketingListsList (Maybe Text)
- trllSortField :: Lens' TargetableRemarketingListsList (Maybe TargetableRemarketingListsListSortField)
- trllMaxResults :: Lens' TargetableRemarketingListsList (Maybe Int32)
REST Resource
type TargetableRemarketingListsListResource = "dfareporting" :> ("v2.5" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("targetableRemarketingLists" :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "sortOrder" TargetableRemarketingListsListSortOrder :> (QueryParam "active" Bool :> (QueryParam "name" Text :> (QueryParam "pageToken" Text :> (QueryParam "sortField" TargetableRemarketingListsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] TargetableRemarketingListsListResponse)))))))))))) Source #
A resource alias for dfareporting.targetableRemarketingLists.list
method which the
TargetableRemarketingListsList
request conforms to.
Creating a Request
targetableRemarketingListsList Source #
Creates a value of TargetableRemarketingListsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data TargetableRemarketingListsList Source #
Retrieves a list of targetable remarketing lists, possibly filtered.
See: targetableRemarketingListsList
smart constructor.
Request Lenses
trllAdvertiserId :: Lens' TargetableRemarketingListsList Int64 Source #
Select only targetable remarketing lists targetable by these advertisers.
trllProFileId :: Lens' TargetableRemarketingListsList Int64 Source #
User profile ID associated with this request.
trllSortOrder :: Lens' TargetableRemarketingListsList (Maybe TargetableRemarketingListsListSortOrder) Source #
Order of sorted results, default is ASCENDING.
trllActive :: Lens' TargetableRemarketingListsList (Maybe Bool) Source #
Select only active or only inactive targetable remarketing lists.
trllName :: Lens' TargetableRemarketingListsList (Maybe Text) Source #
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".
trllPageToken :: Lens' TargetableRemarketingListsList (Maybe Text) Source #
Value of the nextPageToken from the previous result page.
trllSortField :: Lens' TargetableRemarketingListsList (Maybe TargetableRemarketingListsListSortField) Source #
Field by which to sort the list.
trllMaxResults :: Lens' TargetableRemarketingListsList (Maybe Int32) Source #
Maximum number of results to return.