gogol-dfareporting-0.3.0: Google DCM/DFA Reporting And Trafficking SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.DFAReporting.Sites.List

Contents

Description

Retrieves a list of sites, possibly filtered. This method supports paging.

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

Synopsis

REST Resource

type SitesListResource = "dfareporting" :> ("v2.7" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("sites" :> (QueryParam "unmappedSite" Bool :> (QueryParams "campaignIds" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParam "acceptsInterstitialPlacements" Bool :> (QueryParam "acceptsPublisherPaidPlacements" Bool :> (QueryParams "ids" (Textual Int64) :> (QueryParams "directorySiteIds" (Textual Int64) :> (QueryParam "sortOrder" SitesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" SitesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParam "acceptsInStreamVideoPlacements" Bool :> (QueryParam "approved" Bool :> (QueryParam "adWordsSite" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] SitesListResponse)))))))))))))))))))) Source #

A resource alias for dfareporting.sites.list method which the SitesList request conforms to.

Creating a Request

data SitesList Source #

Retrieves a list of sites, possibly filtered. This method supports paging.

See: sitesList smart constructor.

Instances

Eq SitesList Source # 
Data SitesList Source # 

Methods

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

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

toConstr :: SitesList -> Constr #

dataTypeOf :: SitesList -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SitesList) #

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

gmapT :: (forall b. Data b => b -> b) -> SitesList -> SitesList #

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

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

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

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

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

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

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

Show SitesList Source # 
Generic SitesList Source # 

Associated Types

type Rep SitesList :: * -> * #

GoogleRequest SitesList Source # 

Associated Types

type Rs SitesList :: * #

type Scopes SitesList :: [Symbol] #

type Rep SitesList Source # 
type Rep SitesList = D1 (MetaData "SitesList" "Network.Google.Resource.DFAReporting.Sites.List" "gogol-dfareporting-0.3.0-1Sz7MzcQaqT30NKUHnKpNh" False) (C1 (MetaCons "SitesList'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sitUnmAppedSite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_sitCampaignIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) ((:*:) (S1 (MetaSel (Just Symbol "_sitSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sitAcceptsInterstitialPlacements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sitAcceptsPublisherPaidPlacements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_sitIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) ((:*:) (S1 (MetaSel (Just Symbol "_sitProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))) (S1 (MetaSel (Just Symbol "_sitDirectorySiteIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sitSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SitesListSortOrder))) (S1 (MetaSel (Just Symbol "_sitPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_sitSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SitesListSortField))) (S1 (MetaSel (Just Symbol "_sitSubAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sitAcceptsInStreamVideoPlacements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_sitApproved") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_sitAdWordsSite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_sitMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))))))
type Scopes SitesList Source # 
type Scopes SitesList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)
type Rs SitesList Source # 

Request Lenses

sitUnmAppedSite :: Lens' SitesList (Maybe Bool) Source #

Select only sites that have not been mapped to a directory site.

sitCampaignIds :: Lens' SitesList [Int64] Source #

Select only sites with these campaign IDs.

sitSearchString :: Lens' SitesList (Maybe Text) Source #

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

sitAcceptsInterstitialPlacements :: Lens' SitesList (Maybe Bool) Source #

This search filter is no longer supported and will have no effect on the results returned.

sitAcceptsPublisherPaidPlacements :: Lens' SitesList (Maybe Bool) Source #

Select only sites that accept publisher paid placements.

sitIds :: Lens' SitesList [Int64] Source #

Select only sites with these IDs.

sitProFileId :: Lens' SitesList Int64 Source #

User profile ID associated with this request.

sitDirectorySiteIds :: Lens' SitesList [Int64] Source #

Select only sites with these directory site IDs.

sitSortOrder :: Lens' SitesList (Maybe SitesListSortOrder) Source #

Order of sorted results, default is ASCENDING.

sitPageToken :: Lens' SitesList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

sitSortField :: Lens' SitesList (Maybe SitesListSortField) Source #

Field by which to sort the list.

sitSubAccountId :: Lens' SitesList (Maybe Int64) Source #

Select only sites with this subaccount ID.

sitAcceptsInStreamVideoPlacements :: Lens' SitesList (Maybe Bool) Source #

This search filter is no longer supported and will have no effect on the results returned.

sitApproved :: Lens' SitesList (Maybe Bool) Source #

Select only approved sites.

sitAdWordsSite :: Lens' SitesList (Maybe Bool) Source #

Select only AdWords sites.

sitMaxResults :: Lens' SitesList (Maybe Int32) Source #

Maximum number of results to return.