Databricks SDK for JavaScript
    Preparing search index...

    Interface TikTokAdsOptions_TikTokAdsCustomReportOptions

    User-defined custom report for the TikTok Ads connector. Groups the dimensions + metrics + report type + data level that define a TikTok Ads custom report request.

    interface TikTokAdsOptions_TikTokAdsCustomReportOptions {
        dataLevel?: TikTokAdsOptions_TikTokDataLevel;
        dimensions?: string[];
        metrics?: string[];
        queryLifetime?: boolean;
        reportType?: TikTokAdsOptions_TikTokReportType;
    }
    Index

    Properties

    dataLevel? dimensions? metrics? queryLifetime? reportType?

    Properties

    dataLevel?: TikTokAdsOptions_TikTokDataLevel

    (Optional) Data level for the report. If not specified, defaults to AUCTION_CAMPAIGN.

    dimensions?: string[]

    (Optional) Dimensions to include in the report (e.g. "campaign_id", "adgroup_id", "ad_id", "stat_time_day", "stat_time_hour").

    metrics?: string[]

    (Optional) Metrics to include in the report (e.g. "spend", "impressions", "clicks", "conversion", "cpc").

    queryLifetime?: boolean

    (Optional) Whether to request lifetime metrics (all-time aggregated data). When true, the report returns all-time data. If not specified, defaults to false.

    reportType?: TikTokAdsOptions_TikTokReportType

    (Optional) Report type for the TikTok Ads API. If not specified, defaults to BASIC.

    Settings

    Member Visibility

    On This Page

    Properties