Copyright | (c) 2015 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 |
- Service Configuration
- Event
- PublishersGetRole
- ReportsGetEventType
- ReportsGetStatus
- LinksListPromotionType
- EventsListType
- LinksListRole
- ReportsGetReportType
- AdvertisersListRole
- Money
- Link
- LinksInsertRole
- CcOffers
- PublishersListRole
- CcOfferDefaultFeesItem
- Report
- LinksListAuthorship
- Advertisers
- LinksGetRole
- LinksListLinkType
- EventsListRole
- EventProductsItem
- AdvertisersListRelationshipStatus
- CcOffersListProjection
- CcOfferBonusRewardsItem
- AdvertisersGetRole
- EventsListChargeType
- PublishersListRelationshipStatus
- ReportsGetRole
- Events
- LinkSpecialOffers
- Publishers
- Advertiser
- CcOffer
- Links
- Publisher
- CcOfferRewardsItem
- LinksListRelationshipStatus
- EventsListStatus
- affiliatesService :: Service
- data Event
- event :: Event
- eModifyDate :: Lens' Event (Maybe UTCTime)
- eStatus :: Lens' Event (Maybe Text)
- eCommissionableSales :: Lens' Event (Maybe Money)
- eChargeId :: Lens' Event (Maybe Text)
- eAdvertiserName :: Lens' Event (Maybe Text)
- eChargeType :: Lens' Event (Maybe Text)
- eMemberId :: Lens' Event (Maybe Text)
- eKind :: Lens' Event Text
- eNetworkFee :: Lens' Event (Maybe Money)
- eAdvertiserId :: Lens' Event (Maybe Int64)
- eEventDate :: Lens' Event (Maybe UTCTime)
- eProducts :: Lens' Event [EventProductsItem]
- ePublisherFee :: Lens' Event (Maybe Money)
- eType :: Lens' Event (Maybe Text)
- eOrderId :: Lens' Event (Maybe Text)
- ePublisherId :: Lens' Event (Maybe Int64)
- eEarnings :: Lens' Event (Maybe Money)
- ePublisherName :: Lens' Event (Maybe Text)
- data PublishersGetRole
- data ReportsGetEventType
- = Action
- | Charge
- | Transaction
- data ReportsGetStatus
- data LinksListPromotionType
- data EventsListType
- data LinksListRole
- data ReportsGetReportType = OrderDelta
- data AdvertisersListRole
- data Money
- money :: Money
- mAmount :: Lens' Money (Maybe Double)
- mCurrencyCode :: Lens' Money (Maybe Text)
- data Link
- link :: Link
- lAuthorship :: Lens' Link (Maybe Text)
- lDestinationURL :: Lens' Link (Maybe Text)
- lClickTrackingURL :: Lens' Link (Maybe Text)
- lCreateDate :: Lens' Link (Maybe UTCTime)
- lKind :: Lens' Link Text
- lAdvertiserId :: Lens' Link (Maybe Int64)
- lEndDate :: Lens' Link (Maybe UTCTime)
- lImageAltText :: Lens' Link (Maybe Text)
- lPromotionType :: Lens' Link (Maybe Text)
- lAvailability :: Lens' Link (Maybe Text)
- lStartDate :: Lens' Link (Maybe UTCTime)
- lName :: Lens' Link (Maybe Text)
- lImpressionTrackingURL :: Lens' Link (Maybe Text)
- lSpecialOffers :: Lens' Link (Maybe LinkSpecialOffers)
- lEpcSevenDayAverage :: Lens' Link (Maybe Money)
- lId :: Lens' Link (Maybe Int64)
- lEpcNinetyDayAverage :: Lens' Link (Maybe Money)
- lLinkType :: Lens' Link (Maybe Text)
- lIsActive :: Lens' Link (Maybe Bool)
- lDuration :: Lens' Link (Maybe Text)
- lDescription :: Lens' Link (Maybe Text)
- data LinksInsertRole
- data CcOffers
- ccOffers :: CcOffers
- coKind :: Lens' CcOffers Text
- coItems :: Lens' CcOffers [CcOffer]
- data PublishersListRole
- data CcOfferDefaultFeesItem
- ccOfferDefaultFeesItem :: CcOfferDefaultFeesItem
- codfiRateType :: Lens' CcOfferDefaultFeesItem (Maybe Text)
- codfiMinRate :: Lens' CcOfferDefaultFeesItem (Maybe Double)
- codfiCategory :: Lens' CcOfferDefaultFeesItem (Maybe Text)
- codfiMaxRate :: Lens' CcOfferDefaultFeesItem (Maybe Double)
- data Report
- report :: Report
- rEndDate :: Lens' Report (Maybe Text)
- rTotalsRows :: Lens' Report [[JSONValue]]
- rKind :: Lens' Report Text
- rStartDate :: Lens' Report (Maybe Text)
- rRows :: Lens' Report [[JSONValue]]
- rMatchingRowCount :: Lens' Report (Maybe Int64)
- rColumnNames :: Lens' Report [Text]
- rType :: Lens' Report (Maybe Text)
- data LinksListAuthorship
- data Advertisers
- advertisers :: Advertisers
- aNextPageToken :: Lens' Advertisers (Maybe Text)
- aKind :: Lens' Advertisers Text
- aItems :: Lens' Advertisers [Advertiser]
- data LinksGetRole
- data LinksListLinkType
- data EventsListRole
- data EventProductsItem
- eventProductsItem :: EventProductsItem
- epiSKUName :: Lens' EventProductsItem (Maybe Text)
- epiNetworkFee :: Lens' EventProductsItem (Maybe Money)
- epiQuantity :: Lens' EventProductsItem (Maybe Int64)
- epiCategoryName :: Lens' EventProductsItem (Maybe Text)
- epiCategoryId :: Lens' EventProductsItem (Maybe Text)
- epiSKU :: Lens' EventProductsItem (Maybe Text)
- epiPublisherFee :: Lens' EventProductsItem (Maybe Money)
- epiUnitPrice :: Lens' EventProductsItem (Maybe Money)
- epiEarnings :: Lens' EventProductsItem (Maybe Money)
- data AdvertisersListRelationshipStatus
- data CcOffersListProjection
- data CcOfferBonusRewardsItem
- ccOfferBonusRewardsItem :: CcOfferBonusRewardsItem
- cobriAmount :: Lens' CcOfferBonusRewardsItem (Maybe Double)
- cobriDetails :: Lens' CcOfferBonusRewardsItem (Maybe Text)
- data AdvertisersGetRole
- data EventsListChargeType
- data PublishersListRelationshipStatus
- data ReportsGetRole
- data Events
- events :: Events
- eveNextPageToken :: Lens' Events (Maybe Text)
- eveKind :: Lens' Events Text
- eveItems :: Lens' Events [Event]
- data LinkSpecialOffers
- linkSpecialOffers :: LinkSpecialOffers
- lsoFreeShippingMin :: Lens' LinkSpecialOffers (Maybe Money)
- lsoPercentOff :: Lens' LinkSpecialOffers (Maybe Double)
- lsoPriceCut :: Lens' LinkSpecialOffers (Maybe Money)
- lsoPriceCutMin :: Lens' LinkSpecialOffers (Maybe Money)
- lsoPercentOffMin :: Lens' LinkSpecialOffers (Maybe Money)
- lsoFreeShipping :: Lens' LinkSpecialOffers (Maybe Bool)
- lsoPromotionCodes :: Lens' LinkSpecialOffers [Text]
- lsoFreeGift :: Lens' LinkSpecialOffers (Maybe Bool)
- data Publishers
- publishers :: Publishers
- pNextPageToken :: Lens' Publishers (Maybe Text)
- pKind :: Lens' Publishers Text
- pItems :: Lens' Publishers [Publisher]
- data Advertiser
- advertiser :: Advertiser
- advAllowPublisherCreatedLinks :: Lens' Advertiser (Maybe Bool)
- advContactPhone :: Lens' Advertiser (Maybe Text)
- advContactEmail :: Lens' Advertiser (Maybe Text)
- advStatus :: Lens' Advertiser (Maybe Text)
- advLogoURL :: Lens' Advertiser (Maybe Text)
- advKind :: Lens' Advertiser Text
- advCategory :: Lens' Advertiser (Maybe Text)
- advSiteURL :: Lens' Advertiser (Maybe Text)
- advPayoutRank :: Lens' Advertiser (Maybe Text)
- advJoinDate :: Lens' Advertiser (Maybe UTCTime)
- advDefaultLinkId :: Lens' Advertiser (Maybe Int64)
- advRedirectDomains :: Lens' Advertiser [Text]
- advName :: Lens' Advertiser (Maybe Text)
- advProductFeedsEnabled :: Lens' Advertiser (Maybe Bool)
- advMerchantCenterIds :: Lens' Advertiser [Int64]
- advEpcSevenDayAverage :: Lens' Advertiser (Maybe Money)
- advItem :: Lens' Advertiser (Maybe Advertiser)
- advId :: Lens' Advertiser (Maybe Int64)
- advEpcNinetyDayAverage :: Lens' Advertiser (Maybe Money)
- advCommissionDuration :: Lens' Advertiser (Maybe Int32)
- advDescription :: Lens' Advertiser (Maybe Text)
- data CcOffer
- ccOffer :: CcOffer
- cMinimumFinanceCharge :: Lens' CcOffer (Maybe Text)
- cTrackingURL :: Lens' CcOffer (Maybe Text)
- cProhibitedCategories :: Lens' CcOffer [Text]
- cBalanceComputationMethod :: Lens' CcOffer (Maybe Text)
- cInitialSetupAndProcessingFee :: Lens' CcOffer (Maybe Text)
- cReturnedPaymentFee :: Lens' CcOffer (Maybe Text)
- cAgeMinimumDetails :: Lens' CcOffer (Maybe Text)
- cVariableRatesUpdateFrequency :: Lens' CcOffer (Maybe Text)
- cCreditLimitMin :: Lens' CcOffer (Maybe Double)
- cTravelInsurance :: Lens' CcOffer (Maybe Text)
- cApprovedCategories :: Lens' CcOffer [Text]
- cAnnualFeeDisplay :: Lens' CcOffer (Maybe Text)
- cOverLimitFee :: Lens' CcOffer (Maybe Text)
- cMaxPurchaseRate :: Lens' CcOffer (Maybe Double)
- cAgeMinimum :: Lens' CcOffer (Maybe Double)
- cVariableRatesLastUpdated :: Lens' CcOffer (Maybe Text)
- cIntroCashAdvanceTerms :: Lens' CcOffer (Maybe Text)
- cIssuerWebsite :: Lens' CcOffer (Maybe Text)
- cLuggageInsurance :: Lens' CcOffer (Maybe Text)
- cKind :: Lens' CcOffer Text
- cRewardsHaveBlackoutDates :: Lens' CcOffer (Maybe Bool)
- cDisclaimer :: Lens' CcOffer (Maybe Text)
- cAdditionalCardHolderFee :: Lens' CcOffer (Maybe Text)
- cExistingCustomerOnly :: Lens' CcOffer (Maybe Bool)
- cEmergencyInsurance :: Lens' CcOffer (Maybe Text)
- cNetwork :: Lens' CcOffer (Maybe Text)
- cCashAdvanceTerms :: Lens' CcOffer (Maybe Text)
- cStatementCopyFee :: Lens' CcOffer (Maybe Text)
- cAprDisplay :: Lens' CcOffer (Maybe Text)
- cOffersImmediateCashReward :: Lens' CcOffer (Maybe Bool)
- cRewards :: Lens' CcOffer [CcOfferRewardsItem]
- cCardType :: Lens' CcOffer (Maybe Text)
- cImageURL :: Lens' CcOffer (Maybe Text)
- cCreditLimitMax :: Lens' CcOffer (Maybe Double)
- cLandingPageURL :: Lens' CcOffer (Maybe Text)
- cAnnualFee :: Lens' CcOffer (Maybe Double)
- cRewardsExpire :: Lens' CcOffer (Maybe Bool)
- cFirstYearAnnualFee :: Lens' CcOffer (Maybe Double)
- cCarRentalInsurance :: Lens' CcOffer (Maybe Text)
- cPurchaseRateAdditionalDetails :: Lens' CcOffer (Maybe Text)
- cOfferId :: Lens' CcOffer (Maybe Text)
- cGracePeriodDisplay :: Lens' CcOffer (Maybe Text)
- cIntroPurchaseTerms :: Lens' CcOffer (Maybe Text)
- cCreditRatingDisplay :: Lens' CcOffer (Maybe Text)
- cBalanceTransferTerms :: Lens' CcOffer (Maybe Text)
- cLatePaymentFee :: Lens' CcOffer (Maybe Text)
- cCardBenefits :: Lens' CcOffer [Text]
- cIssuer :: Lens' CcOffer (Maybe Text)
- cCardName :: Lens' CcOffer (Maybe Text)
- cMinPurchaseRate :: Lens' CcOffer (Maybe Double)
- cFraudLiability :: Lens' CcOffer (Maybe Text)
- cForeignCurrencyTransactionFee :: Lens' CcOffer (Maybe Text)
- cExtendedWarranty :: Lens' CcOffer (Maybe Text)
- cAnnualRewardMaximum :: Lens' CcOffer (Maybe Double)
- cIssuerId :: Lens' CcOffer (Maybe Text)
- cIntroBalanceTransferTerms :: Lens' CcOffer (Maybe Text)
- cDefaultFees :: Lens' CcOffer [CcOfferDefaultFeesItem]
- cAdditionalCardBenefits :: Lens' CcOffer [Text]
- cRewardUnit :: Lens' CcOffer (Maybe Text)
- cBonusRewards :: Lens' CcOffer [CcOfferBonusRewardsItem]
- cFlightAccidentInsurance :: Lens' CcOffer (Maybe Text)
- cRewardPartner :: Lens' CcOffer (Maybe Text)
- cPurchaseRateType :: Lens' CcOffer (Maybe Text)
- data Links
- links :: Links
- linNextPageToken :: Lens' Links (Maybe Text)
- linKind :: Lens' Links Text
- linItems :: Lens' Links [Link]
- data Publisher
- publisher :: Publisher
- pubStatus :: Lens' Publisher (Maybe Text)
- pubKind :: Lens' Publisher Text
- pubPayoutRank :: Lens' Publisher (Maybe Text)
- pubJoinDate :: Lens' Publisher (Maybe UTCTime)
- pubClassification :: Lens' Publisher (Maybe Text)
- pubName :: Lens' Publisher (Maybe Text)
- pubEpcSevenDayAverage :: Lens' Publisher (Maybe Money)
- pubItem :: Lens' Publisher (Maybe Publisher)
- pubId :: Lens' Publisher (Maybe Int64)
- pubEpcNinetyDayAverage :: Lens' Publisher (Maybe Money)
- pubSites :: Lens' Publisher [Text]
- data CcOfferRewardsItem
- ccOfferRewardsItem :: CcOfferRewardsItem
- coriAmount :: Lens' CcOfferRewardsItem (Maybe Double)
- coriExpirationMonths :: Lens' CcOfferRewardsItem (Maybe Double)
- coriCategory :: Lens' CcOfferRewardsItem (Maybe Text)
- coriAdditionalDetails :: Lens' CcOfferRewardsItem (Maybe Text)
- coriMaxRewardTier :: Lens' CcOfferRewardsItem (Maybe Double)
- coriMinRewardTier :: Lens' CcOfferRewardsItem (Maybe Double)
- data LinksListRelationshipStatus
- data EventsListStatus
Service Configuration
affiliatesService :: Service Source
Default request referring to version v1beta1
of the Google Affiliate Network API. This contains the host and root path used as a starting point for constructing service requests.
Event
An EventResource.
See: event
smart constructor.
Creates a value of Event
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eModifyDate :: Lens' Event (Maybe UTCTime) Source
The date-time this event was last modified as a RFC 3339 date-time value.
eStatus :: Lens' Event (Maybe Text) Source
Status of the event (active|canceled). Only returned for charge and conversion events.
eCommissionableSales :: Lens' Event (Maybe Money) Source
Amount of money exchanged during the transaction. Only returned for charge and conversion events.
eChargeId :: Lens' Event (Maybe Text) Source
The charge ID for this event. Only returned for charge events.
eChargeType :: Lens' Event (Maybe Text) Source
Charge type of the event (other|slotting_fee|monthly_minimum|tier_bonus|debit|credit). Only returned for charge events.
eMemberId :: Lens' Event (Maybe Text) Source
The ID of the member attached to this event. Only returned for conversion events.
eNetworkFee :: Lens' Event (Maybe Money) Source
Fee that the advertiser paid to the Google Affiliate Network.
eEventDate :: Lens' Event (Maybe UTCTime) Source
The date-time this event was initiated as a RFC 3339 date-time value.
eProducts :: Lens' Event [EventProductsItem] Source
Products associated with the event.
eOrderId :: Lens' Event (Maybe Text) Source
The order ID for this event. Only returned for conversion events.
PublishersGetRole
data PublishersGetRole Source
The role of the requester. Valid values: 'advertisers' or 'publishers'.
PGRAdvertisers |
|
PGRPublishers |
|
ReportsGetEventType
data ReportsGetEventType Source
Filters out all events that are not of the given type. Valid values: 'action', 'transaction', or 'charge'. Optional.
Action |
|
Charge |
|
Transaction |
|
ReportsGetStatus
data ReportsGetStatus Source
Filters out all events that do not have the given status. Valid values: 'active', 'canceled', or 'invalid'. Optional.
Active |
|
Canceled |
|
Invalid |
|
LinksListPromotionType
data LinksListPromotionType Source
The promotion type.
Coupon | coupon |
FreeGift | free_gift |
FreeShipping | free_shipping |
PercentOff | percent_off |
PriceCut | price_cut |
EventsListType
data EventsListType Source
Filters out all events that are not of the given type. Valid values: 'action', 'transaction', 'charge'. Optional.
ELTAction |
|
ELTCharge |
|
ELTTransaction |
|
LinksListRole
data LinksListRole Source
The role of the requester. Valid values: 'advertisers' or 'publishers'.
LLRAdvertisers |
|
LLRPublishers |
|
ReportsGetReportType
data ReportsGetReportType Source
The type of report being requested. Valid values: 'order_delta'. Required.
OrderDelta |
|
AdvertisersListRole
data AdvertisersListRole Source
The role of the requester. Valid values: 'advertisers' or 'publishers'.
ALRAdvertisers |
|
ALRPublishers |
|
Money
An ApiMoneyProto.
See: money
smart constructor.
Creates a value of Money
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Link
A LinkResource.
See: link
smart constructor.
Creates a value of Link
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lAdvertiserId :: Lens' Link (Maybe Int64) Source
The advertiser id for the advertiser who owns this link.
lSpecialOffers :: Lens' Link (Maybe LinkSpecialOffers) Source
Special offers on the link.
lEpcSevenDayAverage :: Lens' Link (Maybe Money) Source
The sum of fees paid to publishers divided by the total number of clicks over the past seven days on this link. This value should be multiplied by 100 at the time of display.
lEpcNinetyDayAverage :: Lens' Link (Maybe Money) Source
The sum of fees paid to publishers divided by the total number of clicks over the past three months on this link. This value should be multiplied by 100 at the time of display.
LinksInsertRole
data LinksInsertRole Source
The role of the requester. Valid values: 'advertisers' or 'publishers'.
LIRAdvertisers |
|
LIRPublishers |
|
CcOffers
PublishersListRole
data PublishersListRole Source
The role of the requester. Valid values: 'advertisers' or 'publishers'.
PLRAdvertisers |
|
PLRPublishers |
|
CcOfferDefaultFeesItem
ccOfferDefaultFeesItem :: CcOfferDefaultFeesItem Source
Creates a value of CcOfferDefaultFeesItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
codfiRateType :: Lens' CcOfferDefaultFeesItem (Maybe Text) Source
Fixed or variable.
codfiMinRate :: Lens' CcOfferDefaultFeesItem (Maybe Double) Source
The lowest rate the issuer may charge for defaulting on debt in this category. Expressed as an absolute number, not as a percentage.
codfiCategory :: Lens' CcOfferDefaultFeesItem (Maybe Text) Source
The type of charge, for example Purchases.
codfiMaxRate :: Lens' CcOfferDefaultFeesItem (Maybe Double) Source
The highest rate the issuer may charge for defaulting on debt in this category. Expressed as an absolute number, not as a percentage.
Report
A ReportResource representing a report of a certain type either for an advertiser or publisher.
See: report
smart constructor.
Creates a value of Report
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rTotalsRows :: Lens' Report [[JSONValue]] Source
The totals rows for the report
rStartDate :: Lens' Report (Maybe Text) Source
The start of the date range for this report, inclusive.
rMatchingRowCount :: Lens' Report (Maybe Int64) Source
The number of matching rows before paging is applied.
rColumnNames :: Lens' Report [Text] Source
The column names for the report
LinksListAuthorship
data LinksListAuthorship Source
The role of the author of the link.
LLAAdvertiser | advertiser |
LLAPublisher | publisher |
Advertisers
data Advertisers Source
advertisers :: Advertisers Source
Creates a value of Advertisers
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aNextPageToken :: Lens' Advertisers (Maybe Text) Source
The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
aKind :: Lens' Advertisers Text Source
The kind for a page of advertisers.
aItems :: Lens' Advertisers [Advertiser] Source
The advertiser list.
LinksGetRole
data LinksGetRole Source
The role of the requester. Valid values: 'advertisers' or 'publishers'.
LGRAdvertisers |
|
LGRPublishers |
|
LinksListLinkType
data LinksListLinkType Source
The type of the link.
EventsListRole
data EventsListRole Source
The role of the requester. Valid values: 'advertisers' or 'publishers'.
ELRAdvertisers |
|
ELRPublishers |
|
EventProductsItem
data EventProductsItem Source
eventProductsItem :: EventProductsItem Source
Creates a value of EventProductsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
epiSKUName :: Lens' EventProductsItem (Maybe Text) Source
Sku name of this product.
epiNetworkFee :: Lens' EventProductsItem (Maybe Money) Source
Fee that the advertiser paid to the Google Affiliate Network for this product.
epiQuantity :: Lens' EventProductsItem (Maybe Int64) Source
Quantity of this product bought/exchanged.
epiCategoryName :: Lens' EventProductsItem (Maybe Text) Source
Name of the category this product belongs to.
epiCategoryId :: Lens' EventProductsItem (Maybe Text) Source
Id of the category this product belongs to.
epiPublisherFee :: Lens' EventProductsItem (Maybe Money) Source
Fee that the advertiser paid to the publisehr for this product.
epiUnitPrice :: Lens' EventProductsItem (Maybe Money) Source
Price per unit of this product.
epiEarnings :: Lens' EventProductsItem (Maybe Money) Source
Amount earned by the publisher on this product.
AdvertisersListRelationshipStatus
data AdvertisersListRelationshipStatus Source
Filters out all advertisers for which do not have the given relationship status with the requesting publisher.
Approved |
|
Available |
|
Deactivated |
|
Declined |
|
Pending |
|
CcOffersListProjection
data CcOffersListProjection Source
The set of fields to return.
Full |
|
Summary |
|
CcOfferBonusRewardsItem
ccOfferBonusRewardsItem :: CcOfferBonusRewardsItem Source
Creates a value of CcOfferBonusRewardsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cobriAmount :: Lens' CcOfferBonusRewardsItem (Maybe Double) Source
How many units of reward will be granted.
cobriDetails :: Lens' CcOfferBonusRewardsItem (Maybe Text) Source
The circumstances under which this rule applies, for example, booking a flight via Orbitz.
AdvertisersGetRole
data AdvertisersGetRole Source
The role of the requester. Valid values: 'advertisers' or 'publishers'.
AGRAdvertisers |
|
AGRPublishers |
|
EventsListChargeType
data 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.
Credit |
|
Debit |
|
MonthlyMinimum |
|
Other |
|
SlottingFee |
|
TierBonus |
|
PublishersListRelationshipStatus
data PublishersListRelationshipStatus Source
Filters out all publishers for which do not have the given relationship status with the requesting publisher.
PLRSApproved |
|
PLRSAvailable |
|
PLRSDeactivated |
|
PLRSDeclined |
|
PLRSPending |
|
ReportsGetRole
data ReportsGetRole Source
The role of the requester. Valid values: 'advertisers' or 'publishers'.
RGRAdvertisers |
|
RGRPublishers |
|
Events
Creates a value of Events
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eveNextPageToken :: Lens' Events (Maybe Text) Source
The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
LinkSpecialOffers
data LinkSpecialOffers Source
Special offers on the link.
See: linkSpecialOffers
smart constructor.
linkSpecialOffers :: LinkSpecialOffers Source
Creates a value of LinkSpecialOffers
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsoFreeShippingMin :: Lens' LinkSpecialOffers (Maybe Money) Source
Minimum purchase amount for free shipping promotion
lsoPercentOff :: Lens' LinkSpecialOffers (Maybe Double) Source
Percent off on the purchase
lsoPriceCut :: Lens' LinkSpecialOffers (Maybe Money) Source
Price cut on the purchase
lsoPriceCutMin :: Lens' LinkSpecialOffers (Maybe Money) Source
Minimum purchase amount for price cut promotion
lsoPercentOffMin :: Lens' LinkSpecialOffers (Maybe Money) Source
Minimum purchase amount for percent off promotion
lsoFreeShipping :: Lens' LinkSpecialOffers (Maybe Bool) Source
Whether there is free shipping
lsoPromotionCodes :: Lens' LinkSpecialOffers [Text] Source
List of promotion code associated with the link
lsoFreeGift :: Lens' LinkSpecialOffers (Maybe Bool) Source
Whether there is a free gift
Publishers
data Publishers Source
publishers :: Publishers Source
Creates a value of Publishers
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pNextPageToken :: Lens' Publishers (Maybe Text) Source
The 'pageToken' to pass to the next request to get the next page, if there are more to retrieve.
pKind :: Lens' Publishers Text Source
The kind for a page of entities.
pItems :: Lens' Publishers [Publisher] Source
The entity list.
Advertiser
data Advertiser Source
An AdvertiserResource.
See: advertiser
smart constructor.
advertiser :: Advertiser Source
Creates a value of Advertiser
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
advAllowPublisherCreatedLinks
advContactPhone
advContactEmail
advStatus
advLogoURL
advKind
advCategory
advSiteURL
advPayoutRank
advJoinDate
advDefaultLinkId
advRedirectDomains
advName
advProductFeedsEnabled
advMerchantCenterIds
advEpcSevenDayAverage
advItem
advId
advEpcNinetyDayAverage
advCommissionDuration
advDescription
advAllowPublisherCreatedLinks :: Lens' Advertiser (Maybe Bool) Source
True if the advertiser allows publisher created links, otherwise false.
advContactPhone :: Lens' Advertiser (Maybe Text) Source
Phone that this advertiser would like publishers to contact them with.
advContactEmail :: Lens' Advertiser (Maybe Text) Source
Email that this advertiser would like publishers to contact them with.
advStatus :: Lens' Advertiser (Maybe Text) Source
The status of the requesting publisher's relationship this advertiser.
advLogoURL :: Lens' Advertiser (Maybe Text) Source
URL to the logo this advertiser uses on the Google Affiliate Network.
advKind :: Lens' Advertiser Text Source
The kind for an advertiser.
advCategory :: Lens' Advertiser (Maybe Text) Source
Category that this advertiser belongs to. A valid list of categories can be found here: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107581
advSiteURL :: Lens' Advertiser (Maybe Text) Source
URL of the website this advertiser advertises from.
advPayoutRank :: Lens' Advertiser (Maybe Text) Source
A rank based on commissions paid to publishers over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
advJoinDate :: Lens' Advertiser (Maybe UTCTime) Source
Date that this advertiser was approved as a Google Affiliate Network advertiser.
advDefaultLinkId :: Lens' Advertiser (Maybe Int64) Source
The default link id for this advertiser.
advRedirectDomains :: Lens' Advertiser [Text] Source
List of redirect URLs for this advertiser
advProductFeedsEnabled :: Lens' Advertiser (Maybe Bool) Source
Allows advertisers to submit product listings to Google Product Search.
advMerchantCenterIds :: Lens' Advertiser [Int64] Source
List of merchant center ids for this advertiser
advEpcSevenDayAverage :: Lens' Advertiser (Maybe Money) Source
The sum of fees paid to publishers divided by the total number of clicks over the past seven days. This value should be multiplied by 100 at the time of display.
advItem :: Lens' Advertiser (Maybe Advertiser) Source
The requested advertiser.
advEpcNinetyDayAverage :: Lens' Advertiser (Maybe Money) Source
The sum of fees paid to publishers divided by the total number of clicks over the past three months. This value should be multiplied by 100 at the time of display.
advCommissionDuration :: Lens' Advertiser (Maybe Int32) Source
The longest possible length of a commission (how long the cookies on the customer's browser last before they expire).
advDescription :: Lens' Advertiser (Maybe Text) Source
Description of the website the advertiser advertises from.
CcOffer
A credit card offer. There are many possible result fields. We provide two different views of the data, or "projections." The "full" projection includes every result field. And the "summary" projection, which is the default, includes a smaller subset of the fields. The fields included in the summary projection are marked as such in their descriptions.
See: ccOffer
smart constructor.
Creates a value of CcOffer
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cMinimumFinanceCharge
cTrackingURL
cProhibitedCategories
cBalanceComputationMethod
cInitialSetupAndProcessingFee
cReturnedPaymentFee
cAgeMinimumDetails
cVariableRatesUpdateFrequency
cCreditLimitMin
cTravelInsurance
cApprovedCategories
cAnnualFeeDisplay
cOverLimitFee
cMaxPurchaseRate
cAgeMinimum
cVariableRatesLastUpdated
cIntroCashAdvanceTerms
cIssuerWebsite
cLuggageInsurance
cKind
cRewardsHaveBlackoutDates
cDisclaimer
cAdditionalCardHolderFee
cExistingCustomerOnly
cEmergencyInsurance
cNetwork
cCashAdvanceTerms
cStatementCopyFee
cAprDisplay
cOffersImmediateCashReward
cRewards
cCardType
cImageURL
cCreditLimitMax
cLandingPageURL
cAnnualFee
cRewardsExpire
cFirstYearAnnualFee
cCarRentalInsurance
cPurchaseRateAdditionalDetails
cOfferId
cGracePeriodDisplay
cIntroPurchaseTerms
cCreditRatingDisplay
cBalanceTransferTerms
cLatePaymentFee
cCardBenefits
cIssuer
cCardName
cMinPurchaseRate
cFraudLiability
cForeignCurrencyTransactionFee
cExtendedWarranty
cAnnualRewardMaximum
cIssuerId
cIntroBalanceTransferTerms
cDefaultFees
cAdditionalCardBenefits
cRewardUnit
cBonusRewards
cFlightAccidentInsurance
cRewardPartner
cPurchaseRateType
cMinimumFinanceCharge :: Lens' CcOffer (Maybe Text) Source
Text describing how much missing the grace period will cost.
cTrackingURL :: Lens' CcOffer (Maybe Text) Source
The link to ping to register a click on this offer. A summary field.
cProhibitedCategories :: Lens' CcOffer [Text] Source
Categories in which the issuer does not wish the card to be displayed. A summary field.
cBalanceComputationMethod :: Lens' CcOffer (Maybe Text) Source
Text describing how the balance is computed. A summary field.
cReturnedPaymentFee :: Lens' CcOffer (Maybe Text) Source
Text describing the fee for a payment that doesn't clear. A summary field.
cAgeMinimumDetails :: Lens' CcOffer (Maybe Text) Source
Text describing the details of the age minimum restriction.
cVariableRatesUpdateFrequency :: Lens' CcOffer (Maybe Text) Source
How often variable rates are updated.
cCreditLimitMin :: Lens' CcOffer (Maybe Double) Source
The low end for credit limits the issuer imposes on recipients of this card.
cTravelInsurance :: Lens' CcOffer (Maybe Text) Source
If you get coverage when you use the card for the given activity, this field describes it.
cApprovedCategories :: Lens' CcOffer [Text] Source
Possible categories for this card, eg "Low Interest" or "Good." A summary field.
cAnnualFeeDisplay :: Lens' CcOffer (Maybe Text) Source
Text describing the annual fee, including any difference for the first year. A summary field.
cMaxPurchaseRate :: Lens' CcOffer (Maybe Double) Source
The highest interest rate the issuer charges on this card. Expressed as an absolute number, not as a percentage.
cVariableRatesLastUpdated :: Lens' CcOffer (Maybe Text) Source
When variable rates were last updated.
cIntroCashAdvanceTerms :: Lens' CcOffer (Maybe Text) Source
Text describing the terms for introductory period cash advances. A summary field.
cLuggageInsurance :: Lens' CcOffer (Maybe Text) Source
If you get coverage when you use the card for the given activity, this field describes it.
cRewardsHaveBlackoutDates :: Lens' CcOffer (Maybe Bool) Source
For airline miles rewards, tells whether blackout dates apply to the miles.
cDisclaimer :: Lens' CcOffer (Maybe Text) Source
A notice that, if present, is referenced via an asterisk by many of the other summary fields. If this field is present, it will always start with an asterisk ("*"), and must be prominently displayed with the offer. A summary field.
cExistingCustomerOnly :: Lens' CcOffer (Maybe Bool) Source
Whether this card is only available to existing customers of the issuer.
cEmergencyInsurance :: Lens' CcOffer (Maybe Text) Source
If you get coverage when you use the card for the given activity, this field describes it.
cNetwork :: Lens' CcOffer (Maybe Text) Source
Which network (eg Visa) the card belongs to. A summary field.
cCashAdvanceTerms :: Lens' CcOffer (Maybe Text) Source
Text describing the terms for cash advances. A summary field.
cOffersImmediateCashReward :: Lens' CcOffer (Maybe Bool) Source
Whether a cash reward program lets you get cash back sooner than end of year or other longish period.
cRewards :: Lens' CcOffer [CcOfferRewardsItem] Source
For cards with rewards programs, detailed rules about how the program works.
cCardType :: Lens' CcOffer (Maybe Text) Source
What kind of credit card this is, for example secured or unsecured.
cImageURL :: Lens' CcOffer (Maybe Text) Source
The link to the image of the card that is shown on Connect Commerce. A summary field.
cCreditLimitMax :: Lens' CcOffer (Maybe Double) Source
The high end for credit limits the issuer imposes on recipients of this card.
cLandingPageURL :: Lens' CcOffer (Maybe Text) Source
The link to the issuer's page for this card. A summary field.
cFirstYearAnnualFee :: Lens' CcOffer (Maybe Double) Source
The annual fee for the first year, if different from the ongoing fee. Optional.
cCarRentalInsurance :: Lens' CcOffer (Maybe Text) Source
If you get coverage when you use the card for the given activity, this field describes it.
cPurchaseRateAdditionalDetails :: Lens' CcOffer (Maybe Text) Source
Text describing any additional details for the purchase rate. A summary field.
cGracePeriodDisplay :: Lens' CcOffer (Maybe Text) Source
Text describing the grace period before finance charges apply. A summary field.
cIntroPurchaseTerms :: Lens' CcOffer (Maybe Text) Source
Text describing the terms for introductory period purchases. A summary field.
cCreditRatingDisplay :: Lens' CcOffer (Maybe Text) Source
Text describing the credit ratings required for recipients of this card, for example "Excellent/Good." A summary field.
cBalanceTransferTerms :: Lens' CcOffer (Maybe Text) Source
Text describing the terms for balance transfers. A summary field.
cLatePaymentFee :: Lens' CcOffer (Maybe Text) Source
Text describing how much a late payment will cost, eg "up to $35." A summary field.
cCardBenefits :: Lens' CcOffer [Text] Source
A list of what the issuer thinks are the most important benefits of the card. Usually summarizes the rewards program, if there is one. A summary field.
cCardName :: Lens' CcOffer (Maybe Text) Source
The issuer's name for the card, including any trademark or service mark designators. A summary field.
cMinPurchaseRate :: Lens' CcOffer (Maybe Double) Source
The lowest interest rate the issuer charges on this card. Expressed as an absolute number, not as a percentage.
cFraudLiability :: Lens' CcOffer (Maybe Text) Source
If you get coverage when you use the card for the given activity, this field describes it.
cForeignCurrencyTransactionFee :: Lens' CcOffer (Maybe Text) Source
Fee for each transaction involving a foreign currency.
cExtendedWarranty :: Lens' CcOffer (Maybe Text) Source
If you get coverage when you use the card for the given activity, this field describes it.
cAnnualRewardMaximum :: Lens' CcOffer (Maybe Double) Source
The largest number of units you may accumulate in a year.
cIssuerId :: Lens' CcOffer (Maybe Text) Source
The Google Affiliate Network ID of the advertiser making this offer.
cIntroBalanceTransferTerms :: Lens' CcOffer (Maybe Text) Source
Text describing the terms for introductory period balance transfers. A summary field.
cDefaultFees :: Lens' CcOffer [CcOfferDefaultFeesItem] Source
Fees for defaulting on your payments.
cAdditionalCardBenefits :: Lens' CcOffer [Text] Source
More marketing copy about the card's benefits. A summary field.
cRewardUnit :: Lens' CcOffer (Maybe Text) Source
For cards with rewards programs, the unit of reward. For example, miles, cash back, points.
cBonusRewards :: Lens' CcOffer [CcOfferBonusRewardsItem] Source
For cards with rewards programs, extra circumstances whereby additional rewards may be granted.
cFlightAccidentInsurance :: Lens' CcOffer (Maybe Text) Source
If you get coverage when you use the card for the given activity, this field describes it.
cRewardPartner :: Lens' CcOffer (Maybe Text) Source
The company that redeems the rewards, if different from the issuer.
Links
Creates a value of Links
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Publisher
A PublisherResource.
See: publisher
smart constructor.
Creates a value of Publisher
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pubStatus :: Lens' Publisher (Maybe Text) Source
The status of the requesting advertiser's relationship with this publisher.
pubPayoutRank :: Lens' Publisher (Maybe Text) Source
A rank based on commissions paid to this publisher over the past 90 days. A number between 1 and 4 where 4 means the top quartile (most money paid) and 1 means the bottom quartile (least money paid).
pubJoinDate :: Lens' Publisher (Maybe UTCTime) Source
Date that this publisher was approved as a Google Affiliate Network publisher.
pubClassification :: Lens' Publisher (Maybe Text) Source
Classification that this publisher belongs to. See this link for all publisher classifications: http://www.google.com/support/affiliatenetwork/advertiser/bin/answer.py?hl=en&answer=107625&ctx=cb&src=cb&cbid=-k5fihzthfaik&cbrank=4
pubEpcSevenDayAverage :: Lens' Publisher (Maybe Money) Source
The sum of fees paid to this publisher divided by the total number of clicks over the past seven days. Values are multiplied by 100 for display purposes.
pubEpcNinetyDayAverage :: Lens' Publisher (Maybe Money) Source
The sum of fees paid to this publisher divided by the total number of clicks over the past three months. Values are multiplied by 100 for display purposes.
CcOfferRewardsItem
data CcOfferRewardsItem Source
ccOfferRewardsItem :: CcOfferRewardsItem Source
Creates a value of CcOfferRewardsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
coriAmount :: Lens' CcOfferRewardsItem (Maybe Double) Source
The number of units rewarded per purchase dollar.
coriExpirationMonths :: Lens' CcOfferRewardsItem (Maybe Double) Source
How long rewards granted by this rule last.
coriCategory :: Lens' CcOfferRewardsItem (Maybe Text) Source
The kind of purchases covered by this rule.
coriAdditionalDetails :: Lens' CcOfferRewardsItem (Maybe Text) Source
Other limits, for example, if this rule only applies during an introductory period.
coriMaxRewardTier :: Lens' CcOfferRewardsItem (Maybe Double) Source
The maximum purchase amount in the given category for this rule to apply.
coriMinRewardTier :: Lens' CcOfferRewardsItem (Maybe Double) Source
The minimum purchase amount in the given category before this rule applies.
LinksListRelationshipStatus
data LinksListRelationshipStatus Source
The status of the relationship.
LLRSApproved | approved |
LLRSAvailable | available |
EventsListStatus
data EventsListStatus Source
Filters out all events that do not have the given status. Valid values: 'active', 'canceled'. Optional.
ELSActive |
|
ELSCanceled |
|