Network.Google.Resource.DFAReporting.SubAccounts.List

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

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

REST Resource

type SubAccountsListResource = "dfareporting" :> ("v3.3" :> ("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

Arguments

:: Int64

salProFileId

-> 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:

• salSearchString
• salIds
• salProFileId
• salSortOrder
• salPageToken
• salSortField
• salMaxResults

data SubAccountsList

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

See: subAccountsList smart constructor.

Instances

Eq SubAccountsList

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

Methods

(==) :: SubAccountsList -> SubAccountsList -> Bool

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

Data SubAccountsList

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

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

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

Methods

showsPrec :: Int -> SubAccountsList -> ShowS

show :: SubAccountsList -> String

showList :: [SubAccountsList] -> ShowS

Generic SubAccountsList

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

Associated Types

type Rep SubAccountsList :: Type -> Type

Methods

from :: SubAccountsList -> Rep SubAccountsList x

to :: Rep SubAccountsList x -> SubAccountsList

GoogleRequest SubAccountsList

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

Associated Types

type Rs SubAccountsList :: Type

type Scopes SubAccountsList :: [Symbol]

Methods

requestClient :: SubAccountsList -> GClient (Rs SubAccountsList)

type Rep SubAccountsList

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

type Rep SubAccountsList = D1 (MetaData "SubAccountsList" "Network.Google.Resource.DFAReporting.SubAccounts.List" "gogol-dfareporting-0.5.0-H2nEimqYPoYBpPsdI4WnkF" False) (C1 (MetaCons "SubAccountsList'" PrefixI True) ((S1 (MetaSel (Just "_salSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_salIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_salProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)))) :*: ((S1 (MetaSel (Just "_salSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SubAccountsListSortOrder) :*: S1 (MetaSel (Just "_salPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_salSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SubAccountsListSortField) :*: S1 (MetaSel (Just "_salMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))))))

type Scopes SubAccountsList

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

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

type Rs SubAccountsList

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

type Rs SubAccountsList = SubAccountsListResponse

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 SubAccountsListSortOrder

Order of sorted results.

salPageToken :: Lens' SubAccountsList (Maybe Text)

Value of the nextPageToken from the previous result page.

salSortField :: Lens' SubAccountsList SubAccountsListSortField

Field by which to sort the list.

salMaxResults :: Lens' SubAccountsList Int32

Maximum number of results to return.