Network.Google.Resource.DFAReporting.Accounts.List

Retrieves the list of accounts, possibly filtered. This method supports paging.

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

REST Resource

type AccountsListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("accounts" :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AccountsListSortOrder :> (QueryParam "active" Bool :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AccountsListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AccountsListResponse))))))))))))

A resource alias for dfareporting.accounts.list method which the AccountsList request conforms to.

Creating a Request

accountsList

Arguments

:: Int64

accProFileId

-> AccountsList

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

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

• accSearchString
• accIds
• accProFileId
• accSortOrder
• accActive
• accPageToken
• accSortField
• accMaxResults

data AccountsList

Retrieves the list of accounts, possibly filtered. This method supports paging.

See: accountsList smart constructor.

Instances

Eq AccountsList

Defined in Network.Google.Resource.DFAReporting.Accounts.List

Methods

(==) :: AccountsList -> AccountsList -> Bool

(/=) :: AccountsList -> AccountsList -> Bool

Data AccountsList

Defined in Network.Google.Resource.DFAReporting.Accounts.List

Methods

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

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

toConstr :: AccountsList -> Constr

dataTypeOf :: AccountsList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AccountsList)

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

gmapT :: (forall b. Data b => b -> b) -> AccountsList -> AccountsList

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

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

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

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

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

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

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

Show AccountsList

Defined in Network.Google.Resource.DFAReporting.Accounts.List

Methods

showsPrec :: Int -> AccountsList -> ShowS

show :: AccountsList -> String

showList :: [AccountsList] -> ShowS

Generic AccountsList

Defined in Network.Google.Resource.DFAReporting.Accounts.List

Associated Types

type Rep AccountsList :: Type -> Type

Methods

from :: AccountsList -> Rep AccountsList x

to :: Rep AccountsList x -> AccountsList

GoogleRequest AccountsList

Defined in Network.Google.Resource.DFAReporting.Accounts.List

Associated Types

type Rs AccountsList :: Type

type Scopes AccountsList :: [Symbol]

Methods

requestClient :: AccountsList -> GClient (Rs AccountsList)

type Rep AccountsList

Defined in Network.Google.Resource.DFAReporting.Accounts.List

type Rep AccountsList = D1 (MetaData "AccountsList" "Network.Google.Resource.DFAReporting.Accounts.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "AccountsList'" PrefixI True) (((S1 (MetaSel (Just "_accSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_accIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_accProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: S1 (MetaSel (Just "_accSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AccountsListSortOrder))) :*: ((S1 (MetaSel (Just "_accActive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_accPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_accSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AccountsListSortField) :*: S1 (MetaSel (Just "_accMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))))))

type Scopes AccountsList

Defined in Network.Google.Resource.DFAReporting.Accounts.List

type Scopes AccountsList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])

type Rs AccountsList

Defined in Network.Google.Resource.DFAReporting.Accounts.List

type Rs AccountsList = AccountsListResponse

Request Lenses

accSearchString :: Lens' AccountsList (Maybe Text)

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

accIds :: Lens' AccountsList [Int64]

Select only accounts with these IDs.

accProFileId :: Lens' AccountsList Int64

User profile ID associated with this request.

accSortOrder :: Lens' AccountsList AccountsListSortOrder

Order of sorted results.

accActive :: Lens' AccountsList (Maybe Bool)

Select only active accounts. Don't set this field to select both active and non-active accounts.

accPageToken :: Lens' AccountsList (Maybe Text)

Value of the nextPageToken from the previous result page.

accSortField :: Lens' AccountsList AccountsListSortField

Field by which to sort the list.

accMaxResults :: Lens' AccountsList Int32

Maximum number of results to return.