Copyright | (c) 2015 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 placement strategies, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.placementStrategies.list
.
- type PlacementStrategiesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("placementStrategies" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" PlacementStrategiesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" PlacementStrategiesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` PlacementStrategiesListResponse)))))))))))
- placementStrategiesList :: Int64 -> PlacementStrategiesList
- data PlacementStrategiesList
- pslSearchString :: Lens' PlacementStrategiesList (Maybe Text)
- pslIds :: Lens' PlacementStrategiesList [Int64]
- pslProFileId :: Lens' PlacementStrategiesList Int64
- pslSortOrder :: Lens' PlacementStrategiesList (Maybe PlacementStrategiesListSortOrder)
- pslPageToken :: Lens' PlacementStrategiesList (Maybe Text)
- pslSortField :: Lens' PlacementStrategiesList (Maybe PlacementStrategiesListSortField)
- pslMaxResults :: Lens' PlacementStrategiesList (Maybe Int32)
REST Resource
type PlacementStrategiesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("placementStrategies" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" PlacementStrategiesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" PlacementStrategiesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` PlacementStrategiesListResponse))))))))))) Source
A resource alias for dfareporting.placementStrategies.list
method which the
PlacementStrategiesList
request conforms to.
Creating a Request
placementStrategiesList Source
Creates a value of PlacementStrategiesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data PlacementStrategiesList Source
Retrieves a list of placement strategies, possibly filtered.
See: placementStrategiesList
smart constructor.
Request Lenses
pslSearchString :: Lens' PlacementStrategiesList (Maybe Text) Source
Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "placementstrategy*2015" will return objects with names like "placementstrategy June 2015", "placementstrategy April 2015", or simply "placementstrategy 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 "placementstrategy" will match objects with name "my placementstrategy", "placementstrategy 2015", or simply "placementstrategy".
pslIds :: Lens' PlacementStrategiesList [Int64] Source
Select only placement strategies with these IDs.
pslProFileId :: Lens' PlacementStrategiesList Int64 Source
User profile ID associated with this request.
pslSortOrder :: Lens' PlacementStrategiesList (Maybe PlacementStrategiesListSortOrder) Source
Order of sorted results, default is ASCENDING.
pslPageToken :: Lens' PlacementStrategiesList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
pslSortField :: Lens' PlacementStrategiesList (Maybe PlacementStrategiesListSortField) Source
Field by which to sort the list.
pslMaxResults :: Lens' PlacementStrategiesList (Maybe Int32) Source
Maximum number of results to return.