gogol-dfareporting-0.0.1: Google DCM/DFA Reporting And Trafficking SDK.

Copyright(c) 2015 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.

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

Synopsis

REST Resource

type PlacementGroupsListResource = "dfareporting" :> ("v2.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

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.

pglSortOrder :: Lens' PlacementGroupsList (Maybe PlacementGroupsListSortOrder) Source

Order of sorted results, default is ASCENDING.

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