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

Contents

REST Resource
Creating a Request
Request Lenses

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

type AccountUserProFilesListResource = "dfareporting" :> ("v3.2" :> ("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))))))))))))))
accountUserProFilesList :: Int64 -> AccountUserProFilesList
data AccountUserProFilesList
aupflUserRoleId :: Lens' AccountUserProFilesList (Maybe Int64)
aupflSearchString :: Lens' AccountUserProFilesList (Maybe Text)
aupflIds :: Lens' AccountUserProFilesList [Int64]
aupflProFileId :: Lens' AccountUserProFilesList Int64
aupflSortOrder :: Lens' AccountUserProFilesList AccountUserProFilesListSortOrder
aupflActive :: Lens' AccountUserProFilesList (Maybe Bool)
aupflPageToken :: Lens' AccountUserProFilesList (Maybe Text)
aupflSortField :: Lens' AccountUserProFilesList AccountUserProFilesListSortField
aupflSubAccountId :: Lens' AccountUserProFilesList (Maybe Int64)
aupflMaxResults :: Lens' AccountUserProFilesList Int32

REST Resource

type AccountUserProFilesListResource = "dfareporting" :> ("v3.2" :> ("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)))))))))))))) Source #

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

Creating a Request

accountUserProFilesList Source #

Arguments

:: Int64	`aupflProFileId`
-> 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 Source #

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

See: accountUserProFilesList smart constructor.

Instances

Eq AccountUserProFilesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AccountUserProFiles.List Methods (==) :: AccountUserProFilesList -> AccountUserProFilesList -> Bool # (/=) :: AccountUserProFilesList -> AccountUserProFilesList -> Bool #
Data AccountUserProFilesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AccountUserProFiles.List 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 Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AccountUserProFiles.List Methods showsPrec :: Int -> AccountUserProFilesList -> ShowS # show :: AccountUserProFilesList -> String # showList :: [AccountUserProFilesList] -> ShowS #
Generic AccountUserProFilesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AccountUserProFiles.List Associated Types type Rep AccountUserProFilesList :: Type -> Type # Methods from :: AccountUserProFilesList -> Rep AccountUserProFilesList x # to :: Rep AccountUserProFilesList x -> AccountUserProFilesList #
GoogleRequest AccountUserProFilesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AccountUserProFiles.List Associated Types type Rs AccountUserProFilesList :: Type # type Scopes AccountUserProFilesList :: [Symbol] # Methods requestClient :: AccountUserProFilesList -> GClient (Rs AccountUserProFilesList) #
type Rep AccountUserProFilesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AccountUserProFiles.List type Rep AccountUserProFilesList = D1 (MetaData "AccountUserProFilesList" "Network.Google.Resource.DFAReporting.AccountUserProFiles.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "AccountUserProFilesList'" PrefixI True) (((S1 (MetaSel (Just "_aupflUserRoleId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :: S1 (MetaSel (Just "_aupflSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_aupflIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: (S1 (MetaSel (Just "_aupflProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :: S1 (MetaSel (Just "_aupflSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AccountUserProFilesListSortOrder)))) :: ((S1 (MetaSel (Just "_aupflActive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_aupflPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_aupflSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AccountUserProFilesListSortField) :: (S1 (MetaSel (Just "_aupflSubAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_aupflMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)))))))
type Scopes AccountUserProFilesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AccountUserProFiles.List type Scopes AccountUserProFilesList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs AccountUserProFilesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AccountUserProFiles.List type Rs AccountUserProFilesList = AccountUserProFilesListResponse

Request Lenses

aupflUserRoleId :: Lens' AccountUserProFilesList (Maybe Int64) Source #

Select only user profiles with the specified user role ID.

aupflSearchString :: Lens' AccountUserProFilesList (Maybe Text) Source #

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] Source #

Select only user profiles with these IDs.

aupflProFileId :: Lens' AccountUserProFilesList Int64 Source #

User profile ID associated with this request.

aupflSortOrder :: Lens' AccountUserProFilesList AccountUserProFilesListSortOrder Source #

Order of sorted results.

aupflActive :: Lens' AccountUserProFilesList (Maybe Bool) Source #

Select only active user profiles.

aupflPageToken :: Lens' AccountUserProFilesList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

aupflSortField :: Lens' AccountUserProFilesList AccountUserProFilesListSortField Source #

Field by which to sort the list.

aupflSubAccountId :: Lens' AccountUserProFilesList (Maybe Int64) Source #

Select only user profiles with the specified subaccount ID.

aupflMaxResults :: Lens' AccountUserProFilesList Int32 Source #

Maximum number of results to return.