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 data about all advertisers that the requesting advertiser/publisher has access to.
See: Google Affiliate Network API Reference for gan.advertisers.list
.
- type AdvertisersListResource = "gan" :> ("v1beta1" :> (Capture "role" AdvertisersListRole :> (Capture "roleId" Text :> ("advertisers" :> (QueryParam "relationshipStatus" AdvertisersListRelationshipStatus :> (QueryParam "minSevenDayEpc" (Textual Double) :> (QueryParam "minNinetyDayEpc" (Textual Double) :> (QueryParam "minPayoutRank" (Textual Int32) :> (QueryParam "advertiserCategory" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Advertisers))))))))))))
- advertisersList :: Text -> AdvertisersListRole -> AdvertisersList
- data AdvertisersList
- alRelationshipStatus :: Lens' AdvertisersList (Maybe AdvertisersListRelationshipStatus)
- alMinSevenDayEpc :: Lens' AdvertisersList (Maybe Double)
- alRoleId :: Lens' AdvertisersList Text
- alMinNinetyDayEpc :: Lens' AdvertisersList (Maybe Double)
- alRole :: Lens' AdvertisersList AdvertisersListRole
- alMinPayoutRank :: Lens' AdvertisersList (Maybe Int32)
- alAdvertiserCategory :: Lens' AdvertisersList (Maybe Text)
- alPageToken :: Lens' AdvertisersList (Maybe Text)
- alMaxResults :: Lens' AdvertisersList (Maybe Word32)
REST Resource
type AdvertisersListResource = "gan" :> ("v1beta1" :> (Capture "role" AdvertisersListRole :> (Capture "roleId" Text :> ("advertisers" :> (QueryParam "relationshipStatus" AdvertisersListRelationshipStatus :> (QueryParam "minSevenDayEpc" (Textual Double) :> (QueryParam "minNinetyDayEpc" (Textual Double) :> (QueryParam "minPayoutRank" (Textual Int32) :> (QueryParam "advertiserCategory" Text :> (QueryParam "pageToken" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Advertisers)))))))))))) Source #
A resource alias for gan.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 data about all advertisers that the requesting advertiser/publisher has access to.
See: advertisersList
smart constructor.
Request Lenses
alRelationshipStatus :: Lens' AdvertisersList (Maybe AdvertisersListRelationshipStatus) Source #
Filters out all advertisers for which do not have the given relationship status with the requesting publisher.
alMinSevenDayEpc :: Lens' AdvertisersList (Maybe Double) Source #
Filters out all advertisers that have a seven day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
alMinNinetyDayEpc :: Lens' AdvertisersList (Maybe Double) Source #
Filters out all advertisers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
alRole :: Lens' AdvertisersList AdvertisersListRole Source #
The role of the requester. Valid values: 'advertisers' or 'publishers'.
alMinPayoutRank :: Lens' AdvertisersList (Maybe Int32) Source #
A value between 1 and 4, where 1 represents the quartile of advertisers with the lowest ranks and 4 represents the quartile of advertisers with the highest ranks. Filters out all advertisers with a lower rank than the given quartile. For example if a 2 was given only advertisers with a payout rank of 25 or higher would be included. Optional.
alAdvertiserCategory :: Lens' AdvertisersList (Maybe Text) Source #
Caret(^) delimted list of advertiser categories. Valid categories are defined here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581. Filters out all advertisers not in one of the given advertiser categories. Optional.
alPageToken :: Lens' AdvertisersList (Maybe Text) Source #
The value of 'nextPageToken' from the previous page. Optional.
alMaxResults :: Lens' AdvertisersList (Maybe Word32) Source #
Max number of items to return in this page. Optional. Defaults to 20.