Network.Google.Resource.GAN.Events.List

Retrieves event data for a given advertiser/publisher.

See: Google Affiliate Network API Reference for gan.events.list.

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)))))))))))))))))))))

A resource alias for gan.events.list method which the EventsList request conforms to.

Creating a Request

eventsList

Arguments

:: Text

elRoleId

-> EventsListRole

elRole

-> EventsList

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:

• elStatus
• elEventDateMin
• elChargeType
• elMemberId
• elModifyDateMax
• elAdvertiserId
• elModifyDateMin
• elRoleId
• elRole
• elEventDateMax
• elSKU
• elLinkId
• elPageToken
• elType
• elOrderId
• elPublisherId
• elProductCategory
• elMaxResults

data EventsList

Retrieves event data for a given advertiser/publisher.

See: eventsList smart constructor.

Instances

Eq EventsList

Data EventsList

Show EventsList

Generic EventsList

GoogleRequest EventsList

type Rep EventsList

type Rs EventsList = Events

Request Lenses

elStatus :: Lens' EventsList (Maybe EventsListStatus)

Filters out all events that do not have the given status. Valid values: 'active', 'canceled'. Optional.

elEventDateMin :: Lens' EventsList (Maybe Text)

Filters out all events earlier than given date. Optional. Defaults to 24 hours from current date/time.

elChargeType :: Lens' EventsList (Maybe EventsListChargeType)

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)

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)

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)

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)

Filters out all events modified earlier than given date. Optional. Defaults to 24 hours before the current modifyDateMax, if modifyDateMax is explicitly set.

elRoleId :: Lens' EventsList Text

The ID of the requesting advertiser or publisher.

elRole :: Lens' EventsList EventsListRole

The role of the requester. Valid values: 'advertisers' or 'publishers'.

elEventDateMax :: Lens' EventsList (Maybe Text)

Filters out all events later than given date. Optional. Defaults to 24 hours after eventMin.

elSKU :: Lens' EventsList (Maybe Text)

Caret(^) delimited list of SKUs. Filters out all events that do not reference one of the given SKU. Optional.

elLinkId :: Lens' EventsList (Maybe Text)

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)

The value of 'nextPageToken' from the previous page. Optional.

elType :: Lens' EventsList (Maybe EventsListType)

Filters out all events that are not of the given type. Valid values: 'action', 'transaction', 'charge'. Optional.

elOrderId :: Lens' EventsList (Maybe Text)

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)

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)

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)

Max number of offers to return in this page. Optional. Defaults to 20.