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 activities, possibly filtered. This method supports paging.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.floodlightActivities.list
.
Synopsis
- type FloodlightActivitiesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("floodlightActivities" :> (QueryParam "tagString" Text :> (QueryParam "floodlightActivityGroupTagString" Text :> (QueryParam "floodlightConfigurationId" (Textual Int64) :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParams "floodlightActivityGroupIds" (Textual Int64) :> (QueryParam "sortOrder" FloodlightActivitiesListSortOrder :> (QueryParam "floodlightActivityGroupType" FloodlightActivitiesListFloodlightActivityGroupType :> (QueryParam "floodlightActivityGroupName" Text :> (QueryParam "pageToken" Text :> (QueryParam "sortField" FloodlightActivitiesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] FloodlightActivitiesListResponse))))))))))))))))))
- floodlightActivitiesList :: Int64 -> FloodlightActivitiesList
- data FloodlightActivitiesList
- falTagString :: Lens' FloodlightActivitiesList (Maybe Text)
- falFloodlightActivityGroupTagString :: Lens' FloodlightActivitiesList (Maybe Text)
- falFloodlightConfigurationId :: Lens' FloodlightActivitiesList (Maybe Int64)
- falAdvertiserId :: Lens' FloodlightActivitiesList (Maybe Int64)
- falSearchString :: Lens' FloodlightActivitiesList (Maybe Text)
- falIds :: Lens' FloodlightActivitiesList [Int64]
- falProFileId :: Lens' FloodlightActivitiesList Int64
- falFloodlightActivityGroupIds :: Lens' FloodlightActivitiesList [Int64]
- falSortOrder :: Lens' FloodlightActivitiesList FloodlightActivitiesListSortOrder
- falFloodlightActivityGroupType :: Lens' FloodlightActivitiesList (Maybe FloodlightActivitiesListFloodlightActivityGroupType)
- falFloodlightActivityGroupName :: Lens' FloodlightActivitiesList (Maybe Text)
- falPageToken :: Lens' FloodlightActivitiesList (Maybe Text)
- falSortField :: Lens' FloodlightActivitiesList FloodlightActivitiesListSortField
- falMaxResults :: Lens' FloodlightActivitiesList Int32
REST Resource
type FloodlightActivitiesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("floodlightActivities" :> (QueryParam "tagString" Text :> (QueryParam "floodlightActivityGroupTagString" Text :> (QueryParam "floodlightConfigurationId" (Textual Int64) :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParams "floodlightActivityGroupIds" (Textual Int64) :> (QueryParam "sortOrder" FloodlightActivitiesListSortOrder :> (QueryParam "floodlightActivityGroupType" FloodlightActivitiesListFloodlightActivityGroupType :> (QueryParam "floodlightActivityGroupName" Text :> (QueryParam "pageToken" Text :> (QueryParam "sortField" FloodlightActivitiesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] FloodlightActivitiesListResponse)))))))))))))))))) Source #
A resource alias for dfareporting.floodlightActivities.list
method which the
FloodlightActivitiesList
request conforms to.
Creating a Request
floodlightActivitiesList Source #
Creates a value of FloodlightActivitiesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data FloodlightActivitiesList Source #
Retrieves a list of floodlight activities, possibly filtered. This method supports paging.
See: floodlightActivitiesList
smart constructor.
Instances
Request Lenses
falTagString :: Lens' FloodlightActivitiesList (Maybe Text) Source #
Select only floodlight activities with the specified tag string.
falFloodlightActivityGroupTagString :: Lens' FloodlightActivitiesList (Maybe Text) Source #
Select only floodlight activities with the specified floodlight activity group tag string.
falFloodlightConfigurationId :: Lens' FloodlightActivitiesList (Maybe Int64) Source #
Select only floodlight activities for the specified floodlight configuration ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
falAdvertiserId :: Lens' FloodlightActivitiesList (Maybe Int64) Source #
Select only floodlight activities for the specified advertiser ID. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
falSearchString :: Lens' FloodlightActivitiesList (Maybe Text) Source #
Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "floodlightactivity*2015" will return objects with names like "floodlightactivity June 2015", "floodlightactivity April 2015", or simply "floodlightactivity 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 "floodlightactivity" will match objects with name "my floodlightactivity activity", "floodlightactivity 2015", or simply "floodlightactivity".
falIds :: Lens' FloodlightActivitiesList [Int64] Source #
Select only floodlight activities with the specified IDs. Must specify either ids, advertiserId, or floodlightConfigurationId for a non-empty result.
falProFileId :: Lens' FloodlightActivitiesList Int64 Source #
User profile ID associated with this request.
falFloodlightActivityGroupIds :: Lens' FloodlightActivitiesList [Int64] Source #
Select only floodlight activities with the specified floodlight activity group IDs.
falSortOrder :: Lens' FloodlightActivitiesList FloodlightActivitiesListSortOrder Source #
Order of sorted results.
falFloodlightActivityGroupType :: Lens' FloodlightActivitiesList (Maybe FloodlightActivitiesListFloodlightActivityGroupType) Source #
Select only floodlight activities with the specified floodlight activity group type.
falFloodlightActivityGroupName :: Lens' FloodlightActivitiesList (Maybe Text) Source #
Select only floodlight activities with the specified floodlight activity group name.
falPageToken :: Lens' FloodlightActivitiesList (Maybe Text) Source #
Value of the nextPageToken from the previous result page.
falSortField :: Lens' FloodlightActivitiesList FloodlightActivitiesListSortField Source #
Field by which to sort the list.
falMaxResults :: Lens' FloodlightActivitiesList Int32 Source #
Maximum number of results to return.