Skip to main content

Interface: StoryAdDetail

Defined in: clients/adServer/types.ts:115

Story ad from the ad server response. One item per carousel card.

Properties​

ad_id​

ad_id: string

Defined in: clients/adServer/types.ts:117


asset_type​

asset_type: "video"

Defined in: clients/adServer/types.ts:125


call_to_action?​

optional call_to_action: null | string

Defined in: clients/adServer/types.ts:150

Text of the call to action button, set in the campaign. Only when the destination is a link.


campaign_id​

campaign_id: string

Defined in: clients/adServer/types.ts:118


campaign_name​

campaign_name: string

Defined in: clients/adServer/types.ts:124


click_url​

click_url: string

Defined in: clients/adServer/types.ts:153


destination_url​

destination_url: string

Defined in: clients/adServer/types.ts:141

Advertiser link when the destination is a link, product page otherwise.


duration_seconds​

duration_seconds: number

Defined in: clients/adServer/types.ts:137

Video duration in whole seconds, read from the stored file.


impression_url​

impression_url: string

Defined in: clients/adServer/types.ts:151


media_url​

media_url: string

Defined in: clients/adServer/types.ts:129

9:16 MP4 (1080 × 1920) that the player plays.


position​

position: number

Defined in: clients/adServer/types.ts:123

Position of the card in the carousel.


poster_url​

poster_url: string

Defined in: clients/adServer/types.ts:133

JPG cover shown before the video starts.


product​

product: null | StoryProduct

Defined in: clients/adServer/types.ts:145

Featured product, or null when the destination is a link.


seller_id?​

optional seller_id: string

Defined in: clients/adServer/types.ts:119


type​

type: "story"

Defined in: clients/adServer/types.ts:116


view_url​

view_url: string

Defined in: clients/adServer/types.ts:152