Aller au contenu

FrakSDK

Ce contenu n’est pas encore disponible dans votre langue.

NameSummary
AppLinkAPIInbound referral links and the wallet app handoff.
AttributionDefaultsDefault attribution parameters applied to a share link when the caller omits them.
AttributionParamsAttribution parameters to hang off a share link, overriding the merchant’s defaults.
BannerConfigCopy for the referral banner, in both the referral and in-app contexts.
BestRewardThe single reward worth advertising, selected and formatted by the server, so every surface shows an identical number.
ButtonShareConfigCopy for the share button.
ButtonWalletConfigCopy for the wallet button.
CampaignOne active campaign, as returned by GET /user/merchant/estimated-rewards.
ConfigAPIConfig resolution.
DeepLinkHandling
EstimatedRewardWhat a campaign pays out.
FrakEntry point.
FrakClientEverything the SDK can do.
FrakConfigEverything the SDK needs to start, supplied once to Frak.initialize(_:).
FrakContextWho a share link came from, as carried in its fCtx query parameter.
FrakCurrency
FrakEnvironment
FrakErrorEvery failure the SDK can hand back.
FrakLanguage
FrakLogLevel
FrakLogSink
FrakMetadataStatic merchant-supplied facts about the app, fixed at build time.
FrakResolvedConfigWhat the backend knows about this merchant, as resolved by GET /user/merchant/resolve.
Interaction
OpenAppResult
OpenInAppConfigCopy for the “open in app” prompt.
PercentEncoding
PostPurchaseConfigCopy shown after a purchase, for both the referee and referrer.
ProductDetailsThe purchase line-item fields a campaign’s productScope can target.
ResolvedComponentsMerchant-configured copy for each SDK-rendered component.
ResolvedPlacementCopy and component overrides scoped to one placement, such as a product page.
ResolvedSdkConfigThe sdkConfig block of a resolve response: merchant-configured copy overrides, translations, per-placement components and attribution defaults.
RewardAudienceWho a reward is estimated for: the sharer (.referrer) or the person arriving through the link (.referee).
RewardRequestWhat to look a reward up for.
RewardsAPICampaigns and reward selection.
RewardTierOne band of a tiered reward.
SharingAPIShare link construction.
SharingProductOne product card on the sharing page.
SharingRequestWhat to share, and how to attribute it.
TokenAmountA reward amount in raw token units and in each fiat currency the backend prices.
TrackingAPIInteraction and purchase tracking.