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

Contents

Description

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

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

Synopsis

REST Resource

type PlacementGroupsListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("placementGroups" :> (QueryParams "placementStrategyIds" (Textual Int64) :> (QueryParams "contentCategoryIds" (Textual Int64) :> (QueryParam "maxEndDate" Text :> (QueryParams "campaignIds" (Textual Int64) :> (QueryParams "pricingTypes" PlacementGroupsListPricingTypes :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "placementGroupType" PlacementGroupsListPlacementGroupType :> (QueryParams "directorySiteIds" (Textual Int64) :> (QueryParam "sortOrder" PlacementGroupsListSortOrder :> (QueryParams "siteIds" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" PlacementGroupsListSortField :> (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] PlacementGroupsListResponse)))))))))))))))))))))))) Source #

A resource alias for dfareporting.placementGroups.list method which the PlacementGroupsList request conforms to.

Creating a Request

data PlacementGroupsList Source #

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

See: placementGroupsList smart constructor.

Instances
Eq PlacementGroupsList Source # 
Instance details

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

Data PlacementGroupsList Source # 
Instance details

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

Methods

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

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

toConstr :: PlacementGroupsList -> Constr #

dataTypeOf :: PlacementGroupsList -> DataType #

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

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

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

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

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

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

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

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

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

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

Show PlacementGroupsList Source # 
Instance details

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

Generic PlacementGroupsList Source # 
Instance details

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

Associated Types

type Rep PlacementGroupsList :: Type -> Type #

GoogleRequest PlacementGroupsList Source # 
Instance details

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

Associated Types

type Rs PlacementGroupsList :: Type #

type Scopes PlacementGroupsList :: [Symbol] #

type Rep PlacementGroupsList Source # 
Instance details

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

type Rep PlacementGroupsList = D1 (MetaData "PlacementGroupsList" "Network.Google.Resource.DFAReporting.PlacementGroups.List" "gogol-dfareporting-0.4.0-9N9I1R95b3Y5YmOKldvlKw" False) (C1 (MetaCons "PlacementGroupsList'" PrefixI True) ((((S1 (MetaSel (Just "_pglPlacementStrategyIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_pglContentCategoryIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_pglMaxEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pglCampaignIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_pglPricingTypes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PlacementGroupsListPricingTypes]))))) :*: ((S1 (MetaSel (Just "_pglSearchString") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pglIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_pglProFileId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int64)) :*: (S1 (MetaSel (Just "_pglPlacementGroupType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PlacementGroupsListPlacementGroupType)) :*: S1 (MetaSel (Just "_pglDirectorySiteIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])))))) :*: (((S1 (MetaSel (Just "_pglSortOrder") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PlacementGroupsListSortOrder) :*: S1 (MetaSel (Just "_pglSiteIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64]))) :*: (S1 (MetaSel (Just "_pglPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pglSortField") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PlacementGroupsListSortField) :*: S1 (MetaSel (Just "_pglMaxStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_pglAdvertiserIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Textual Int64])) :*: S1 (MetaSel (Just "_pglMinStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pglArchived") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_pglMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Textual Int32)) :*: S1 (MetaSel (Just "_pglMinEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))
type Scopes PlacementGroupsList Source # 
Instance details

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

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

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

Request Lenses

pglPlacementStrategyIds :: Lens' PlacementGroupsList [Int64] Source #

Select only placement groups that are associated with these placement strategies.

pglContentCategoryIds :: Lens' PlacementGroupsList [Int64] Source #

Select only placement groups that are associated with these content categories.

pglMaxEndDate :: Lens' PlacementGroupsList (Maybe Text) Source #

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".

pglCampaignIds :: Lens' PlacementGroupsList [Int64] Source #

Select only placement groups that belong to these campaigns.

pglPricingTypes :: Lens' PlacementGroupsList [PlacementGroupsListPricingTypes] Source #

Select only placement groups with these pricing types.

pglSearchString :: Lens' PlacementGroupsList (Maybe Text) Source #

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

pglIds :: Lens' PlacementGroupsList [Int64] Source #

Select only placement groups with these IDs.

pglProFileId :: Lens' PlacementGroupsList Int64 Source #

User profile ID associated with this request.

pglPlacementGroupType :: Lens' PlacementGroupsList (Maybe PlacementGroupsListPlacementGroupType) Source #

Select only placement groups belonging with this group type. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting.

pglDirectorySiteIds :: Lens' PlacementGroupsList [Int64] Source #

Select only placement groups that are associated with these directory sites.

pglSiteIds :: Lens' PlacementGroupsList [Int64] Source #

Select only placement groups that are associated with these sites.

pglPageToken :: Lens' PlacementGroupsList (Maybe Text) Source #

Value of the nextPageToken from the previous result page.

pglMaxStartDate :: Lens' PlacementGroupsList (Maybe Text) Source #

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".

pglAdvertiserIds :: Lens' PlacementGroupsList [Int64] Source #

Select only placement groups that belong to these advertisers.

pglMinStartDate :: Lens' PlacementGroupsList (Maybe Text) Source #

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".

pglArchived :: Lens' PlacementGroupsList (Maybe Bool) Source #

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

pglMaxResults :: Lens' PlacementGroupsList Int32 Source #

Maximum number of results to return.

pglMinEndDate :: Lens' PlacementGroupsList (Maybe Text) Source #

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".