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

Contents

REST Resource
Creating a Request
Request Lenses

Description

Retrieves a list of landing pages.

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

Synopsis

type AdvertiserLandingPagesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("advertiserLandingPages" :> (QueryParams "campaignIds" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AdvertiserLandingPagesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AdvertiserLandingPagesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "archived" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AdvertiserLandingPagesListResponse)))))))))))))))
advertiserLandingPagesList :: Int64 -> AdvertiserLandingPagesList
data AdvertiserLandingPagesList
alplCampaignIds :: Lens' AdvertiserLandingPagesList [Int64]
alplSearchString :: Lens' AdvertiserLandingPagesList (Maybe Text)
alplIds :: Lens' AdvertiserLandingPagesList [Int64]
alplProFileId :: Lens' AdvertiserLandingPagesList Int64
alplSortOrder :: Lens' AdvertiserLandingPagesList AdvertiserLandingPagesListSortOrder
alplPageToken :: Lens' AdvertiserLandingPagesList (Maybe Text)
alplSortField :: Lens' AdvertiserLandingPagesList AdvertiserLandingPagesListSortField
alplSubAccountId :: Lens' AdvertiserLandingPagesList (Maybe Int64)
alplAdvertiserIds :: Lens' AdvertiserLandingPagesList [Int64]
alplArchived :: Lens' AdvertiserLandingPagesList (Maybe Bool)
alplMaxResults :: Lens' AdvertiserLandingPagesList Int32

REST Resource

type AdvertiserLandingPagesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("advertiserLandingPages" :> (QueryParams "campaignIds" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" AdvertiserLandingPagesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AdvertiserLandingPagesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "archived" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AdvertiserLandingPagesListResponse))))))))))))))) Source #

A resource alias for dfareporting.advertiserLandingPages.list method which the AdvertiserLandingPagesList request conforms to.

Creating a Request

advertiserLandingPagesList Source #

Arguments

:: Int64	`alplProFileId`
-> AdvertiserLandingPagesList

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

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

data AdvertiserLandingPagesList Source #

Retrieves a list of landing pages.

See: advertiserLandingPagesList smart constructor.

Instances

Eq AdvertiserLandingPagesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AdvertiserLandingPages.List Methods (==) :: AdvertiserLandingPagesList -> AdvertiserLandingPagesList -> Bool # (/=) :: AdvertiserLandingPagesList -> AdvertiserLandingPagesList -> Bool #
Data AdvertiserLandingPagesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AdvertiserLandingPages.List Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AdvertiserLandingPagesList -> c AdvertiserLandingPagesList # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AdvertiserLandingPagesList # toConstr :: AdvertiserLandingPagesList -> Constr # dataTypeOf :: AdvertiserLandingPagesList -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c AdvertiserLandingPagesList) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AdvertiserLandingPagesList) # gmapT :: (forall b. Data b => b -> b) -> AdvertiserLandingPagesList -> AdvertiserLandingPagesList # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AdvertiserLandingPagesList -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AdvertiserLandingPagesList -> r # gmapQ :: (forall d. Data d => d -> u) -> AdvertiserLandingPagesList -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> AdvertiserLandingPagesList -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> AdvertiserLandingPagesList -> m AdvertiserLandingPagesList # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AdvertiserLandingPagesList -> m AdvertiserLandingPagesList # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AdvertiserLandingPagesList -> m AdvertiserLandingPagesList #
Show AdvertiserLandingPagesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AdvertiserLandingPages.List Methods showsPrec :: Int -> AdvertiserLandingPagesList -> ShowS # show :: AdvertiserLandingPagesList -> String # showList :: [AdvertiserLandingPagesList] -> ShowS #
Generic AdvertiserLandingPagesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AdvertiserLandingPages.List Associated Types type Rep AdvertiserLandingPagesList :: Type -> Type # Methods from :: AdvertiserLandingPagesList -> Rep AdvertiserLandingPagesList x # to :: Rep AdvertiserLandingPagesList x -> AdvertiserLandingPagesList #
GoogleRequest AdvertiserLandingPagesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AdvertiserLandingPages.List Associated Types type Rs AdvertiserLandingPagesList :: Type # type Scopes AdvertiserLandingPagesList :: [Symbol] # Methods requestClient :: AdvertiserLandingPagesList -> GClient (Rs AdvertiserLandingPagesList) #
type Rep AdvertiserLandingPagesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AdvertiserLandingPages.List type Rep AdvertiserLandingPagesList = D1 (MetaData "AdvertiserLandingPagesList" "Network.Google.Resource.DFAReporting.AdvertiserLandingPages.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "AdvertiserLandingPagesList'" PrefixI True) (((S1 (MetaSel (Just "_alplCampaignIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: S1 (MetaSel (Just "_alplSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_alplIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: (S1 (MetaSel (Just "_alplProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :: S1 (MetaSel (Just "_alplSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AdvertiserLandingPagesListSortOrder)))) :: ((S1 (MetaSel (Just "_alplPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_alplSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AdvertiserLandingPagesListSortField) :: S1 (MetaSel (Just "_alplSubAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))))) :: (S1 (MetaSel (Just "_alplAdvertiserIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :: (S1 (MetaSel (Just "_alplArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_alplMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)))))))
type Scopes AdvertiserLandingPagesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AdvertiserLandingPages.List type Scopes AdvertiserLandingPagesList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs AdvertiserLandingPagesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.AdvertiserLandingPages.List type Rs AdvertiserLandingPagesList = AdvertiserLandingPagesListResponse

Request Lenses

alplCampaignIds :: Lens' AdvertiserLandingPagesList [Int64] Source #

Select only landing pages that are associated with these campaigns.

alplSearchString :: Lens' AdvertiserLandingPagesList (Maybe Text) Source #

Allows searching for landing pages by name or ID. Wildcards (*) are allowed. For example, "landingpage*2017" will return landing pages with names like "landingpage July 2017", "landingpage March 2017", or simply "landingpage 2017". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "landingpage" will match campaigns with name "my landingpage", "landingpage 2015", or simply "landingpage".

alplIds :: Lens' AdvertiserLandingPagesList [Int64] Source #

Select only landing pages with these IDs.

alplProFileId :: Lens' AdvertiserLandingPagesList Int64 Source #

User profile ID associated with this request.

alplSortOrder :: Lens' AdvertiserLandingPagesList AdvertiserLandingPagesListSortOrder Source #

Order of sorted results.

alplPageToken :: Lens' AdvertiserLandingPagesList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

alplSortField :: Lens' AdvertiserLandingPagesList AdvertiserLandingPagesListSortField Source #

Field by which to sort the list.

alplSubAccountId :: Lens' AdvertiserLandingPagesList (Maybe Int64) Source #

Select only landing pages that belong to this subaccount.