gogol-dfareporting-0.4.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.DirectorySites.List

Contents

Description

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

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

Synopsis

REST Resource

type DirectorySitesListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("directorySites" :> (QueryParam "searchString" Text :> (QueryParam "acceptsInterstitialPlacements" Bool :> (QueryParam "acceptsPublisherPaidPlacements" Bool :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" DirectorySitesListSortOrder :> (QueryParam "active" Bool :> (QueryParam "countryId" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" DirectorySitesListSortField :> (QueryParam "acceptsInStreamVideoPlacements" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "parentId" (Textual Int64) :> (QueryParam "dfpNetworkCode" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] DirectorySitesListResponse)))))))))))))))))) Source #

A resource alias for dfareporting.directorySites.list method which the DirectorySitesList request conforms to.

Creating a Request

data DirectorySitesList Source #

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

See: directorySitesList smart constructor.

Instances
Eq DirectorySitesList Source # 
Instance details

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

Data DirectorySitesList Source # 
Instance details

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

Methods

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

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

toConstr :: DirectorySitesList -> Constr #

dataTypeOf :: DirectorySitesList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show DirectorySitesList Source # 
Instance details

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

Generic DirectorySitesList Source # 
Instance details

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

Associated Types

type Rep DirectorySitesList :: Type -> Type #

GoogleRequest DirectorySitesList Source # 
Instance details

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

Associated Types

type Rs DirectorySitesList :: Type #

type Scopes DirectorySitesList :: [Symbol] #

type Rep DirectorySitesList Source # 
Instance details

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

type Rep DirectorySitesList = D1 (MetaData "DirectorySitesList" "Network.Google.Resource.DFAReporting.DirectorySites.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "DirectorySitesList'" PrefixI True) (((S1 (MetaSel (Just "_dslSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_dslAcceptsInterstitialPlacements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_dslAcceptsPublisherPaidPlacements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 (MetaSel (Just "_dslIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_dslProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64))) :*: (S1 (MetaSel (Just "_dslSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DirectorySitesListSortOrder) :*: S1 (MetaSel (Just "_dslActive") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 (MetaSel (Just "_dslCountryId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: (S1 (MetaSel (Just "_dslPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dslSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DirectorySitesListSortField))) :*: ((S1 (MetaSel (Just "_dslAcceptsInStreamVideoPlacements") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_dslMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32))) :*: (S1 (MetaSel (Just "_dslParentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_dslDfpNetworkCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))
type Scopes DirectorySitesList Source # 
Instance details

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

type Scopes DirectorySitesList = "https://www.googleapis.com/auth/dfatrafficking" ': ([] :: [Symbol])
type Rs DirectorySitesList Source # 
Instance details

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

Request Lenses

dslSearchString :: Lens' DirectorySitesList (Maybe Text) Source #

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

dslAcceptsInterstitialPlacements :: Lens' DirectorySitesList (Maybe Bool) Source #

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

dslAcceptsPublisherPaidPlacements :: Lens' DirectorySitesList (Maybe Bool) Source #

Select only directory sites that accept publisher paid placements. This field can be left blank.

dslIds :: Lens' DirectorySitesList [Int64] Source #

Select only directory sites with these IDs.

dslProFileId :: Lens' DirectorySitesList Int64 Source #

User profile ID associated with this request.

dslActive :: Lens' DirectorySitesList (Maybe Bool) Source #

Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.

dslCountryId :: Lens' DirectorySitesList (Maybe Int64) Source #

Select only directory sites with this country ID.

dslPageToken :: Lens' DirectorySitesList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

dslAcceptsInStreamVideoPlacements :: Lens' DirectorySitesList (Maybe Bool) Source #

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

dslMaxResults :: Lens' DirectorySitesList Int32 Source #

Maximum number of results to return.

dslParentId :: Lens' DirectorySitesList (Maybe Int64) Source #

Select only directory sites with this parent ID.

dslDfpNetworkCode :: Lens' DirectorySitesList (Maybe Text) Source #

Select only directory sites with this Ad Manager network code.