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

Contents

Description

Retrieves a list of account user profiles, possibly filtered. This method supports paging.

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

Synopsis

REST Resource

type AccountUserProFilesListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("accountUserProfiles" :> (QueryParam "userRoleId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AccountUserProFilesListSortOrder :> (QueryParam "active" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AccountUserProFilesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AccountUserProFilesListResponse)))))))))))))) #

A resource alias for dfareporting.accountUserProfiles.list method which the AccountUserProFilesList request conforms to.

Creating a Request

accountUserProFilesList #

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

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

data AccountUserProFilesList #

Retrieves a list of account user profiles, possibly filtered. This method supports paging.

See: accountUserProFilesList smart constructor.

Instances

Eq AccountUserProFilesList # 
Data AccountUserProFilesList # 

Methods

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

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

toConstr :: AccountUserProFilesList -> Constr #

dataTypeOf :: AccountUserProFilesList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show AccountUserProFilesList # 
Generic AccountUserProFilesList # 
GoogleRequest AccountUserProFilesList # 
type Rep AccountUserProFilesList # 
type Rep AccountUserProFilesList = D1 (MetaData "AccountUserProFilesList" "Network.Google.Resource.DFAReporting.AccountUserProFiles.List" "gogol-dfareporting-0.3.0-4Vz9myrj4dyHC7jfOIh39Z" False) (C1 (MetaCons "AccountUserProFilesList'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aupflUserRoleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) (S1 (MetaSel (Just Symbol "_aupflSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aupflIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) ((:*:) (S1 (MetaSel (Just Symbol "_aupflProFileId") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 (Textual Int64))) (S1 (MetaSel (Just Symbol "_aupflSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AccountUserProFilesListSortOrder)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aupflActive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_aupflPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aupflSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AccountUserProFilesListSortField))) ((:*:) (S1 (MetaSel (Just Symbol "_aupflSubAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))) (S1 (MetaSel (Just Symbol "_aupflMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))))
type Scopes AccountUserProFilesList # 
type Scopes AccountUserProFilesList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)
type Rs AccountUserProFilesList # 

Request Lenses

aupflUserRoleId :: Lens' AccountUserProFilesList (Maybe Int64) #

Select only user profiles with the specified user role ID.

aupflSearchString :: Lens' AccountUserProFilesList (Maybe Text) #

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

aupflIds :: Lens' AccountUserProFilesList [Int64] #

Select only user profiles with these IDs.

aupflProFileId :: Lens' AccountUserProFilesList Int64 #

User profile ID associated with this request.

aupflSortOrder :: Lens' AccountUserProFilesList (Maybe AccountUserProFilesListSortOrder) #

Order of sorted results, default is ASCENDING.

aupflActive :: Lens' AccountUserProFilesList (Maybe Bool) #

Select only active user profiles.

aupflPageToken :: Lens' AccountUserProFilesList (Maybe Text) #

Value of the nextPageToken from the previous result page.

aupflSubAccountId :: Lens' AccountUserProFilesList (Maybe Int64) #

Select only user profiles with the specified subaccount ID.

aupflMaxResults :: Lens' AccountUserProFilesList (Maybe Int32) #

Maximum number of results to return.