Skip to content
adscapi
← Platforms
Real Conversions API

Roku setup

Set Roku’s tokens once. Then every ads.conversions.track() call fans the event out to Roku server-side — no per-platform code.

1. Install adscapi

shell
npm install adscapi
# or run without installing:
npx adscapi platforms

2. Get Roku's tokens

Roku activates once all of these are set. Run npx adscapi platforms to see them, then get each value from Roku’s ads or events dashboard.

ROKU_ADS_TOKENROKU_EVENT_GROUP_ID

3. Set them for adscapi

Export the tokens in the environment that runs your server or the adscapi CLI.

shell
export ROKU_ADS_TOKEN="…"
export ROKU_EVENT_GROUP_ID="…"

4. Verify

check confirms the secrets are present; verify calls Roku’s API to confirm they are valid.

shell
npx adscapi check
npx adscapi verify --platform roku

5. Track a conversion

One call, sent to Roku and every other configured platform. Pass raw email — adscapi hashes per platform. Consent is required.

ts
import { createAdscapi } from 'adscapi';

const ads = createAdscapi();

const results = await ads.conversions.track({
  name: 'purchase',
  value: 49,
  currency: 'USD',
  user: { email: 'buyer@example.com' },
  consent: { adUserData: true, adPersonalization: true },
});

See the exact request on the Roku payload preview.