Skip to main content

Roku

Introduction​

The Roku source connector syncs data from the Roku Ads API, including account metadata, campaign structure, and reporting (performance and conversions).

Setup​

Prerequisites​

  • Access to Roku Ads with permission to view reporting for the ad account you want to sync.
  • A Roku Ads API application (client credentials) and an authorized refresh token.

Create Roku API credentials​

In Roku Ads / developer settings:

  1. Create (or use an existing) Roku Ads API application to obtain:
    • Client ID
    • Client Secret
  2. Complete the OAuth authorization flow to obtain a Refresh token.

Configure the source in your workspace​

When adding the Roku source, you will:

  1. Sign in to Roku (OAuth) to authorize access.
  2. Select the Roku Ad Account to sync.

Authentication​

This connector uses OAuth 2.0 with a refresh token. After you sign in, the connector stores the refresh token and uses it to fetch short-lived access tokens during syncs.

Configuration​

FieldTypeRequiredDescription
client_idstring✓Roku Ads API client ID.
client_secretstring✓Roku Ads API client secret.
account_uidstring✓The Roku Ad Account UID to sync. This is selected from a list during setup.
backfillintegerNumber of days to backfill when syncing reporting streams. Defaults to 14.

Data model notes​

Reporting timezone​

Roku reporting is generated in the reporting timezone configured on the selected ad account. If the selected account does not have a reporting timezone configured in Roku Ads Manager, the connector cannot run reporting streams.

Reporting windows and incremental behavior​

Reporting streams are synced incrementally by date. On each run, the connector requests data for a rolling window ending at “today” in the account’s reporting timezone, and going back backfill days.

Streams​

The connector syncs the following streams:

Entity streams​

  • accounts
    Ad account metadata.

  • organizations
    Organization metadata associated with the authenticated user/account access.

  • campaigns
    Campaign objects for the selected ad account.

  • ad_groups
    Ad group objects for the selected ad account.

Reporting streams​

  • performance_report
    Performance metrics by a set of Roku reporting dimensions (for example: account, campaign, ad group, date, geo, placement, and time breakdowns where available).

  • conversion_report
    Conversion metrics by the same general reporting dimensions, with conversion activity breakdowns where provided by Roku.

Limitations​

  • The connector runs streams with a maximum concurrency of 1 to align with Roku report generation and download behavior.
  • Reporting availability and dimension/metric completeness depend on what Roku returns for your account and date range.