Copyright | (c) 2015-2016 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 advertisers, possibly filtered. This method supports paging.
See: DCM/DFA Reporting And Trafficking API Reference for dfareporting.advertisers.list
.
Synopsis
- type AdvertisersListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("advertisers" :> (QueryParam "status" AdvertisersListStatus :> (QueryParam "onlyParent" Bool :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "includeAdvertisersWithoutGroupsOnly" Bool :> (QueryParam "sortOrder" AdvertisersListSortOrder :> (QueryParams "advertiserGroupIds" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AdvertisersListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParams "floodlightConfigurationIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AdvertisersListResponse)))))))))))))))))
- advertisersList :: Int64 -> AdvertisersList
- data AdvertisersList
- allStatus :: Lens' AdvertisersList (Maybe AdvertisersListStatus)
- allOnlyParent :: Lens' AdvertisersList (Maybe Bool)
- allSearchString :: Lens' AdvertisersList (Maybe Text)
- allIds :: Lens' AdvertisersList [Int64]
- allIncludeAdvertisersWithoutGroupsOnly :: Lens' AdvertisersList (Maybe Bool)
- allProFileId :: Lens' AdvertisersList Int64
- allSortOrder :: Lens' AdvertisersList AdvertisersListSortOrder
- allAdvertiserGroupIds :: Lens' AdvertisersList [Int64]
- allPageToken :: Lens' AdvertisersList (Maybe Text)
- allSortField :: Lens' AdvertisersList AdvertisersListSortField
- allSubAccountId :: Lens' AdvertisersList (Maybe Int64)
- allFloodlightConfigurationIds :: Lens' AdvertisersList [Int64]
- allMaxResults :: Lens' AdvertisersList Int32
REST Resource
type AdvertisersListResource = "dfareporting" :> ("v3.2" :> ("userprofiles" :> (Capture "profileId" (Textual Int64) :> ("advertisers" :> (QueryParam "status" AdvertisersListStatus :> (QueryParam "onlyParent" Bool :> (QueryParam "searchString" Text :> (QueryParams "ids" (Textual Int64) :> (QueryParam "includeAdvertisersWithoutGroupsOnly" Bool :> (QueryParam "sortOrder" AdvertisersListSortOrder :> (QueryParams "advertiserGroupIds" (Textual Int64) :> (QueryParam "pageToken" Text :> (QueryParam "sortField" AdvertisersListSortField :> (QueryParam "subaccountId" (Textual Int64) :> (QueryParams "floodlightConfigurationIds" (Textual Int64) :> (QueryParam "maxResults" (Textual Int32) :> (QueryParam "alt" AltJSON :> Get '[JSON] AdvertisersListResponse))))))))))))))))) Source #
A resource alias for dfareporting.advertisers.list
method which the
AdvertisersList
request conforms to.
Creating a Request
Creates a value of AdvertisersList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data AdvertisersList Source #
Retrieves a list of advertisers, possibly filtered. This method supports paging.
See: advertisersList
smart constructor.
Instances
Request Lenses
allStatus :: Lens' AdvertisersList (Maybe AdvertisersListStatus) Source #
Select only advertisers with the specified status.
allOnlyParent :: Lens' AdvertisersList (Maybe Bool) Source #
Select only advertisers which use another advertiser's floodlight configuration.
allSearchString :: Lens' AdvertisersList (Maybe Text) Source #
Allows searching for objects by name or ID. Wildcards (*) are allowed. For example, "advertiser*2015" will return objects with names like "advertiser June 2015", "advertiser April 2015", or simply "advertiser 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 "advertiser" will match objects with name "my advertiser", "advertiser 2015", or simply "advertiser".
allIncludeAdvertisersWithoutGroupsOnly :: Lens' AdvertisersList (Maybe Bool) Source #
Select only advertisers which do not belong to any advertiser group.
allProFileId :: Lens' AdvertisersList Int64 Source #
User profile ID associated with this request.
allSortOrder :: Lens' AdvertisersList AdvertisersListSortOrder Source #
Order of sorted results.
allAdvertiserGroupIds :: Lens' AdvertisersList [Int64] Source #
Select only advertisers with these advertiser group IDs.
allPageToken :: Lens' AdvertisersList (Maybe Text) Source #
Value of the nextPageToken from the previous result page.
allSortField :: Lens' AdvertisersList AdvertisersListSortField Source #
Field by which to sort the list.
allSubAccountId :: Lens' AdvertisersList (Maybe Int64) Source #
Select only advertisers with these subaccount IDs.
allFloodlightConfigurationIds :: Lens' AdvertisersList [Int64] Source #
Select only advertisers with these floodlight configuration IDs.
allMaxResults :: Lens' AdvertisersList Int32 Source #
Maximum number of results to return.