What is Retail Media

Retail Media is a provider-based ad integration that injects sponsored media into Storyly experiences.

Implementation

Retail Media feature is designed to fetch and render retail media creatives by only setting a STRRetailMediaConfig.

STRRetailMediaConfig is the sealed base type for all retail media providers. Each concrete STRRetailMediaConfig implementation represents one provider integration.

Provider	Config Type
RetailMediaTools	`STRRetailMediaToolsConfig`

Initialize STRRetailMediaConfig for RetailMediaTools

You need to set STRRetailMediaToolsConfig to use RetailMediaTools as the retail media provider.

let retailMediaConfig = STRRetailMediaToolsConfig.Builder()
    .setShopperKey(shopperKey: "shopper-key")
    .setSessionKey(sessionKey: "session-key")
    .build(
        placementId: "group-placement-id",
        storyPlacementId: "story-placement-id",
        storeKey: "store-key",
        accessToken: "access-token"
    )

let storylyConfig = StorylyConfig.Builder()
    .setRetailMediaConfig(config: retailMediaConfig)
    .build()

`STRRetailMediaToolsConfig` Fields

Field	Type	Information
`placementId`	`String`	Required group placement identifier for ad-set requests.
`storyPlacementId`	`String`	Required story placement identifier for story ad-set requests.
`storeKey`	`String`	Required store identifier sent to the provider.
`accessToken`	`String`	Required access token used for authorization in media fetch requests.
`url`	`String`	Media endpoint. Default: `https://api.eu.retailmediatools.com/v1/ad-set`.
`analyticsUrl`	`String`	Analytics endpoint. Default: `https://api.eu.retailmediatools.com/v1/track`.
`shopperKey`	`String?`	Optional shopper identifier for targeting/personalization.
`sessionKey`	`String?`	Optional session identifier for request/session continuity.

What is Retail Media

Implementation

Initialize STRRetailMediaConfig for RetailMediaTools

STRRetailMediaToolsConfig Fields

`STRRetailMediaToolsConfig` Fields