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 floodlight activity groups, possibly filtered. This method supports paging.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.floodlightActivityGroups.list
.
Synopsis
- type FloodlightActivityGroupsListResource = "dfareporting" :> ("v3.3" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("floodlightActivityGroups" :> (QueryParam "floodlightConfigurationId" (Textual Int64) :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" FloodlightActivityGroupsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" FloodlightActivityGroupsListSortField :> (QueryParam "type" FloodlightActivityGroupsListType :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] FloodlightActivityGroupsListResponse))))))))))))))
- floodlightActivityGroupsList :: Int64 -> FloodlightActivityGroupsList
- data FloodlightActivityGroupsList
- faglFloodlightConfigurationId :: Lens' FloodlightActivityGroupsList (Maybe Int64)
- faglAdvertiserId :: Lens' FloodlightActivityGroupsList (Maybe Int64)
- faglSearchString :: Lens' FloodlightActivityGroupsList (Maybe Text)
- faglIds :: Lens' FloodlightActivityGroupsList [Int64]
- faglProFileId :: Lens' FloodlightActivityGroupsList Int64
- faglSortOrder :: Lens' FloodlightActivityGroupsList FloodlightActivityGroupsListSortOrder
- faglPageToken :: Lens' FloodlightActivityGroupsList (Maybe Text)
- faglSortField :: Lens' FloodlightActivityGroupsList FloodlightActivityGroupsListSortField
- faglType :: Lens' FloodlightActivityGroupsList (Maybe FloodlightActivityGroupsListType)
- faglMaxResults :: Lens' FloodlightActivityGroupsList Int32
REST Resource
type FloodlightActivityGroupsListResource = "dfareporting" :> ("v3.3" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("floodlightActivityGroups" :> (QueryParam "floodlightConfigurationId" (Textual Int64) :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" FloodlightActivityGroupsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" FloodlightActivityGroupsListSortField :> (QueryParam "type" FloodlightActivityGroupsListType :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] FloodlightActivityGroupsListResponse)))))))))))))) Source #
A resource alias for dfareporting.floodlightActivityGroups.list
method which the
FloodlightActivityGroupsList
request conforms to.
Creating a Request
floodlightActivityGroupsList Source #
Creates a value of FloodlightActivityGroupsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data FloodlightActivityGroupsList Source #
Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging.
See: floodlightActivityGroupsList
smart constructor.
Instances
Request Lenses
faglFloodlightConfigurationId :: Lens' FloodlightActivityGroupsList (Maybe Int64) Source #
Select only floodlight activity groups with the specified floodlight configuration ID. Must specify either advertiserId, or floodlightConfigurationId for a non-empty result.
faglAdvertiserId :: Lens' FloodlightActivityGroupsList (Maybe Int64) Source #
Select only floodlight activity groups with the specified advertiser ID. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
faglSearchString :: Lens' FloodlightActivityGroupsList (Maybe Text) Source #
Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivitygroup*2015" will return objects with names like "floodlightactivitygroup June 2015", "floodlightactivitygroup April 2015", or simply "floodlightactivitygroup 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 "floodlightactivitygroup" will match objects with name "my floodlightactivitygroup activity", "floodlightactivitygroup 2015", or simply "floodlightactivitygroup".
faglIds :: Lens' FloodlightActivityGroupsList [Int64] Source #
Select only floodlight activity groups with the specified IDs. Must specify either advertiserId or floodlightConfigurationId for a non-empty result.
faglProFileId :: Lens' FloodlightActivityGroupsList Int64 Source #
User profile ID associated with this request.
faglSortOrder :: Lens' FloodlightActivityGroupsList FloodlightActivityGroupsListSortOrder Source #
Order of sorted results.
faglPageToken :: Lens' FloodlightActivityGroupsList (Maybe Text) Source #
Value of the nextPageToken from the previous result page.
faglSortField :: Lens' FloodlightActivityGroupsList FloodlightActivityGroupsListSortField Source #
Field by which to sort the list.
faglType :: Lens' FloodlightActivityGroupsList (Maybe FloodlightActivityGroupsListType) Source #
Select only floodlight activity groups with the specified floodlight activity group type.
faglMaxResults :: Lens' FloodlightActivityGroupsList Int32 Source #
Maximum number of results to return.