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 the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
See: Ad Exchange Buyer API Reference for adexchangebuyer.creatives.list
.
Synopsis
- type CreativesListResource = "adexchangebuyer" :> ("v1.4" :> ("creatives" :> (QueryParams "buyerCreativeId" Text :> (QueryParam "openAuctionStatusFilter" CreativesListOpenAuctionStatusFilter :> (QueryParams "accountId" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "dealsStatusFilter" CreativesListDealsStatusFilter :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CreativesList)))))))))
- creativesList' :: CreativesList'
- data CreativesList'
- clBuyerCreativeId :: Lens' CreativesList' [Text]
- clOpenAuctionStatusFilter :: Lens' CreativesList' (Maybe CreativesListOpenAuctionStatusFilter)
- clAccountId :: Lens' CreativesList' [Int32]
- clPageToken :: Lens' CreativesList' (Maybe Text)
- clDealsStatusFilter :: Lens' CreativesList' (Maybe CreativesListDealsStatusFilter)
- clMaxResults :: Lens' CreativesList' (Maybe Word32)
REST Resource
type CreativesListResource = "adexchangebuyer" :> ("v1.4" :> ("creatives" :> (QueryParams "buyerCreativeId" Text :> (QueryParam "openAuctionStatusFilter" CreativesListOpenAuctionStatusFilter :> (QueryParams "accountId" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "dealsStatusFilter" CreativesListDealsStatusFilter :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] CreativesList))))))))) Source #
A resource alias for adexchangebuyer.creatives.list
method which the
CreativesList'
request conforms to.
Creating a Request
creativesList' :: CreativesList' Source #
Creates a value of CreativesList'
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreativesList' Source #
Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
See: creativesList'
smart constructor.
Instances
Request Lenses
clBuyerCreativeId :: Lens' CreativesList' [Text] Source #
When specified, only creatives for the given buyer creative ids are returned.
clOpenAuctionStatusFilter :: Lens' CreativesList' (Maybe CreativesListOpenAuctionStatusFilter) Source #
When specified, only creatives having the given open auction status are returned.
clAccountId :: Lens' CreativesList' [Int32] Source #
When specified, only creatives for the given account ids are returned.
clPageToken :: Lens' CreativesList' (Maybe Text) Source #
A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
clDealsStatusFilter :: Lens' CreativesList' (Maybe CreativesListDealsStatusFilter) Source #
When specified, only creatives having the given deals status are returned.
clMaxResults :: Lens' CreativesList' (Maybe Word32) Source #
Maximum number of entries returned on one result page. If not set, the default is 100. Optional.