Network.Google.Resource.DFAReporting.DirectorySites.List

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

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

REST Resource

type DirectorySitesListResource = "dfareporting" :> ("v2.7" :> ("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 "dfp_network_code" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] DirectorySitesListResponse))))))))))))))))))

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

Creating a Request

directorySitesList

Arguments

:: Int64

dslProFileId

-> DirectorySitesList

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

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

• dslSearchString
• dslAcceptsInterstitialPlacements
• dslAcceptsPublisherPaidPlacements
• dslIds
• dslProFileId
• dslSortOrder
• dslActive
• dslCountryId
• dslPageToken
• dslSortField
• dslAcceptsInStreamVideoPlacements
• dslMaxResults
• dslParentId
• dslDfpNetworkCode

data DirectorySitesList

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

See: directorySitesList smart constructor.

Instances

Eq DirectorySitesList

Methods

(==) :: DirectorySitesList -> DirectorySitesList -> Bool

(/=) :: DirectorySitesList -> DirectorySitesList -> Bool

Data DirectorySitesList

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

Methods

showsPrec :: Int -> DirectorySitesList -> ShowS

show :: DirectorySitesList -> String

showList :: [DirectorySitesList] -> ShowS

Generic DirectorySitesList

Associated Types

type Rep DirectorySitesList :: * -> *

Methods

from :: DirectorySitesList -> Rep DirectorySitesList x

to :: Rep DirectorySitesList x -> DirectorySitesList

GoogleRequest DirectorySitesList

Associated Types

type Rs DirectorySitesList :: *

type Scopes DirectorySitesList :: [Symbol]

Methods

requestClient :: DirectorySitesList -> Client (Rs DirectorySitesList)

type Rep DirectorySitesList

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

type Scopes DirectorySitesList

type Scopes DirectorySitesList = (:) Symbol "https://www.googleapis.com/auth/dfatrafficking" ([] Symbol)

type Rs DirectorySitesList

type Rs DirectorySitesList = DirectorySitesListResponse

Request Lenses

dslSearchString :: Lens' DirectorySitesList (Maybe Text)

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)

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

dslAcceptsPublisherPaidPlacements :: Lens' DirectorySitesList (Maybe Bool)

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

dslIds :: Lens' DirectorySitesList [Int64]

Select only directory sites with these IDs.

dslProFileId :: Lens' DirectorySitesList Int64

User profile ID associated with this request.

dslSortOrder :: Lens' DirectorySitesList (Maybe DirectorySitesListSortOrder)

Order of sorted results, default is ASCENDING.

dslActive :: Lens' DirectorySitesList (Maybe Bool)

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

dslCountryId :: Lens' DirectorySitesList (Maybe Int64)

Select only directory sites with this country ID.

dslPageToken :: Lens' DirectorySitesList (Maybe Text)

Value of the nextPageToken from the previous result page.

dslSortField :: Lens' DirectorySitesList (Maybe DirectorySitesListSortField)

Field by which to sort the list.

dslAcceptsInStreamVideoPlacements :: Lens' DirectorySitesList (Maybe Bool)

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

dslMaxResults :: Lens' DirectorySitesList (Maybe Int32)

Maximum number of results to return.

dslParentId :: Lens' DirectorySitesList (Maybe Int64)

Select only directory sites with this parent ID.

dslDfpNetworkCode :: Lens' DirectorySitesList (Maybe Text)

Select only directory sites with this DFP network code.