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 publishers that the requesting advertiser/publisher has access to.
See: Google Affiliate Network API Reference for gan.publishers.list
.
- type PublishersListResource = "gan" :> ("v1beta1" :> (Capture "role" PublishersListRole :> (Capture "roleId" Text :> ("publishers" :> (QueryParam "relationshipStatus" PublishersListRelationshipStatus :> (QueryParam "minSevenDayEpc" (Textual Double) :> (QueryParam "minNinetyDayEpc" (Textual Double) :> (QueryParam "minPayoutRank" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "publisherCategory" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Publishers))))))))))))
- publishersList :: Text -> PublishersListRole -> PublishersList
- data PublishersList
- plRelationshipStatus :: Lens' PublishersList (Maybe PublishersListRelationshipStatus)
- plMinSevenDayEpc :: Lens' PublishersList (Maybe Double)
- plRoleId :: Lens' PublishersList Text
- plMinNinetyDayEpc :: Lens' PublishersList (Maybe Double)
- plRole :: Lens' PublishersList PublishersListRole
- plMinPayoutRank :: Lens' PublishersList (Maybe Int32)
- plPageToken :: Lens' PublishersList (Maybe Text)
- plPublisherCategory :: Lens' PublishersList (Maybe Text)
- plMaxResults :: Lens' PublishersList (Maybe Word32)
REST Resource
type PublishersListResource = "gan" :> ("v1beta1" :> (Capture "role" PublishersListRole :> (Capture "roleId" Text :> ("publishers" :> (QueryParam "relationshipStatus" PublishersListRelationshipStatus :> (QueryParam "minSevenDayEpc" (Textual Double) :> (QueryParam "minNinetyDayEpc" (Textual Double) :> (QueryParam "minPayoutRank" (Textual Int32) :> (QueryParam "pageToken" Text :> (QueryParam "publisherCategory" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Publishers)))))))))))) Source #
A resource alias for gan.publishers.list
method which the
PublishersList
request conforms to.
Creating a Request
Creates a value of PublishersList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data PublishersList Source #
Retrieves data about all publishers that the requesting advertiser/publisher has access to.
See: publishersList
smart constructor.
Request Lenses
plRelationshipStatus :: Lens' PublishersList (Maybe PublishersListRelationshipStatus) Source #
Filters out all publishers for which do not have the given relationship status with the requesting publisher.
plMinSevenDayEpc :: Lens' PublishersList (Maybe Double) Source #
Filters out all publishers that have a seven day EPC average lower than the given value (inclusive). Min value 0.0. Optional.
plMinNinetyDayEpc :: Lens' PublishersList (Maybe Double) Source #
Filters out all publishers that have a ninety day EPC average lower than the given value (inclusive). Min value: 0.0. Optional.
plRole :: Lens' PublishersList PublishersListRole Source #
The role of the requester. Valid values: 'advertisers' or 'publishers'.
plMinPayoutRank :: Lens' PublishersList (Maybe Int32) Source #
A value between 1 and 4, where 1 represents the quartile of publishers with the lowest ranks and 4 represents the quartile of publishers with the highest ranks. Filters out all publishers with a lower rank than the given quartile. For example if a 2 was given only publishers with a payout rank of 25 or higher would be included. Optional.
plPageToken :: Lens' PublishersList (Maybe Text) Source #
The value of 'nextPageToken' from the previous page. Optional.
plPublisherCategory :: Lens' PublishersList (Maybe Text) Source #
Caret(^) delimted list of publisher categories. Valid categories: (unclassified|community_and_content|shopping_and_promotion|loyalty_and_rewards|network|search_specialist|comparison_shopping|email). Filters out all publishers not in one of the given advertiser categories. Optional.
plMaxResults :: Lens' PublishersList (Maybe Word32) Source #
Max number of items to return in this page. Optional. Defaults to 20.