TikTok 広告コネクタリファレンス

備考

ベータ版

この機能はベータ版です。ワークスペース管理者は、 プレビュー ページからこの機能へのアクセスを制御できます。「Databricks プレビューの管理」を参照してください。

この記事では、サポートされているテーブル、ディメンション、メトリクスなど、TikTok Ads コネクタの参考情報を提供します。

サポートされているソーステーブル

TikTok Ads コネクタは、次のソース テーブルをサポートしています。

増分更新をサポートするテーブル

次の事前構築済みレポート テーブルは増分取り込みをサポートしています。

• 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

バッチ更新のみをサポートするテーブル（非増分）

パイプラインの更新ごとに次のテーブルが更新されます。

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

作成済みのレポート

事前構築済みレポートは、一般的なレポート要件に対応する固定されたディメンションとメトリクスを備えた、事前構成済みのレポート クエリーです。

レポート（source_table）	ディメンション	データレベル	レポートの種類
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

レポート（source_table）	ディメンション	データレベル	レポートの種類
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

メトリクスグループ

各事前構築済みレポートに対して返されるメトリクスは、そのレポートタイプによって異なります。

「**BASIC レポート**」は次のメトリクスを返します。

グループ	メトリクス
コアのパフォーマンス	spend、impressions、clicks、cpc、cpm、ctr、reach、cost_per_1000_reached、 frequency
動画再生	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
エンゲージメント	likes、comments、shares、follows、 profile_visits
アトリビューション	conversion、cost_per_conversion、conversion_rate、real_time_conversion、real_time_cost_per_conversion、 real_time_conversion_rate
アプリ内イベント	app_install、cost_per_app_install、registration、purchase、 cost_per_purchase

グループ	メトリクス
コアのパフォーマンス	spend、impressions、clicks、cpc、cpm、ctr、reach、cost_per_1000_reached、 frequency
動画再生	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
エンゲージメント	likes、comments、shares、follows、 profile_visits
アトリビューション	conversion、cost_per_conversion、conversion_rate、real_time_conversion、real_time_cost_per_conversion、 real_time_conversion_rate
アプリ内イベント	app_install、cost_per_app_install、registration、purchase、 cost_per_purchase

オーディエンス レポート は、次のメトリクスを返します：

グループ	メトリクス
コアのパフォーマンス	spend、impressions、clicks、cpm、cpc、ctr、conversion、cost_per_conversion、conversion_rate、result、result_rate、cost_per_result、reach、 frequency
ページイベント	total_landing_page_view、cost_per_landing_page_view、 landing_page_view_rate

グループ	メトリクス
コアのパフォーマンス	spend、impressions、clicks、cpm、cpc、ctr、conversion、cost_per_conversion、conversion_rate、result、result_rate、cost_per_result、reach、 frequency
ページイベント	total_landing_page_view、cost_per_landing_page_view、 landing_page_view_rate

カスタム レポート

事前構築済みレポートに加えて、パイプライン仕様でsource_tableをcustom_reportに設定し、connector_options.tiktok_ads_optionsの下でcustom_report_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 フィールド

フィールド	説明
dimensions	含めるディメンションのリスト（例：["stat_time_day", "ad_id"]）。
metrics	返すメトリクスフィールドのリスト。
report_type	レポートタイプ：BASICまたはAUDIENCE。
data_level	集計レベル：AUCTION_CAMPAIGN、AUCTION_ADGROUP、またはAUCTION_AD。
query_lifetime	trueの場合、日付範囲なしでライフタイム合計を返します。defaultはfalseです。

フィールド	説明
dimensions	含めるディメンションのリスト（例：["stat_time_day", "ad_id"]）。
metrics	返すメトリクスフィールドのリスト。
report_type	レポートタイプ：BASICまたはAUDIENCE。
data_level	集計レベル：AUCTION_CAMPAIGN、AUCTION_ADGROUP、またはAUCTION_AD。
query_lifetime	trueの場合、日付範囲なしでライフタイム合計を返します。defaultはfalseです。

destination_table source_tableがcustom_reportの場合に必要です。