Referência do conector de anúncios do TikTok

info

Beta

Este recurso está em versão Beta. Os administradores do espaço de trabalho podem controlar o acesso a este recurso na página de Pré-visualizações . Veja as prévias do Gerenciador Databricks.

Este artigo fornece informações de referência para o conector TikTok Ads, incluindo tabelas, dimensões e detalhes suportados.

Tabelas de origem suportadas

O conector de anúncios do TikTok é compatível com as seguintes tabelas de origem:

Tabelas que suportam atualizações incrementais

As seguintes tabelas de relatório pré-construídas suportam ingestão incremental:

• 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

Tabelas que suportam apenas atualizações de lotes (não incrementais)

As tabelas a seguir são atualizadas a cada atualização do pipeline:

• campaign
• adgroup
• ad
• campaign_report_lifetime
• adgroup_report_lifetime
• ad_report_lifetime

Relatórios pré-criados

Relatórios pré-definidos são queries de relatório pré-configuradas com dimensões e métricas fixas para necessidades comuns de relatório.

Relatório (source_table)	Dimensões	Nível de dados	Tipo de relatório
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

Relatório (source_table)	Dimensões	Nível de dados	Tipo de relatório
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

grupos de mer

As métricas retornadas para cada relatório predefinido dependem do seu tipo de relatório.

Relatórios BASIC retornam as seguintes métricas:

Grupo	Métricas
Desempenho essencial	spend, impressions, clicks, cpc, cpm, ctr, reach, cost_per_1000_reached, frequency
Reprodução de vídeo	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
Engajamento	likes, comments, shares, follows, profile_visits
Atribuição	conversion, cost_per_conversion, conversion_rate, real_time_conversion, real_time_cost_per_conversion, real_time_conversion_rate
Eventos no aplicativo	app_install, cost_per_app_install, registration, purchase, cost_per_purchase

Grupo	Métricas
Desempenho essencial	spend, impressions, clicks, cpc, cpm, ctr, reach, cost_per_1000_reached, frequency
Reprodução de vídeo	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
Engajamento	likes, comments, shares, follows, profile_visits
Atribuição	conversion, cost_per_conversion, conversion_rate, real_time_conversion, real_time_cost_per_conversion, real_time_conversion_rate
Eventos no aplicativo	app_install, cost_per_app_install, registration, purchase, cost_per_purchase

Relatórios de AUDIÊNCIA retornam as seguintes métricas:

Grupo	Métricas
Desempenho essencial	spend, impressions, clicks, cpm, cpc, ctr, conversion, cost_per_conversion, conversion_rate, result, result_rate, cost_per_result, reach, frequency
Eventos da página	total_landing_page_view, cost_per_landing_page_view, landing_page_view_rate

Grupo	Métricas
Desempenho essencial	spend, impressions, clicks, cpm, cpc, ctr, conversion, cost_per_conversion, conversion_rate, result, result_rate, cost_per_result, reach, frequency
Eventos da página	total_landing_page_view, cost_per_landing_page_view, landing_page_view_rate

Relatórios personalizados

Além dos relatórios predefinidos, você pode criar relatórios personalizados definindo source_table como custom_report na especificação do seu pipeline e fornecendo custom_report_options em 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 campos

campo	Descrição
dimensions	Lista de dimensões a serem incluídas (por exemplo, ["stat_time_day", "ad_id"]).
metrics	Lista de campos de métrica a serem retornados.
report_type	Tipo de relatório: BASIC ou AUDIENCE.
data_level	Nível de agregação: AUCTION_CAMPAIGN, AUCTION_ADGROUP ou AUCTION_AD.
query_lifetime	Se true, retorna totais acumulados sem intervalo de datas. default to false.

campo	Descrição
dimensions	Lista de dimensões a serem incluídas (por exemplo, ["stat_time_day", "ad_id"]).
metrics	Lista de campos de métrica a serem retornados.
report_type	Tipo de relatório: BASIC ou AUDIENCE.
data_level	Nível de agregação: AUCTION_CAMPAIGN, AUCTION_ADGROUP ou AUCTION_AD.
query_lifetime	Se true, retorna totais acumulados sem intervalo de datas. default to false.

destination_table é exigido quando source_table é custom_report.