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 directory sites, possibly filtered.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.directorySites.list
.
- type DirectorySitesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("directorySites" :> (QueryParam "searchString" Text :> (QueryParam "acceptsInterstitialPlacements" Bool :> (QueryParam "acceptsPublisherPaidPlacements" Bool :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" DirectorySitesListSortOrder :> (QueryParam "active" Bool :> (QueryParam "countryId" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" DirectorySitesListSortField :> (QueryParam "acceptsInStreamVideoPlacements" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "parentId" (Textual Int64) :> (QueryParam "dfp_network_code" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` DirectorySitesListResponse))))))))))))))))))
- directorySitesList :: Int64 -> DirectorySitesList
- data DirectorySitesList
- dslSearchString :: Lens' DirectorySitesList (Maybe Text)
- dslAcceptsInterstitialPlacements :: Lens' DirectorySitesList (Maybe Bool)
- dslAcceptsPublisherPaidPlacements :: Lens' DirectorySitesList (Maybe Bool)
- dslIds :: Lens' DirectorySitesList [Int64]
- dslProFileId :: Lens' DirectorySitesList Int64
- dslSortOrder :: Lens' DirectorySitesList (Maybe DirectorySitesListSortOrder)
- dslActive :: Lens' DirectorySitesList (Maybe Bool)
- dslCountryId :: Lens' DirectorySitesList (Maybe Int64)
- dslPageToken :: Lens' DirectorySitesList (Maybe Text)
- dslSortField :: Lens' DirectorySitesList (Maybe DirectorySitesListSortField)
- dslAcceptsInStreamVideoPlacements :: Lens' DirectorySitesList (Maybe Bool)
- dslMaxResults :: Lens' DirectorySitesList (Maybe Int32)
- dslParentId :: Lens' DirectorySitesList (Maybe Int64)
- dslDfpNetworkCode :: Lens' DirectorySitesList (Maybe Text)
REST Resource
type DirectorySitesListResource = "dfareporting" :> ("v2.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("directorySites" :> (QueryParam "searchString" Text :> (QueryParam "acceptsInterstitialPlacements" Bool :> (QueryParam "acceptsPublisherPaidPlacements" Bool :> (QueryParams "ids" (Textual Int64) :> (QueryParam "sortOrder" DirectorySitesListSortOrder :> (QueryParam "active" Bool :> (QueryParam "countryId" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" DirectorySitesListSortField :> (QueryParam "acceptsInStreamVideoPlacements" Bool :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "parentId" (Textual Int64) :> (QueryParam "dfp_network_code" Text :> (QueryParam "alt" AltJSON :> Get `[JSON]` DirectorySitesListResponse)))))))))))))))))) Source
A resource alias for dfareporting.directorySites.list
method which the
DirectorySitesList
request conforms to.
Creating a Request
Creates a value of DirectorySitesList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DirectorySitesList Source
Retrieves a list of directory sites, possibly filtered.
See: directorySitesList
smart constructor.
Request Lenses
dslSearchString :: Lens' DirectorySitesList (Maybe Text) Source
Allows searching for objects by name, ID or URL. Wildcards (*) are allowed. For example, "directory site*2015" will return objects with names like "directory site June 2015", "directory site April 2015", or simply "directory 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 "directory site" will match objects with name "my directory site", "directory site 2015" or simply, "directory site".
dslAcceptsInterstitialPlacements :: Lens' DirectorySitesList (Maybe Bool) Source
This search filter is no longer supported and will have no effect on the results returned.
dslAcceptsPublisherPaidPlacements :: Lens' DirectorySitesList (Maybe Bool) Source
Select only directory sites that accept publisher paid placements. This field can be left blank.
dslIds :: Lens' DirectorySitesList [Int64] Source
Select only directory sites with these IDs.
dslProFileId :: Lens' DirectorySitesList Int64 Source
User profile ID associated with this request.
dslSortOrder :: Lens' DirectorySitesList (Maybe DirectorySitesListSortOrder) Source
Order of sorted results, default is ASCENDING.
dslActive :: Lens' DirectorySitesList (Maybe Bool) Source
Select only active directory sites. Leave blank to retrieve both active and inactive directory sites.
dslCountryId :: Lens' DirectorySitesList (Maybe Int64) Source
Select only directory sites with this country ID.
dslPageToken :: Lens' DirectorySitesList (Maybe Text) Source
Value of the nextPageToken from the previous result page.
dslSortField :: Lens' DirectorySitesList (Maybe DirectorySitesListSortField) Source
Field by which to sort the list.
dslAcceptsInStreamVideoPlacements :: Lens' DirectorySitesList (Maybe Bool) Source
This search filter is no longer supported and will have no effect on the results returned.
dslMaxResults :: Lens' DirectorySitesList (Maybe Int32) Source
Maximum number of results to return.
dslParentId :: Lens' DirectorySitesList (Maybe Int64) Source
Select only directory sites with this parent ID.
dslDfpNetworkCode :: Lens' DirectorySitesList (Maybe Text) Source
Select only directory sites with this DFP network code.