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 sites, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.sites.list
.
- type SitesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("sites" :> (QueryParam "unmappedSite" Bool :> (QueryParams "campaignIds" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParam "acceptsInterstitialPlacements" Bool :> (QueryParam "acceptsPublisherPaidPlacements" Bool :> (QueryParams "ids" (Textual Int64) :> (QueryParams "directorySiteIds" (Textual Int64) :> (QueryParam "sortOrder" SitesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" SitesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParam "acceptsInStreamVideoPlacements" Bool :> (QueryParam "approved" Bool :> (QueryParam "adWordsSite" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` SitesListResponse))))))))))))))))))))
- sitesList :: Int64 -> SitesList
- data SitesList
- sitUnmAppedSite :: Lens' SitesList (Maybe Bool)
- sitCampaignIds :: Lens' SitesList [Int64]
- sitSearchString :: Lens' SitesList (Maybe Text)
- sitAcceptsInterstitialPlacements :: Lens' SitesList (Maybe Bool)
- sitAcceptsPublisherPaidPlacements :: Lens' SitesList (Maybe Bool)
- sitIds :: Lens' SitesList [Int64]
- sitProFileId :: Lens' SitesList Int64
- sitDirectorySiteIds :: Lens' SitesList [Int64]
- sitSortOrder :: Lens' SitesList (Maybe SitesListSortOrder)
- sitPageToken :: Lens' SitesList (Maybe Text)
- sitSortField :: Lens' SitesList (Maybe SitesListSortField)
- sitSubAccountId :: Lens' SitesList (Maybe Int64)
- sitAcceptsInStreamVideoPlacements :: Lens' SitesList (Maybe Bool)
- sitApproved :: Lens' SitesList (Maybe Bool)
- sitAdWordsSite :: Lens' SitesList (Maybe Bool)
- sitMaxResults :: Lens' SitesList (Maybe Int32)
REST Resource
type SitesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("sites" :> (QueryParam "unmappedSite" Bool :> (QueryParams "campaignIds" (Textual Int64) :> (QueryParam "searchString" Text :> (QueryParam "acceptsInterstitialPlacements" Bool :> (QueryParam "acceptsPublisherPaidPlacements" Bool :> (QueryParams "ids" (Textual Int64) :> (QueryParams "directorySiteIds" (Textual Int64) :> (QueryParam "sortOrder" SitesListSortOrder :> (QueryParam "pageToken" Text :> (QueryParam "sortField" SitesListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParam "acceptsInStreamVideoPlacements" Bool :> (QueryParam "approved" Bool :> (QueryParam "adWordsSite" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` SitesListResponse)))))))))))))))))))) Source
A resource alias for dfareporting.sites.list
method which the
SitesList
request conforms to.
Creating a Request
Creates a value of SitesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Retrieves a list of sites, possibly filtered.
See: sitesList
smart constructor.
Request Lenses
sitUnmAppedSite :: Lens' SitesList (Maybe Bool) Source
Select only sites that have not been mapped to a directory site.
sitCampaignIds :: Lens' SitesList [Int64] Source
Select only sites with these campaign IDs.
sitSearchString :: Lens' SitesList (Maybe Text) Source
Allows searching for objects by name, ID or keyName. Wildcards (*) are allowed. For example, "site*2015" will return objects with names like "site June 2015", "site April 2015", or simply "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 "site" will match objects with name "my site", "site 2015", or simply "site".
sitAcceptsInterstitialPlacements :: Lens' SitesList (Maybe Bool) Source
This search filter is no longer supported and will have no effect on the results returned.
sitAcceptsPublisherPaidPlacements :: Lens' SitesList (Maybe Bool) Source
Select only sites that accept publisher paid placements.
sitProFileId :: Lens' SitesList Int64 Source
User profile ID associated with this request.
sitDirectorySiteIds :: Lens' SitesList [Int64] Source
Select only sites with these directory site IDs.
sitSortOrder :: Lens' SitesList (Maybe SitesListSortOrder) Source
Order of sorted results, default is ASCENDING.
sitPageToken :: Lens' SitesList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
sitSortField :: Lens' SitesList (Maybe SitesListSortField) Source
Field by which to sort the list.