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

Contents

Description

Gets a list of subaccounts, possibly filtered. This method supports paging.

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

Synopsis

REST Resource

type SubAccountsListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("subaccounts" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" SubAccountsListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" SubAccountsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] SubAccountsListResponse))))))))))) #

A resource alias for dfareporting.subaccounts.list method which the SubAccountsList request conforms to.

Creating a Request

subAccountsList #

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

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

data SubAccountsList #

Gets a list of subaccounts, possibly filtered. This method supports paging.

See: subAccountsList smart constructor.

Instances

Eq SubAccountsList # 
Data SubAccountsList # 

Methods

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

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

toConstr :: SubAccountsList -> Constr #

dataTypeOf :: SubAccountsList -> DataType #

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

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

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

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

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

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

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

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

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

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

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

Request Lenses

salSearchString :: Lens' SubAccountsList (Maybe Text) #

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

salIds :: Lens' SubAccountsList [Int64] #

Select only subaccounts with these IDs.

salProFileId :: Lens' SubAccountsList Int64 #

User profile ID associated with this request.

salSortOrder :: Lens' SubAccountsList (Maybe SubAccountsListSortOrder) #

Order of sorted results, default is ASCENDING.

salPageToken :: Lens' SubAccountsList (Maybe Text) #

Value of the nextPageToken from the previous result page.

salSortField :: Lens' SubAccountsList (Maybe SubAccountsListSortField) #

Field by which to sort the list.

salMaxResults :: Lens' SubAccountsList (Maybe Int32) #

Maximum number of results to return.