Jump to Content
Publisher Integrations
GuidesAPI ReferenceChangelog
v2.0

ProductsPublisher Integrations
API Reference
Products
v2.0GuidesAPI ReferenceChangelog

publisher v2.0 api

  • REST APIs
    • Authentication
      • Starts a Session by Obtaining a Session Token
    • Ads
      • Get Ads
    • Customer
      • Get Customer Profile
      • Get customer ad redemptions
      • Get customer rewards summary
    • Data
      • Create customers
      • Create customer events
      • Create customer transactions
      • Update accounts
      • Update Customers
      • Update cards
    • Events
      • Create customer event
    • Customer Service App (CSA)

Objects

  • Types
    • Account
    • Ad
    • AdRankings
    • AdAssetList
    • AdImage
    • AdImageUrl
    • AdImageValue
    • AdText
    • AdTextValue
    • AdCallsToAction
    • AdRestriction
    • AdReward
    • Beacons
    • Card
    • CategoryGroup
    • ClientEventMessage
    • ClientEventMetadata
    • Collection
    • CollectionMetadata
    • Customer
    • Geocoordinates
    • MerchantLocation
    • Offer
    • Portfolio
    • PortfolioEnrollment
    • Program
    • Purchase Requirements
    • Redemption
    • RewardSummary
    • RewardSummaryTotals
    • SessionToken
    • StoreLocationAddress
    • StoreLocation
    • Ticket
    • TransactionRedemption
    • TransactionNotification
    • UpdateAdStatesErrorResponses
    • UpdateAdStatesRequestParameters
    • UpdateCustomerParameters
  • Enumerations
    • ActivationModel
    • AdActivationState
    • AdDisplayRestrictionType
    • AdRedemptionState
    • AdRewardType
    • AdType
    • AssetType
    • AdVisibilityState
    • AlertOptInStatus
    • CallToActionLinkType
    • CardPresentIndicator
    • CardStatus
    • CardType
    • Channel
    • ClientEvent
    • ClientEventType
    • CustomerAccountUpdateType
    • CustomerStatus
    • CustomerTargetingIndicator
    • DisplayType
    • EnrollmentOptInStatus
    • EventType
    • FIAccountStatus
    • FIAccountType
    • GroupType
    • IncludeExpiredAds
    • IssueType
    • OfferStatus
    • Online-Indicator
    • PaymentNetworkMerchantId
    • PaymentType
    • PurchaseChannel
    • RealTimeMessagingEventType
    • RedemptionStatus
    • ResolutionType
    • RewardCurrencyUnit
    • Section
    • TicketIdType
    • TicketStatus
    • TransactionType

AdCallsToAction

PropertyTypeDescription
typeAssetType.CALL_TO_ACTION_LINKSAsset type of "CALL_TO_ACTION_LINKS"
valueMap<CallToActionType, CallToActionLink>A Map of CallToActionLinks, keyed by CallToActionType

Example

{
    "type": "CALL_TO_ACTION_LINKS",
    "value": {
        "buyNow": {
            "type": "WEB_LINK",
            "value": "https://www.example.com/shopping?productId=4"
        }
    }
}
  • Table of Contents
    • Example