Copyright | (c) 2015 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 |
Retrieves a list of placements, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.placements.list
.
- type PlacementsListResource = "dfareporting" :> ("v2.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)))))))))))))))))))))))))))
- placementsList :: Int64 -> PlacementsList
- data PlacementsList
- pPlacementStrategyIds :: Lens' PlacementsList [Int64]
- pContentCategoryIds :: Lens' PlacementsList [Int64]
- pMaxEndDate :: Lens' PlacementsList (Maybe Text)
- pCampaignIds :: Lens' PlacementsList [Int64]
- pPricingTypes :: Lens' PlacementsList [PlacementsListPricingTypes]
- pSearchString :: Lens' PlacementsList (Maybe Text)
- pSizeIds :: Lens' PlacementsList [Int64]
- pIds :: Lens' PlacementsList [Int64]
- pProFileId :: Lens' PlacementsList Int64
- pGroupIds :: Lens' PlacementsList [Int64]
- pDirectorySiteIds :: Lens' PlacementsList [Int64]
- pSortOrder :: Lens' PlacementsList (Maybe PlacementsListSortOrder)
- pPaymentSource :: Lens' PlacementsList (Maybe PlacementsListPaymentSource)
- pSiteIds :: Lens' PlacementsList [Int64]
- pPageToken :: Lens' PlacementsList (Maybe Text)
- pSortField :: Lens' PlacementsList (Maybe PlacementsListSortField)
- pCompatibilities :: Lens' PlacementsList [PlacementsListCompatibilities]
- pMaxStartDate :: Lens' PlacementsList (Maybe Text)
- pAdvertiserIds :: Lens' PlacementsList [Int64]
- pMinStartDate :: Lens' PlacementsList (Maybe Text)
- pArchived :: Lens' PlacementsList (Maybe Bool)
- pMaxResults :: Lens' PlacementsList (Maybe Int32)
- pMinEndDate :: Lens' PlacementsList (Maybe Text)
REST Resource
type PlacementsListResource = "dfareporting" :> ("v2.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))))))))))))))))))))))))))) Source
A resource alias for dfareporting.placements.list
method which the
PlacementsList
request conforms to.
Creating a Request
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:
data PlacementsList Source
Retrieves a list of placements, possibly filtered.
See: placementsList
smart constructor.
Request Lenses
pPlacementStrategyIds :: Lens' PlacementsList [Int64] Source
Select only placements that are associated with these placement strategies.
pContentCategoryIds :: Lens' PlacementsList [Int64] Source
Select only placements that are associated with these content categories.
pMaxEndDate :: Lens' PlacementsList (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".
pCampaignIds :: Lens' PlacementsList [Int64] Source
Select only placements that belong to these campaigns.
pPricingTypes :: Lens' PlacementsList [PlacementsListPricingTypes] Source
Select only placements with these pricing types.
pSearchString :: Lens' PlacementsList (Maybe Text) Source
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] Source
Select only placements that are associated with these sizes.
pIds :: Lens' PlacementsList [Int64] Source
Select only placements with these IDs.
pProFileId :: Lens' PlacementsList Int64 Source
User profile ID associated with this request.
pGroupIds :: Lens' PlacementsList [Int64] Source
Select only placements that belong to these placement groups.
pDirectorySiteIds :: Lens' PlacementsList [Int64] Source
Select only placements that are associated with these directory sites.
pSortOrder :: Lens' PlacementsList (Maybe PlacementsListSortOrder) Source
Order of sorted results, default is ASCENDING.
pPaymentSource :: Lens' PlacementsList (Maybe PlacementsListPaymentSource) Source
Select only placements with this payment source.
pSiteIds :: Lens' PlacementsList [Int64] Source
Select only placements that are associated with these sites.
pPageToken :: Lens' PlacementsList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
pSortField :: Lens' PlacementsList (Maybe PlacementsListSortField) Source
Field by which to sort the list.
pCompatibilities :: Lens' PlacementsList [PlacementsListCompatibilities] Source
Select only placements that are associated with these compatibilities. WEB and WEB_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) 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".
pAdvertiserIds :: Lens' PlacementsList [Int64] Source
Select only placements that belong to these advertisers.
pMinStartDate :: Lens' PlacementsList (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".
pArchived :: Lens' PlacementsList (Maybe Bool) Source
Select only archived placements. Don't set this field to select both archived and non-archived placements.
pMaxResults :: Lens' PlacementsList (Maybe Int32) Source
Maximum number of results to return.
pMinEndDate :: Lens' PlacementsList (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".