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

Network.Google.Resource.DFAReporting.FloodlightActivities.List

Contents

REST Resource
Creating a Request
Request Lenses

Description

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 #

Arguments

:: Int64	`falProFileId`
-> FloodlightActivitiesList

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

Eq FloodlightActivitiesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.FloodlightActivities.List Methods (==) :: FloodlightActivitiesList -> FloodlightActivitiesList -> Bool # (/=) :: FloodlightActivitiesList -> FloodlightActivitiesList -> Bool #
Data FloodlightActivitiesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.FloodlightActivities.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> FloodlightActivitiesList -> c FloodlightActivitiesList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c FloodlightActivitiesList # toConstr :: FloodlightActivitiesList -> Constr # dataTypeOf :: FloodlightActivitiesList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c FloodlightActivitiesList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c FloodlightActivitiesList) # gmapT :: (forall b. Data b => b -> b) -> FloodlightActivitiesList -> FloodlightActivitiesList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> FloodlightActivitiesList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> FloodlightActivitiesList -> r # gmapQ :: (forall d. Data d => d -> u) -> FloodlightActivitiesList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> FloodlightActivitiesList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> FloodlightActivitiesList -> m FloodlightActivitiesList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> FloodlightActivitiesList -> m FloodlightActivitiesList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> FloodlightActivitiesList -> m FloodlightActivitiesList #
Show FloodlightActivitiesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.FloodlightActivities.List Methods showsPrec :: Int -> FloodlightActivitiesList -> ShowS # show :: FloodlightActivitiesList -> String # showList :: [FloodlightActivitiesList] -> ShowS #
Generic FloodlightActivitiesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.FloodlightActivities.List Associated Types type Rep FloodlightActivitiesList :: Type -> Type # Methods from :: FloodlightActivitiesList -> Rep FloodlightActivitiesList x # to :: Rep FloodlightActivitiesList x -> FloodlightActivitiesList #
GoogleRequest FloodlightActivitiesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.FloodlightActivities.List Associated Types type Rs FloodlightActivitiesList :: Type # type Scopes FloodlightActivitiesList :: [Symbol] # Methods requestClient :: FloodlightActivitiesList -> GClient (Rs FloodlightActivitiesList) #
type Rep FloodlightActivitiesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.FloodlightActivities.List type Rep FloodlightActivitiesList = D1 (MetaData "FloodlightActivitiesList" "Network.Google.Resource.DFAReporting.FloodlightActivities.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "FloodlightActivitiesList'" PrefixI True) (((S1 (MetaSel (Just "_falTagString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_falFloodlightActivityGroupTagString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_falFloodlightConfigurationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))))) :: ((S1 (MetaSel (Just "_falAdvertiserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :: S1 (MetaSel (Just "_falSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_falIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: S1 (MetaSel (Just "_falProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))))) :: ((S1 (MetaSel (Just "_falFloodlightActivityGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: (S1 (MetaSel (Just "_falSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FloodlightActivitiesListSortOrder) :: S1 (MetaSel (Just "_falFloodlightActivityGroupType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FloodlightActivitiesListFloodlightActivityGroupType)))) :: ((S1 (MetaSel (Just "_falFloodlightActivityGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_falPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_falSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FloodlightActivitiesListSortField) :*: S1 (MetaSel (Just "_falMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)))))))
type Scopes FloodlightActivitiesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.FloodlightActivities.List type Scopes FloodlightActivitiesList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs FloodlightActivitiesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.FloodlightActivities.List type Rs FloodlightActivitiesList = FloodlightActivitiesListResponse

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.