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.AdvertiserGroups.List

Contents

Description

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

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

Synopsis

REST Resource

type AdvertiserGroupsListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("advertiserGroups" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AdvertiserGroupsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AdvertiserGroupsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AdvertiserGroupsListResponse))))))))))) #

A resource alias for dfareporting.advertiserGroups.list method which the AdvertiserGroupsList request conforms to.

Creating a Request

advertiserGroupsList #

Creates a value of AdvertiserGroupsList with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data AdvertiserGroupsList #

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

See: advertiserGroupsList smart constructor.

Instances

Eq AdvertiserGroupsList # 
Data AdvertiserGroupsList # 

Methods

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

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

toConstr :: AdvertiserGroupsList -> Constr #

dataTypeOf :: AdvertiserGroupsList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show AdvertiserGroupsList # 
Generic AdvertiserGroupsList # 
GoogleRequest AdvertiserGroupsList # 
type Rep AdvertiserGroupsList # 
type Scopes AdvertiserGroupsList # 
type Scopes AdvertiserGroupsList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)
type Rs AdvertiserGroupsList # 

Request Lenses

aglSearchString :: Lens' AdvertiserGroupsList (Maybe Text) #

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

aglIds :: Lens' AdvertiserGroupsList [Int64] #

Select only advertiser groups with these IDs.

aglProFileId :: Lens' AdvertiserGroupsList Int64 #

User profile ID associated with this request.

aglSortOrder :: Lens' AdvertiserGroupsList (Maybe AdvertiserGroupsListSortOrder) #

Order of sorted results, default is ASCENDING.

aglPageToken :: Lens' AdvertiserGroupsList (Maybe Text) #

Value of the nextPageToken from the previous result page.

aglMaxResults :: Lens' AdvertiserGroupsList (Maybe Int32) #

Maximum number of results to return.