Network.Google.Resource.DFAReporting.Placements.List

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

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

REST Resource

type PlacementsListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("placements" :> (QueryParams "placementStrategyIds" (Textual Int64) :> (QueryParams "contentCategoryIds" (Textual Int64) :> (QueryParam "maxEndDate" Text :> (QueryParams "campaignIds" (Textual Int64) :> (QueryParams "pricingTypes" PlacementsListPricingTypes :> (QueryParam "searchString" Text :> (QueryParams "sizeIds" (Textual Int64) :> (QueryParams "ids" (Textual Int64) :> (QueryParams "groupIds" (Textual Int64) :> (QueryParams "directorySiteIds" (Textual Int64) :> (QueryParam "sortOrder" PlacementsListSortOrder :> (QueryParam "paymentSource" PlacementsListPaymentSource :> (QueryParams "siteIds" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" PlacementsListSortField :> (QueryParams "compatibilities" PlacementsListCompatibilities :> (QueryParam "maxStartDate" Text :> (QueryParams "advertiserIds" (Textual Int64) :> (QueryParam "minStartDate" Text :> (QueryParam "archived" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "minEndDate" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] PlacementsListResponse)))))))))))))))))))))))))))

A resource alias for dfareporting.placements.list method which the PlacementsList request conforms to.

Creating a Request

placementsList

Arguments

:: Int64

pProFileId

-> PlacementsList

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

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

• pPlacementStrategyIds
• pContentCategoryIds
• pMaxEndDate
• pCampaignIds
• pPricingTypes
• pSearchString
• pSizeIds
• pIds
• pProFileId
• pGroupIds
• pDirectorySiteIds
• pSortOrder
• pPaymentSource
• pSiteIds
• pPageToken
• pSortField
• pCompatibilities
• pMaxStartDate
• pAdvertiserIds
• pMinStartDate
• pArchived
• pMaxResults
• pMinEndDate

data PlacementsList

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

See: placementsList smart constructor.

Instances

Eq PlacementsList

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

Methods

(==) :: PlacementsList -> PlacementsList -> Bool

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

Data PlacementsList

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

Methods

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

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

toConstr :: PlacementsList -> Constr

dataTypeOf :: PlacementsList -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> PlacementsList -> PlacementsList

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

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

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

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

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

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

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

Show PlacementsList

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

Methods

showsPrec :: Int -> PlacementsList -> ShowS

show :: PlacementsList -> String

showList :: [PlacementsList] -> ShowS

Generic PlacementsList

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

Associated Types

type Rep PlacementsList :: Type -> Type

Methods

from :: PlacementsList -> Rep PlacementsList x

to :: Rep PlacementsList x -> PlacementsList

GoogleRequest PlacementsList

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

Associated Types

type Rs PlacementsList :: Type

type Scopes PlacementsList :: [Symbol]

Methods

requestClient :: PlacementsList -> GClient (Rs PlacementsList)

type Rep PlacementsList

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

type Rep PlacementsList = D1 (MetaData "PlacementsList" "Network.Google.Resource.DFAReporting.Placements.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "PlacementsList'" PrefixI True) ((((S1 (MetaSel (Just "_pPlacementStrategyIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_pContentCategoryIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_pMaxEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pCampaignIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_pPricingTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PlacementsListPricingTypes]))))) :*: ((S1 (MetaSel (Just "_pSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pSizeIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_pIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) :*: (S1 (MetaSel (Just "_pProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: (S1 (MetaSel (Just "_pGroupIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_pDirectorySiteIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))))) :*: (((S1 (MetaSel (Just "_pSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PlacementsListSortOrder) :*: (S1 (MetaSel (Just "_pPaymentSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PlacementsListPaymentSource)) :*: S1 (MetaSel (Just "_pSiteIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))) :*: (S1 (MetaSel (Just "_pPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PlacementsListSortField) :*: S1 (MetaSel (Just "_pCompatibilities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PlacementsListCompatibilities]))))) :*: ((S1 (MetaSel (Just "_pMaxStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pAdvertiserIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_pMinStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 (MetaSel (Just "_pArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_pMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)) :*: S1 (MetaSel (Just "_pMinEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Scopes PlacementsList

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

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

type Rs PlacementsList

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

type Rs PlacementsList = PlacementsListResponse

Request Lenses

pPlacementStrategyIds :: Lens' PlacementsList [Int64]

Select only placements that are associated with these placement strategies.

pContentCategoryIds :: Lens' PlacementsList [Int64]

Select only placements that are associated with these content categories.

pMaxEndDate :: Lens' PlacementsList (Maybe Text)

Select only placements or placement groups whose end date is on or before the specified maxEndDate. The date should be formatted as "yyyy-MM-dd".

pCampaignIds :: Lens' PlacementsList [Int64]

Select only placements that belong to these campaigns.

pPricingTypes :: Lens' PlacementsList [PlacementsListPricingTypes]

Select only placements with these pricing types.

pSearchString :: Lens' PlacementsList (Maybe Text)

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

pSizeIds :: Lens' PlacementsList [Int64]

Select only placements that are associated with these sizes.

pIds :: Lens' PlacementsList [Int64]

Select only placements with these IDs.

pProFileId :: Lens' PlacementsList Int64

User profile ID associated with this request.

pGroupIds :: Lens' PlacementsList [Int64]

Select only placements that belong to these placement groups.

pDirectorySiteIds :: Lens' PlacementsList [Int64]

Select only placements that are associated with these directory sites.

pSortOrder :: Lens' PlacementsList PlacementsListSortOrder

Order of sorted results.

pPaymentSource :: Lens' PlacementsList (Maybe PlacementsListPaymentSource)

Select only placements with this payment source.

pSiteIds :: Lens' PlacementsList [Int64]

Select only placements that are associated with these sites.

pPageToken :: Lens' PlacementsList (Maybe Text)

Value of the nextPageToken from the previous result page.

pSortField :: Lens' PlacementsList PlacementsListSortField

Field by which to sort the list.

pCompatibilities :: Lens' PlacementsList [PlacementsListCompatibilities]

Select only placements that are associated with these compatibilities. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard.

pMaxStartDate :: Lens' PlacementsList (Maybe Text)

Select only placements or placement groups whose start date is on or before the specified maxStartDate. The date should be formatted as "yyyy-MM-dd".

pAdvertiserIds :: Lens' PlacementsList [Int64]

Select only placements that belong to these advertisers.

pMinStartDate :: Lens' PlacementsList (Maybe Text)

Select only placements or placement groups whose start date is on or after the specified minStartDate. The date should be formatted as "yyyy-MM-dd".

pArchived :: Lens' PlacementsList (Maybe Bool)

Select only archived placements. Don't set this field to select both archived and non-archived placements.

pMaxResults :: Lens' PlacementsList Int32

Maximum number of results to return.

pMinEndDate :: Lens' PlacementsList (Maybe Text)

Select only placements or placement groups whose end date is on or after the specified minEndDate. The date should be formatted as "yyyy-MM-dd".