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

Contents

REST Resource
Creating a Request
Request Lenses

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

type SitesListResource = "dfareporting" :> ("v3.2" :> ("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))))))))))))))))))))
sitesList :: Int64 -> SitesList
data SitesList
sitUnmAppedSite :: Lens' SitesList (Maybe Bool)
sitCampaignIds :: Lens' SitesList [Int64]
sitSearchString :: Lens' SitesList (Maybe Text)
sitAcceptsInterstitialPlacements :: Lens' SitesList (Maybe Bool)
sitAcceptsPublisherPaidPlacements :: Lens' SitesList (Maybe Bool)
sitIds :: Lens' SitesList [Int64]
sitProFileId :: Lens' SitesList Int64
sitDirectorySiteIds :: Lens' SitesList [Int64]
sitSortOrder :: Lens' SitesList SitesListSortOrder
sitPageToken :: Lens' SitesList (Maybe Text)
sitSortField :: Lens' SitesList SitesListSortField
sitSubAccountId :: Lens' SitesList (Maybe Int64)
sitAcceptsInStreamVideoPlacements :: Lens' SitesList (Maybe Bool)
sitApproved :: Lens' SitesList (Maybe Bool)
sitAdWordsSite :: Lens' SitesList (Maybe Bool)
sitMaxResults :: Lens' SitesList Int32

REST Resource

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

sitesList Source #

Arguments

:: Int64	`sitProFileId`
-> SitesList

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

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

data SitesList Source #

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

See: sitesList smart constructor.

Instances

Eq SitesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Sites.List Methods (==) :: SitesList -> SitesList -> Bool # (/=) :: SitesList -> SitesList -> Bool #
Data SitesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Sites.List 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 #
Instance details Defined in Network.Google.Resource.DFAReporting.Sites.List Methods showsPrec :: Int -> SitesList -> ShowS # show :: SitesList -> String # showList :: [SitesList] -> ShowS #
Generic SitesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Sites.List Associated Types type Rep SitesList :: Type -> Type # Methods from :: SitesList -> Rep SitesList x # to :: Rep SitesList x -> SitesList #
GoogleRequest SitesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Sites.List Associated Types type Rs SitesList :: Type # type Scopes SitesList :: [Symbol] # Methods requestClient :: SitesList -> GClient (Rs SitesList) #
type Rep SitesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Sites.List type Rep SitesList = D1 (MetaData "SitesList" "Network.Google.Resource.DFAReporting.Sites.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "SitesList'" PrefixI True) ((((S1 (MetaSel (Just "_sitUnmAppedSite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_sitCampaignIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :: (S1 (MetaSel (Just "_sitSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_sitAcceptsInterstitialPlacements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 (MetaSel (Just "_sitAcceptsPublisherPaidPlacements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_sitIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :: (S1 (MetaSel (Just "_sitProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :: S1 (MetaSel (Just "_sitDirectorySiteIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))))) :: (((S1 (MetaSel (Just "_sitSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SitesListSortOrder) :: S1 (MetaSel (Just "_sitPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_sitSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SitesListSortField) :: S1 (MetaSel (Just "_sitSubAccountId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))))) :: ((S1 (MetaSel (Just "_sitAcceptsInStreamVideoPlacements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :: S1 (MetaSel (Just "_sitApproved") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 (MetaSel (Just "_sitAdWordsSite") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_sitMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)))))))
type Scopes SitesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Sites.List type Scopes SitesList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs SitesList Source #
Instance details Defined in Network.Google.Resource.DFAReporting.Sites.List type Rs SitesList = SitesListResponse

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 SitesListSortOrder Source #

Order of sorted results.