Databricks SDK for JavaScript
    Preparing search index...

    Interface TikTokAdsOptions

    TikTok Ads specific options for ingestion

    interface TikTokAdsOptions {
        customReportOptions?: TikTokAdsOptions_TikTokAdsCustomReportOptions;
        dataLevel?: TikTokAdsOptions_TikTokDataLevel;
        dimensions?: string[];
        lookbackWindowDays?: number;
        metrics?: string[];
        queryLifetime?: boolean;
        reportType?: TikTokAdsOptions_TikTokReportType;
        syncStartDate?: string;
    }
    Index

    Properties

    customReportOptions? dataLevel? dimensions? lookbackWindowDays? metrics? queryLifetime? reportType? syncStartDate?

    Properties

    customReportOptions?: TikTokAdsOptions_TikTokAdsCustomReportOptions

    (Optional) Custom report definition. When set, the table is treated as a user-defined TikTok Ads custom report: the connector synthesizes a report request from the dimensions, metrics, report type, and data level specified here. Supersedes the deprecated top-level dimensions/metrics/report_type/ data_level/query_lifetime fields above.

    dataLevel?: TikTokAdsOptions_TikTokDataLevel

    Deprecated. Use custom_report_options.data_level instead.

    dimensions?: string[]

    Deprecated. Use custom_report_options.dimensions instead.

    lookbackWindowDays?: number

    (Optional) Number of days to look back for report tables during incremental sync to capture late-arriving conversions and attribution data.

    metrics?: string[]

    Deprecated. Use custom_report_options.metrics instead.

    queryLifetime?: boolean

    Deprecated. Use custom_report_options.query_lifetime instead.

    reportType?: TikTokAdsOptions_TikTokReportType

    Deprecated. Use custom_report_options.report_type instead.

    syncStartDate?: string

    (Optional) Start date for the initial sync of report tables in YYYY-MM-DD format. This determines the earliest date from which to sync historical data.

    Settings

    Member Visibility

    On This Page

    Properties