Référence du connecteur TikTok Ads

info

Bêta

Cette fonctionnalité est en Bêta. Les administrateurs du Workspace peuvent contrôler l'accès à cette fonctionnalité à partir de la page Previews . Consultez Gérer les aperçus Databricks.

Cet article fournit des informations de référence pour le connecteur TikTok Ads, y compris les tables, dimensions et métriques prises en charge.

Tables sources prises en charge

Le connecteur TikTok Ads prend en charge les tables sources suivantes :

Tables prenant en charge les mises à jour incrémentielles

Les tables de rapports préconstruites suivantes prennent en charge l'ingestion incrémentielle :

campaign_report_daily
campaign_report_hourly
adgroup_report_daily
adgroup_report_hourly
ad_report_daily
ad_report_hourly
campaign_age_gender_report
campaign_country_report
campaign_language_report
campaign_platform_report
ad_age_gender_report
ad_country_report
ad_language_report
ad_platform_report
custom_report

Tables qui prennent en charge uniquement les mises à jour par batch (non incrémentielles)

Les tables suivantes sont actualisées à chaque mise à jour du pipeline :

campaign
adgroup
ad
campaign_report_lifetime
adgroup_report_lifetime
ad_report_lifetime

Rapports prédéfinis

Les rapports prédéfinis sont des query de rapport préconfigurées avec des dimensions et des métriques fixes pour les besoins de reporting courants.

Rapport (`source_table`)	Dimensions	Niveau de données	Type de rapport
`campaign_report_daily`	`campaign_id`, `stat_time_day`	`CAMPAIGN`	`BASIC`
`campaign_report_hourly`	`campaign_id`, `stat_time_hour`	`CAMPAIGN`	`BASIC`
`campaign_report_lifetime`	`campaign_id`	`CAMPAIGN`	`BASIC`
`adgroup_report_daily`	`adgroup_id`, `stat_time_day`	`ADGROUP`	`BASIC`
`adgroup_report_hourly`	`adgroup_id`, `stat_time_hour`	`ADGROUP`	`BASIC`
`adgroup_report_lifetime`	`adgroup_id`	`ADGROUP`	`BASIC`
`ad_report_daily`	`ad_id`, `stat_time_day`	`AD`	`BASIC`
`ad_report_hourly`	`ad_id`, `stat_time_hour`	`AD`	`BASIC`
`ad_report_lifetime`	`ad_id`	`AD`	`BASIC`
`campaign_age_gender_report`	`campaign_id`, `stat_time_day`, `age`, `gender`	`CAMPAIGN`	`AUDIENCE`
`campaign_country_report`	`campaign_id`, `stat_time_day`, `country_code`	`CAMPAIGN`	`AUDIENCE`
`campaign_language_report`	`campaign_id`, `stat_time_day`, `language`	`CAMPAIGN`	`AUDIENCE`
`campaign_platform_report`	`campaign_id`, `stat_time_day`, `platform`	`CAMPAIGN`	`AUDIENCE`
`ad_age_gender_report`	`ad_id`, `stat_time_day`, `age`, `gender`	`AD`	`AUDIENCE`
`ad_country_report`	`ad_id`, `stat_time_day`, `country_code`	`AD`	`AUDIENCE`
`ad_language_report`	`ad_id`, `stat_time_day`, `language`	`AD`	`AUDIENCE`
`ad_platform_report`	`ad_id`, `stat_time_day`, `platform`	`AD`	`AUDIENCE`

Rapport (`source_table`)	Dimensions	Niveau de données	Type de rapport
`campaign_report_daily`	`campaign_id`, `stat_time_day`	`CAMPAIGN`	`BASIC`
`campaign_report_hourly`	`campaign_id`, `stat_time_hour`	`CAMPAIGN`	`BASIC`
`campaign_report_lifetime`	`campaign_id`	`CAMPAIGN`	`BASIC`
`adgroup_report_daily`	`adgroup_id`, `stat_time_day`	`ADGROUP`	`BASIC`
`adgroup_report_hourly`	`adgroup_id`, `stat_time_hour`	`ADGROUP`	`BASIC`
`adgroup_report_lifetime`	`adgroup_id`	`ADGROUP`	`BASIC`
`ad_report_daily`	`ad_id`, `stat_time_day`	`AD`	`BASIC`
`ad_report_hourly`	`ad_id`, `stat_time_hour`	`AD`	`BASIC`
`ad_report_lifetime`	`ad_id`	`AD`	`BASIC`
`campaign_age_gender_report`	`campaign_id`, `stat_time_day`, `age`, `gender`	`CAMPAIGN`	`AUDIENCE`
`campaign_country_report`	`campaign_id`, `stat_time_day`, `country_code`	`CAMPAIGN`	`AUDIENCE`
`campaign_language_report`	`campaign_id`, `stat_time_day`, `language`	`CAMPAIGN`	`AUDIENCE`
`campaign_platform_report`	`campaign_id`, `stat_time_day`, `platform`	`CAMPAIGN`	`AUDIENCE`
`ad_age_gender_report`	`ad_id`, `stat_time_day`, `age`, `gender`	`AD`	`AUDIENCE`
`ad_country_report`	`ad_id`, `stat_time_day`, `country_code`	`AD`	`AUDIENCE`
`ad_language_report`	`ad_id`, `stat_time_day`, `language`	`AD`	`AUDIENCE`
`ad_platform_report`	`ad_id`, `stat_time_day`, `platform`	`AD`	`AUDIENCE`

Groupes de métriques

Les métriques renvoyées pour chaque rapport prédéfini dépendent de son type de rapport.

Les rapports BASIC renvoient les métriques suivantes :

Groupe	Métriques
Performances de base	`spend`, `impressions`, `clicks`, `cpc`, `cpm`, `ctr`, `reach`, `cost_per_1000_reached`, `frequency`
Lecture vidéo	`video_play_actions`, `video_watched_2s`, `video_watched_6s`, `video_views_p25`, `video_views_p50`, `video_views_p75`, `video_views_p100`, `average_video_play`, `average_video_play_per_user`
Engagement	`likes`, `comments`, `shares`, `follows`, `profile_visits`
attribution	`conversion`, `cost_per_conversion`, `conversion_rate`, `real_time_conversion`, `real_time_cost_per_conversion`, `real_time_conversion_rate`
Événements dans l'application	`app_install`, `cost_per_app_install`, `registration`, `purchase`, `cost_per_purchase`

Groupe	Métriques
Performances de base	`spend`, `impressions`, `clicks`, `cpc`, `cpm`, `ctr`, `reach`, `cost_per_1000_reached`, `frequency`
Lecture vidéo	`video_play_actions`, `video_watched_2s`, `video_watched_6s`, `video_views_p25`, `video_views_p50`, `video_views_p75`, `video_views_p100`, `average_video_play`, `average_video_play_per_user`
Engagement	`likes`, `comments`, `shares`, `follows`, `profile_visits`
attribution	`conversion`, `cost_per_conversion`, `conversion_rate`, `real_time_conversion`, `real_time_cost_per_conversion`, `real_time_conversion_rate`
Événements dans l'application	`app_install`, `cost_per_app_install`, `registration`, `purchase`, `cost_per_purchase`

Les rapports AUDIENCE renvoient les métriques suivantes :

Groupe	Métriques
Performances de base	`spend`, `impressions`, `clicks`, `cpm`, `cpc`, `ctr`, `conversion`, `cost_per_conversion`, `conversion_rate`, `result`, `result_rate`, `cost_per_result`, `reach`, `frequency`
Événements de page	`total_landing_page_view`, `cost_per_landing_page_view`, `landing_page_view_rate`

Groupe	Métriques
Performances de base	`spend`, `impressions`, `clicks`, `cpm`, `cpc`, `ctr`, `conversion`, `cost_per_conversion`, `conversion_rate`, `result`, `result_rate`, `cost_per_result`, `reach`, `frequency`
Événements de page	`total_landing_page_view`, `cost_per_landing_page_view`, `landing_page_view_rate`

Rapports personnalisés

En plus des rapports prédéfinis, vous pouvez créer des rapports personnalisés en définissant source_table sur custom_report dans les spécifications de votre pipeline et en fournissant custom_report_options sous connector_options.tiktok_ads_options.

JSON
{
  "table": {
    "source_schema": "<your-ad-account-id>",
    "source_table": "custom_report",
    "destination_catalog": "<destination-catalog>",
    "destination_schema": "<destination-schema>",
    "destination_table": "<your-report-name>",
    "connector_options": {
      "tiktok_ads_options": {
        "lookback_window_days": 7,
        "sync_start_date": "<YYYY-MM-DD>",
        "custom_report_options": {
          "dimensions": ["stat_time_day", "ad_id"],
          "metrics": ["spend", "impressions", "clicks"],
          "report_type": "BASIC",
          "data_level": "AUCTION_AD",
          "query_lifetime": false
        }
      }
    }
  }
}

`custom_report_options` champs

Champ	Description
`dimensions`	Liste des dimensions à inclure (par exemple, `["stat_time_day", "ad_id"]`).
`metrics`	Liste des champs de métrique à renvoyer.
`report_type`	Type de rapport : `BASIC` ou `AUDIENCE`.
`data_level`	Niveau d’agrégation : `AUCTION_CAMPAIGN`, `AUCTION_ADGROUP` ou `AUCTION_AD`.
`query_lifetime`	Si `true`, renvoie les totaux à vie sans plage de dates. default à `false`.

Champ	Description
`dimensions`	Liste des dimensions à inclure (par exemple, `["stat_time_day", "ad_id"]`).
`metrics`	Liste des champs de métrique à renvoyer.
`report_type`	Type de rapport : `BASIC` ou `AUDIENCE`.
`data_level`	Niveau d’agrégation : `AUCTION_CAMPAIGN`, `AUCTION_ADGROUP` ou `AUCTION_AD`.
`query_lifetime`	Si `true`, renvoie les totaux à vie sans plage de dates. default à `false`.

destination_table est requis lorsque source_table est custom_report.

Tables sources prises en charge​

Tables prenant en charge les mises à jour incrémentielles​

Tables qui prennent en charge uniquement les mises à jour par batch (non incrémentielles)​

Rapports prédéfinis​

Groupes de métriques​

Rapports personnalisés​

custom_report_options champs​