gogol-dfareporting-0.3.0: Google DCM/DFA Reporting And Trafficking SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.DFAReporting.Advertisers.List

Contents

Description

Retrieves a list of advertisers, possibly filtered. This method supports paging.

See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.advertisers.list.

Synopsis

REST Resource

type AdvertisersListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("advertisers" :> (QueryParam "status" AdvertisersListStatus :> (QueryParam "onlyParent" Bool :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "includeAdvertisersWithoutGroupsOnly" Bool :> (QueryParam "sortOrder" AdvertisersListSortOrder :> (QueryParams "advertiserGroupIds" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AdvertisersListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParams "floodlightConfigurationIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AdvertisersListResponse))))))))))))))))) Source #

A resource alias for dfareporting.advertisers.list method which the AdvertisersList request conforms to.

Creating a Request

data AdvertisersList Source #

Retrieves a list of advertisers, possibly filtered. This method supports paging.

See: advertisersList smart constructor.

Instances

Eq AdvertisersList Source # 
Data AdvertisersList Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdvertisersList -> c AdvertisersList #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdvertisersList #

toConstr :: AdvertisersList -> Constr #

dataTypeOf :: AdvertisersList -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AdvertisersList) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdvertisersList) #

gmapT :: (forall b. Data b => b -> b) -> AdvertisersList -> AdvertisersList #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdvertisersList -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdvertisersList -> r #

gmapQ :: (forall d. Data d => d -> u) -> AdvertisersList -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AdvertisersList -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdvertisersList -> m AdvertisersList #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdvertisersList -> m AdvertisersList #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdvertisersList -> m AdvertisersList #

Show AdvertisersList Source # 
Generic AdvertisersList Source # 
GoogleRequest AdvertisersList Source # 
type Rep AdvertisersList Source # 
type Rep AdvertisersList = D1 (MetaData "AdvertisersList" "Network.Google.Resource.DFAReporting.Advertisers.List" "gogol-dfareporting-0.3.0-1Sz7MzcQaqT30NKUHnKpNh" False) (C1 (MetaCons "AdvertisersList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_allStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AdvertisersListStatus))) ((:*:) (S1 (MetaSel (Just Symbol "_allOnlyParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_allSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_allIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) ((:*:) (S1 (MetaSel (Just Symbol "_allIncludeAdvertisersWithoutGroupsOnly") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_allProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_allSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AdvertisersListSortOrder))) ((:*:) (S1 (MetaSel (Just Symbol "_allAdvertiserGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) (S1 (MetaSel (Just Symbol "_allPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_allSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AdvertisersListSortField))) (S1 (MetaSel (Just Symbol "_allSubAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))))) ((:*:) (S1 (MetaSel (Just Symbol "_allFloodlightConfigurationIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) (S1 (MetaSel (Just Symbol "_allMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))))
type Scopes AdvertisersList Source # 
type Scopes AdvertisersList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)
type Rs AdvertisersList Source # 

Request Lenses

allStatus :: Lens' AdvertisersList (Maybe AdvertisersListStatus) Source #

Select only advertisers with the specified status.

allOnlyParent :: Lens' AdvertisersList (Maybe Bool) Source #

Select only advertisers which use another advertiser's floodlight configuration.

allSearchString :: Lens' AdvertisersList (Maybe Text) Source #

Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 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 "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".

allIds :: Lens' AdvertisersList [Int64] Source #

Select only advertisers with these IDs.

allIncludeAdvertisersWithoutGroupsOnly :: Lens' AdvertisersList (Maybe Bool) Source #

Select only advertisers which do not belong to any advertiser group.

allProFileId :: Lens' AdvertisersList Int64 Source #

User profile ID associated with this request.

allSortOrder :: Lens' AdvertisersList (Maybe AdvertisersListSortOrder) Source #

Order of sorted results, default is ASCENDING.

allAdvertiserGroupIds :: Lens' AdvertisersList [Int64] Source #

Select only advertisers with these advertiser group IDs.

allPageToken :: Lens' AdvertisersList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

allSubAccountId :: Lens' AdvertisersList (Maybe Int64) Source #

Select only advertisers with these subaccount IDs.

allFloodlightConfigurationIds :: Lens' AdvertisersList [Int64] Source #

Select only advertisers with these floodlight configuration IDs.

allMaxResults :: Lens' AdvertisersList (Maybe Int32) Source #

Maximum number of results to return.