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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Retrieves a list of targeting templates, optionally filtered. This method supports paging.

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

Synopsis

type TargetingTemplatesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("targetingTemplates" :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" TargetingTemplatesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" TargetingTemplatesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] TargetingTemplatesListResponse))))))))))))
targetingTemplatesList :: Int64 -> TargetingTemplatesList
data TargetingTemplatesList
ttlAdvertiserId :: Lens' TargetingTemplatesList (Maybe Int64)
ttlSearchString :: Lens' TargetingTemplatesList (Maybe Text)
ttlIds :: Lens' TargetingTemplatesList [Int64]
ttlProFileId :: Lens' TargetingTemplatesList Int64
ttlSortOrder :: Lens' TargetingTemplatesList TargetingTemplatesListSortOrder
ttlPageToken :: Lens' TargetingTemplatesList (Maybe Text)
ttlSortField :: Lens' TargetingTemplatesList TargetingTemplatesListSortField
ttlMaxResults :: Lens' TargetingTemplatesList Int32

REST Resource

type TargetingTemplatesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("targetingTemplates" :> (QueryParam "advertiserId" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" TargetingTemplatesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" TargetingTemplatesListSortField :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] TargetingTemplatesListResponse)))))))))))) Source #

A resource alias for dfareporting.targetingTemplates.list method which the TargetingTemplatesList request conforms to.

Creating a Request

targetingTemplatesList Source #

Arguments

:: Int64	`ttlProFileId`
-> TargetingTemplatesList

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

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

data TargetingTemplatesList Source #

Retrieves a list of targeting templates, optionally filtered. This method supports paging.

See: targetingTemplatesList smart constructor.

Instances

Eq TargetingTemplatesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.TargetingTemplates.List Methods (==) :: TargetingTemplatesList -> TargetingTemplatesList -> Bool # (/=) :: TargetingTemplatesList -> TargetingTemplatesList -> Bool #
Data TargetingTemplatesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.TargetingTemplates.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TargetingTemplatesList -> c TargetingTemplatesList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TargetingTemplatesList # toConstr :: TargetingTemplatesList -> Constr # dataTypeOf :: TargetingTemplatesList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TargetingTemplatesList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TargetingTemplatesList) # gmapT :: (forall b. Data b => b -> b) -> TargetingTemplatesList -> TargetingTemplatesList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TargetingTemplatesList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TargetingTemplatesList -> r # gmapQ :: (forall d. Data d => d -> u) -> TargetingTemplatesList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> TargetingTemplatesList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> TargetingTemplatesList -> m TargetingTemplatesList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TargetingTemplatesList -> m TargetingTemplatesList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TargetingTemplatesList -> m TargetingTemplatesList #
Show TargetingTemplatesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.TargetingTemplates.List Methods showsPrec :: Int -> TargetingTemplatesList -> ShowS # show :: TargetingTemplatesList -> String # showList :: [TargetingTemplatesList] -> ShowS #
Generic TargetingTemplatesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.TargetingTemplates.List Associated Types type Rep TargetingTemplatesList :: Type -> Type # Methods from :: TargetingTemplatesList -> Rep TargetingTemplatesList x # to :: Rep TargetingTemplatesList x -> TargetingTemplatesList #
GoogleRequest TargetingTemplatesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.TargetingTemplates.List Associated Types type Rs TargetingTemplatesList :: Type # type Scopes TargetingTemplatesList :: [Symbol] # Methods requestClient :: TargetingTemplatesList -> GClient (Rs TargetingTemplatesList) #
type Rep TargetingTemplatesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.TargetingTemplates.List type Rep TargetingTemplatesList = D1 (MetaData "TargetingTemplatesList" "Network.Google.Resource.DFAReporting.TargetingTemplates.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "TargetingTemplatesList'" PrefixI True) (((S1 (MetaSel (Just "_ttlAdvertiserId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :: S1 (MetaSel (Just "_ttlSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ttlIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: S1 (MetaSel (Just "_ttlProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)))) :: ((S1 (MetaSel (Just "_ttlSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TargetingTemplatesListSortOrder) :: S1 (MetaSel (Just "_ttlPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_ttlSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TargetingTemplatesListSortField) :*: S1 (MetaSel (Just "_ttlMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))))))
type Scopes TargetingTemplatesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.TargetingTemplates.List type Scopes TargetingTemplatesList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs TargetingTemplatesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.TargetingTemplates.List type Rs TargetingTemplatesList = TargetingTemplatesListResponse

Request Lenses

ttlAdvertiserId :: Lens' TargetingTemplatesList (Maybe Int64) Source #

Select only targeting templates with this advertiser ID.

ttlSearchString :: Lens' TargetingTemplatesList (Maybe Text) Source #

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

ttlIds :: Lens' TargetingTemplatesList [Int64] Source #

Select only targeting templates with these IDs.

ttlProFileId :: Lens' TargetingTemplatesList Int64 Source #

User profile ID associated with this request.

ttlSortOrder :: Lens' TargetingTemplatesList TargetingTemplatesListSortOrder Source #

Order of sorted results.

ttlPageToken :: Lens' TargetingTemplatesList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

ttlSortField :: Lens' TargetingTemplatesList TargetingTemplatesListSortField Source #

Field by which to sort the list.

ttlMaxResults :: Lens' TargetingTemplatesList Int32 Source #

Maximum number of results to return.