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 event data for a given advertiser/publisher.
See: Google Affiliate Network API Reference for gan.events.list
.
- type EventsListResource = "gan" :> ("v1beta1" :> (Capture "role" EventsListRole :> (Capture "roleId" Text :> ("events" :> (QueryParam "status" EventsListStatus :> (QueryParam "eventDateMin" Text :> (QueryParam "chargeType" EventsListChargeType :> (QueryParam "memberId" Text :> (QueryParam "modifyDateMax" Text :> (QueryParam "advertiserId" Text :> (QueryParam "modifyDateMin" Text :> (QueryParam "eventDateMax" Text :> (QueryParam "sku" Text :> (QueryParam "linkId" Text :> (QueryParam "pageToken" Text :> (QueryParam "type" EventsListType :> (QueryParam "orderId" Text :> (QueryParam "publisherId" Text :> (QueryParam "productCategory" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Events)))))))))))))))))))))
- eventsList :: Text -> EventsListRole -> EventsList
- data EventsList
- elStatus :: Lens' EventsList (Maybe EventsListStatus)
- elEventDateMin :: Lens' EventsList (Maybe Text)
- elChargeType :: Lens' EventsList (Maybe EventsListChargeType)
- elMemberId :: Lens' EventsList (Maybe Text)
- elModifyDateMax :: Lens' EventsList (Maybe Text)
- elAdvertiserId :: Lens' EventsList (Maybe Text)
- elModifyDateMin :: Lens' EventsList (Maybe Text)
- elRoleId :: Lens' EventsList Text
- elRole :: Lens' EventsList EventsListRole
- elEventDateMax :: Lens' EventsList (Maybe Text)
- elSKU :: Lens' EventsList (Maybe Text)
- elLinkId :: Lens' EventsList (Maybe Text)
- elPageToken :: Lens' EventsList (Maybe Text)
- elType :: Lens' EventsList (Maybe EventsListType)
- elOrderId :: Lens' EventsList (Maybe Text)
- elPublisherId :: Lens' EventsList (Maybe Text)
- elProductCategory :: Lens' EventsList (Maybe Text)
- elMaxResults :: Lens' EventsList (Maybe Word32)
REST Resource
type EventsListResource = "gan" :> ("v1beta1" :> (Capture "role" EventsListRole :> (Capture "roleId" Text :> ("events" :> (QueryParam "status" EventsListStatus :> (QueryParam "eventDateMin" Text :> (QueryParam "chargeType" EventsListChargeType :> (QueryParam "memberId" Text :> (QueryParam "modifyDateMax" Text :> (QueryParam "advertiserId" Text :> (QueryParam "modifyDateMin" Text :> (QueryParam "eventDateMax" Text :> (QueryParam "sku" Text :> (QueryParam "linkId" Text :> (QueryParam "pageToken" Text :> (QueryParam "type" EventsListType :> (QueryParam "orderId" Text :> (QueryParam "publisherId" Text :> (QueryParam "productCategory" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get '[JSON] Events))))))))))))))))))))) Source #
A resource alias for gan.events.list
method which the
EventsList
request conforms to.
Creating a Request
Creates a value of EventsList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data EventsList Source #
Retrieves event data for a given advertiser/publisher.
See: eventsList
smart constructor.
Eq EventsList Source # | |
Data EventsList Source # | |
Show EventsList Source # | |
Generic EventsList Source # | |
GoogleRequest EventsList Source # | |
type Rep EventsList Source # | |
type Scopes EventsList Source # | |
type Rs EventsList Source # | |
Request Lenses
elStatus :: Lens' EventsList (Maybe EventsListStatus) Source #
Filters out all events that do not have the given status. Valid values: 'active', 'canceled'. Optional.
elEventDateMin :: Lens' EventsList (Maybe Text) Source #
Filters out all events earlier than given date. Optional. Defaults to 24 hours from current date/time.
elChargeType :: Lens' EventsList (Maybe EventsListChargeType) Source #
Filters out all charge events that are not of the given charge type. Valid values: 'other', 'slotting_fee', 'monthly_minimum', 'tier_bonus', 'credit', 'debit'. Optional.
elMemberId :: Lens' EventsList (Maybe Text) Source #
Caret(^) delimited list of member IDs. Filters out all events that do not reference one of the given member IDs. Optional.
elModifyDateMax :: Lens' EventsList (Maybe Text) Source #
Filters out all events modified later than given date. Optional. Defaults to 24 hours after modifyDateMin, if modifyDateMin is explicitly set.
elAdvertiserId :: Lens' EventsList (Maybe Text) Source #
Caret(^) delimited list of advertiser IDs. Filters out all events that do not reference one of the given advertiser IDs. Only used when under publishers role. Optional.
elModifyDateMin :: Lens' EventsList (Maybe Text) Source #
Filters out all events modified earlier than given date. Optional. Defaults to 24 hours before the current modifyDateMax, if modifyDateMax is explicitly set.
elRole :: Lens' EventsList EventsListRole Source #
The role of the requester. Valid values: 'advertisers' or 'publishers'.
elEventDateMax :: Lens' EventsList (Maybe Text) Source #
Filters out all events later than given date. Optional. Defaults to 24 hours after eventMin.
elSKU :: Lens' EventsList (Maybe Text) Source #
Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional.
elLinkId :: Lens' EventsList (Maybe Text) Source #
Caret(^) delimited list of link IDs. Filters out all events that do not reference one of the given link IDs. Optional.
elPageToken :: Lens' EventsList (Maybe Text) Source #
The value of 'nextPageToken' from the previous page. Optional.
elType :: Lens' EventsList (Maybe EventsListType) Source #
Filters out all events that are not of the given type. Valid values: 'action', 'transaction', 'charge'. Optional.
elOrderId :: Lens' EventsList (Maybe Text) Source #
Caret(^) delimited list of order IDs. Filters out all events that do not reference one of the given order IDs. Optional.
elPublisherId :: Lens' EventsList (Maybe Text) Source #
Caret(^) delimited list of publisher IDs. Filters out all events that do not reference one of the given publishers IDs. Only used when under advertiser role. Optional.
elProductCategory :: Lens' EventsList (Maybe Text) Source #
Caret(^) delimited list of product categories. Filters out all events that do not reference a product in one of the given product categories. Optional.
elMaxResults :: Lens' EventsList (Maybe Word32) Source #
Max number of offers to return in this page. Optional. Defaults to 20.