一、集成方案介紹

概要

本文介紹將 TikTok for Business 數據回傳到本地數據庫的方案,該方案支持:

通過 Report API 獲取小時/天級別的聚合數據,其中包含展示、點擊、轉化和成本數據。指標數據既可以按照廣告維度進行分組聚合,也可以按照客戶羣體的特徵進行聚合分組

流程

在對接階段需要您做的事情有:

二、 集成前準備工作

2.1 註冊開發者賬號創建 TikTok 應用

  1. 首先,您需要訪問 Tiktok API Business 頁面,需要登錄或註冊一個TikTok 廣告賬號
  2. 接下來,按照步驟註冊成爲開發者
  3. 註冊成爲開發者後,您需要創建一個應用,如下圖所示。創建時的參數,可以按如下方式配置:
  1. 點擊「Confirm」確認後,您的應用最初將處於待定狀態。大約一到兩天左右,應用可以通過審覈(即狀態爲 Approved)。獲取您應用的 App ID 和 Secret,注意App ID和Secret要保存好

2.2 獲取 Access Token

拿到Tiktok APP ID 和 Secret 之後,創建好回調地址。登錄 Tiktok 後臺,進入「My Apps」頁面並選中您需要接入的項目,在藍框填入回調地址,接下來將紅框中的 URL 複製下來:

接着,將剛剛複製的地址粘貼到瀏覽器中,並打開:

打開後會跳轉到一個授權頁面,頁面上顯示了你申請的權限列表,單擊「Confirm」確認:

之後將會跳轉到一個新頁面,此時建議您將瀏覽器地址欄中的 auth_code 部分複製下來(如下圖所示),用來獲取 Access Token 。

2.3 確認一下所獲取的信息

此處總結了中您需要提供的所有信息:

三、TA 服務器數據拉取

目前我只拉回了 Tiktok Marketing API 的「Basic Report」以及「Audience Report」兩種數據類型,以下我所熟悉的Tiktok Marketing API 的基本信息,應該可以覆蓋大部分的數據和應用場景

接口基本信息

接入方式API 类型产品化数据粒度归因数据成本数据收益数据展示数据点击数据转化数据
Marketing API拉式聚合数据

3.1基本報告

Basic Report 提供了廣告維度的聚合分組,返回數據中涵蓋展示、點擊、轉化、買量成本等一系列指標數據。

3.1.1 聚合維度

Basic Report 提供了以下聚合維度,請注意,Basic Report 僅可以選擇一個廣告維度以及一個時間維度,如果需要按國家(地區)分組,則只能使用 country_code 這一個維度:

維度類型維度字段描述
廣告維度advertiser_idAdvertiser 層級
campaign_idCAMPAIGN 層級
adgroup_idADGROUP 層級
ad_idAD 層級
時間維度stat_time_day按天聚合
stat_time_hour按小時聚合
國家(地區)維度country_code按國家(地區)分組

注意,不同的廣告維度能夠獲取到的指標字段以及支持的篩選條件不同,請務必注意返回字段以及篩選中的備註信息,瞭解您所選用的廣告維度的數據能力。

3.1.2 指標字段

Basic Report 支持的指標非常豐富,本章節僅展示最爲常見的屬性指標以及基礎指標,如果想要了解完整的指標列表,請參考 TikTok 的指標列表

字段類型中文名說明備註
advertiser_id廣告賬號 ID必定入庫
屬性指標
campaign_name推廣系列名稱僅 CAMPAIGN、ADGROUP、AD 層級支持
campaign_id推廣系列ID僅 ADGROUP、AD 層級支持
adgroup_name廣告組名稱僅 ADGROUP、AD 層級支持
放置版位僅 ADGROUP、AD 層級支持
adgroup_id廣告組ID廣告組 ID,僅 AD 層級支持
aeo_typeAEO 廣告類型枚舉值爲 Auto Bid Multi Bid IAEO,非 AEO 廣告組返回 -。僅 ADGROUP 層級支持
ad_name廣告名稱僅 AD 層級支持
ad_text廣告標題僅 AD 層級支持
tt_app_id推廣應用 ID僅 ADGROUP、AD 層級支持,當推廣對象爲 App 時有值
tt_app_name推廣應用名稱僅 ADGROUP、AD 層級支持,當推廣對象爲 App 時有值
mobile_app_id應用 ID應用在 Google Play 或 Apple App Store 中的ID,僅 ADGROUP、AD 層級支持,當推廣對象爲 App 時有值
promotion_type推廣類型可選值爲app(應用), website(網站)和 others(其他)。ADGROUP 和 AD層級支持。同步報表和異步報表都支持本指標。
dpa_target_audience_typeDPA 廣告的目標受衆類型ADGROUP 和 AD 層級支持。同步報表和異步報表都支持本指標。
基礎指標
花費總消耗在所選擇的時間內投放廣告產生的花費金額。
cash_spend現金消耗所選時間範圍內投放廣告產生的現金消耗。僅 Advertiser 層級支持,不支持 lifetime,不支持分時查詢。 注意:指標更新可能有 24-48 小時的延遲
voucher_spend贈款消耗所選時間範圍內投放廣告產生的贈款消耗。僅 Advertiser 層級支持,不支持 lifetime,不支持分時查詢。 注意:指標更新可能有 24-48 小時的延遲
cpcCPC廣告花費平均到單次點擊的成本。
cpmCPM每千次展現您所產生的平均花費。
印象展示數廣告展現次數。
點擊次數點擊數廣告點擊次數。
CTRCTR(%)廣告展現中產生了點擊的次數佔比。
到達總覆蓋人數至少看過一次廣告的人數。該指標爲預估所得。
cost_per_1000_reached覆蓋千人成本覆蓋每一千人的平均成本。該指標爲預估所得。
換算轉化數廣告達成目標轉化的次數,目標轉化會根據創建時的投放設置有所不同(計數結果基於展示時間點統計)。
cost_per_conversion轉化成本廣告花費平均到單次轉化的成本(計數結果基於展示時間點統計)。
conversion_rate轉化率 (%)廣告點擊中產生了轉化的次數佔比(計數結果基於展示時間點統計)。
貨幣貨幣貨幣代碼, 比如 USD. 請注意要使currency生效,請求中的 ’dimensions‘字段需有adgroup_id/ ad_id/campaign_id/advertiser_id.
real_time_conversion實時轉化廣告達成目標轉化的次數,目標轉化會根據創建時的投放設置有所不同(計數結果基於轉化事件發生的時間統計)
real_time_cost_per_conversion實時單次轉化費用廣告花費平均到單次轉化的成本(計數結果基於轉化事件發生的時間統計)
real_time_conversion_rate實時轉化率 (%)廣告點擊中產生了轉化的次數佔比(計數結果基於轉化事件發生的時間統計)
結果成效廣告最終實現成效的次數,與您的優化目標相對應。(計數結果基於展示時間點統計)
cost_per_result單次成效費用獲得單次成效的成本。(計數結果基於展示時間點統計)
result_rate成效率 (%)廣告觀看或點擊過程中獲得成效的佔比。(計數結果基於展示時間點統計)
real_time_result實時成效廣告最終實現成效的次數,與您的優化目標相對應。(計數結果基於轉化事件發生的時間統計)
real_time_cost_per_result實時單次成效費用獲得單次成效的成本。(計數結果基於轉化事件發生的時間統計)
real_time_result_rate實時成效率 (%)廣告觀看或點擊過程中獲得成效的佔比。(計數結果基於轉化事件發生的時間統計)
secondary_goal_result深層目標成效廣告最終實現深層目標的次數,與您的深層目標相對應。由於同一推廣系列可對應不同的深層目標,當前暫不支持披露推廣系列維度的成效數總和,請您前往廣告組維度查看對應的深層目標成效數。
cost_per_secondary_goal_result深層目標成效費用獲得單次深層目標成效的成本。由於同一推廣系列可對應不同的深層目標,當前暫不支持披露推廣系列維度的深層目標成效費用,請您前往廣告組維度查看對應的深層目標成效費用。
secondary_goal_result_rate深層目標成效率 (%)獲得單次深層目標成效的成本。由於同一推廣系列可對應不同的深層目標,當前暫不支持披露推廣系列維度的深層目標成效費用,請您前往廣告組維度查看對應的深層目標成效費用。
頻率頻次平均每個被覆蓋用戶的觀看次數。
應用內事件
real_time_app_install實時應用安裝用戶在app中激活並歸因到您的廣告的次數。(計數結果基於轉化事件發生的時間統計)
real_time_app_install_cost實時應用安裝成本單次app安裝的成本。(計數結果基於轉化事件發生的時間統計)
app_install應用安裝用戶在app中激活並歸因到您的廣告的次數。(計數結果基於展示時間點統計。)
cost_per_app_install應用安裝成本單次app安裝的成本。(計數結果基於展示時間點統計。)
註冊去重註冊數去重後的用戶在app中註冊並歸因到您的廣告的次數。(計數結果基於展示時間點統計。)
cost_per_registration去重註冊成本去重後的單次註冊的成本。(計數結果基於展示時間點統計。)
registration_rate註冊率 (%)去重後的用戶的註冊量與app激活的佔比。(計數結果基於展示時間點統計。)

3.1.3 接口參數

3.1.4 入庫數據結構


3.2聽衆報告

Audience Report 相比 Basic Report,提供了更多用戶的聚合分組維度(被稱爲受衆維度),但返回的指標種類相對較少,並且存在 6-12 小時的處理延遲。

3.2.1 聚合維度

Audience Report 提供了以下聚合維度,

請注意,Audience Report 僅可以選擇一個受衆維度、一個廣告維度以及一個時間維度,其中受衆維度是必選的,其他兩種維度可選。也存在部分特例,請從下表備註欄中獲得更多信息。

另外,如果需要按國家(地區)分組,則只能使用 country_code 這一個維度:

維度類型維度字段描述備註
廣告維度advertiser_id按廣告主ID分組
campaign_id按推廣系列ID分組
adgroup_id按廣告組ID分組
ad_id按廣告ID分組
時間維度stat_time_day按天分組
stat_time_hour按小時分組
受衆維度country_code按投放國家分組若選擇按國家分組,則只能使用 country_code 這一個維度
性別按性別分組age 和 gender 可以同時使用
年齡按年齡分組age 和 gender 可以同時使用
province_id按省級區域分組。區域可選值,可參考地域定向不能與時間維度同時使用
dma_id按指定市場區域(DMA)分組。該地域劃分只在美國存在。可選值,可參考地域定向不能與時間維度同時使用
交流按網絡分組
語言按受衆語言分組
平臺按操作系統分組
interest_category按一級興趣定向分組不能與時間維度同時使用
interest_category_tier2按二級興趣定向分組不能與時間維度同時使用
interest_category_tier3按三級興趣定向分組不能與時間維度同時使用
interest_category_tier4按四級興趣定向分組不能與時間維度同時使用
behavior_id按行爲分組不能與時間維度同時使用
安置按投放版位分組不能與時間維度同時使用
device_brand_id按設備品牌分組不能與時間維度同時使用;且在使用本維度時,lifetime不能設置爲true

3.2.2 指標字段

Audience Report 支持的指標相比 Basic Report 會少一些,但是常見的屬性指標以及基礎指標都是支持的。

指標數據類型簡要說明詳細說明
advertiser_id廣告賬號 ID必定入庫
屬性指標屬性指標僅 dimensions 中包含 對應ID 維度時支持
campaign_name推廣系列名稱推廣系列名稱,僅 CAMPAIGN、ADGROUP、AD 層級支持
campaign_id推廣系列ID推廣系列ID,僅 ADGROUP、AD 層級支持
adgroup_name廣告組名稱廣告組名稱,僅 ADGROUP、AD 層級支持
放置版位版位,僅 ADGROUP、AD 層級支持
adgroup_id廣告組ID廣告組ID,僅 AD 層級支持
aeo_typeAEO 廣告類型AEO(App Event Optimization)廣告類型,枚舉值爲 Auto Bid Multi Bid IAEO,非 AEO 廣告組返回 -。僅 ADGROUP 層級支持
ad_name廣告名稱廣告名稱,僅 AD 層級支持
ad_text廣告標題廣告標題,僅 AD 層級支持
tt_app_id推廣應用 ID推廣應用 ID,僅 ADGROUP、AD 層級支持,當推廣對象爲 App 時有值
tt_app_name推廣應用名稱推廣應用名稱,僅 ADGROUP、AD 層級支持,當推廣對象爲 App 時有值
mobile_app_id推廣應用在 Google Play 或 Apple App Store 中的ID推廣應用在 Google Play 或 Apple App Store 中的ID,僅 ADGROUP、AD 層級支持,當推廣對象爲 App 時有值
device_brand_name設備品牌名稱當維度中包含 device_brand_id 時支持此指標。
behavior_name行爲名稱當維度中包含behavior_id 時支持此指標。
action_category行爲類別當維度中包含behavior_id 時支持此指標。僅實時報表支持,異步報表不支持。
action_scene行爲場景。枚舉值: VIDEO_RELATED(視頻行爲), CREATOR_RELATED(創作者行爲).當維度中包含behavior_id時支持此指標。僅實時報表支持,異步報表不支持。
user_action用戶行爲對於視頻行爲場景,可選值包括WATCHED_TO_END(看完), LIKED(點贊), COMMENTED(評論)和SHARED(分享)。 對於創作者行爲場景,可選值包括FOLLOWING(關注)和VIEW_HOMEPAGE(瀏覽主頁)。
action_period行爲天數。 可選值: 7, 15。僅實時報表支持,異步報表不支持。
promotion_type推廣類型推廣類型。可選值爲app(應用), website(網站)和 others(其他)。ADGROUP和AD層級支持。同步報表和異步報表都支持本指標。
dpa_target_audience_typeDPA的目標受衆類型DPA廣告的目標受衆類型。ADGROUP和AD層級支持。同步報表和異步報表都支持本指標。
基礎數據
花費總消耗在所選擇的時間內投放廣告產生的花費金額。
cpcCPC廣告花費平均到單次點擊的成本。
cpmCPM每千次展現您所產生的平均花費。
印象展示數廣告展現次數。
點擊次數點擊數廣告點擊次數。
CTRCTR(%)廣告展現中產生了點擊的次數佔比。
換算轉化數廣告達成目標轉化的次數,目標轉化會根據創建時的投放設置有所不同(計數結果基於展示時間點統計)。
cost_per_conversion轉化成本廣告花費平均到單次轉化的成本(計數結果基於展示時間點統計)。
conversion_rate轉化率 (%)廣告點擊中產生了轉化的次數佔比(計數結果基於展示時間點統計)。
real_time_conversion實時轉化廣告達成目標轉化的次數,目標轉化會根據創建時的投放設置有所不同(計數結果基於轉化事件發生的時間統計)
real_time_cost_per_conversion實時單次轉化費用廣告花費平均到單次轉化的成本(計數結果基於轉化事件發生的時間統計)
real_time_conversion_rate實時轉化率 (%)廣告點擊中產生了轉化的次數佔比(計數結果基於轉化事件發生的時間統計)
結果成效廣告最終實現成效的次數,與您的優化目標相對應。(計數結果基於展示時間點統計)
cost_per_result單次成效費用獲得單次成效的成本。(計數結果基於展示時間點統計)
result_rate成效率 (%)廣告觀看或點擊過程中獲得成效的佔比。(計數結果基於展示時間點統計)
real_time_result實時成效廣告最終實現成效的次數,與您的優化目標相對應。(計數結果基於轉化事件發生的時間統計)
real_time_cost_per_result實時單次成效費用獲得單次成效的成本。(計數結果基於轉化事件發生的時間統計)
real_time_result_rate實時成效率 (%)廣告觀看或點擊過程中獲得成效的佔比。(計數結果基於轉化事件發生的時間統計)
貨幣貨幣貨幣代碼, 比如 USD. 請注意要使currency生效,請求中的 ’dimensions‘字段需有adgroup_id/ ad_id/campaign_id/advertiser_id.

3.2.2 指標字段

Audience Report 支持的指標相比 Basic Report 會少一些,但是常見的屬性指標以及基礎指標都是支持的。

指標數據類型簡要說明詳細說明
advertiser_id廣告賬號 ID必定入庫
屬性指標屬性指標僅 dimensions 中包含 對應ID 維度時支持
campaign_name推廣系列名稱推廣系列名稱,僅 CAMPAIGN、ADGROUP、AD 層級支持
campaign_id推廣系列ID推廣系列ID,僅 ADGROUP、AD 層級支持
adgroup_name廣告組名稱廣告組名稱,僅 ADGROUP、AD 層級支持
放置版位版位,僅 ADGROUP、AD 層級支持
adgroup_id廣告組ID廣告組ID,僅 AD 層級支持
aeo_typeAEO 廣告類型AEO(App Event Optimization)廣告類型,枚舉值爲 Auto Bid Multi Bid IAEO,非 AEO 廣告組返回 -。僅 ADGROUP 層級支持
ad_name廣告名稱廣告名稱,僅 AD 層級支持
ad_text廣告標題廣告標題,僅 AD 層級支持
tt_app_id推廣應用 ID推廣應用 ID,僅 ADGROUP、AD 層級支持,當推廣對象爲 App 時有值
tt_app_name推廣應用名稱推廣應用名稱,僅 ADGROUP、AD 層級支持,當推廣對象爲 App 時有值
mobile_app_id推廣應用在 Google Play 或 Apple App Store 中的ID推廣應用在 Google Play 或 Apple App Store 中的ID,僅 ADGROUP、AD 層級支持,當推廣對象爲 App 時有值
device_brand_name設備品牌名稱當維度中包含 device_brand_id 時支持此指標。
behavior_name行爲名稱當維度中包含behavior_id 時支持此指標。
action_category行爲類別當維度中包含behavior_id 時支持此指標。僅實時報表支持,異步報表不支持。
action_scene行爲場景。枚舉值: VIDEO_RELATED(視頻行爲), CREATOR_RELATED(創作者行爲).當維度中包含behavior_id時支持此指標。僅實時報表支持,異步報表不支持。
user_action用戶行爲對於視頻行爲場景,可選值包括WATCHED_TO_END(看完), LIKED(點贊), COMMENTED(評論)和SHARED(分享)。 對於創作者行爲場景,可選值包括FOLLOWING(關注)和VIEW_HOMEPAGE(瀏覽主頁)。
action_period行爲天數。 可選值: 7, 15。僅實時報表支持,異步報表不支持。
promotion_type推廣類型推廣類型。可選值爲app(應用), website(網站)和 others(其他)。ADGROUP和AD層級支持。同步報表和異步報表都支持本指標。
dpa_target_audience_typeDPA的目標受衆類型DPA廣告的目標受衆類型。ADGROUP和AD層級支持。同步報表和異步報表都支持本指標。
基礎數據
花費總消耗在所選擇的時間內投放廣告產生的花費金額。
cpcCPC廣告花費平均到單次點擊的成本。
cpmCPM每千次展現您所產生的平均花費。
印象展示數廣告展現次數。
點擊次數點擊數廣告點擊次數。
CTRCTR(%)廣告展現中產生了點擊的次數佔比。
換算轉化數廣告達成目標轉化的次數,目標轉化會根據創建時的投放設置有所不同(計數結果基於展示時間點統計)。
cost_per_conversion轉化成本廣告花費平均到單次轉化的成本(計數結果基於展示時間點統計)。
conversion_rate轉化率 (%)廣告點擊中產生了轉化的次數佔比(計數結果基於展示時間點統計)。
real_time_conversion實時轉化廣告達成目標轉化的次數,目標轉化會根據創建時的投放設置有所不同(計數結果基於轉化事件發生的時間統計)
real_time_cost_per_conversion實時單次轉化費用廣告花費平均到單次轉化的成本(計數結果基於轉化事件發生的時間統計)
real_time_conversion_rate實時轉化率 (%)廣告點擊中產生了轉化的次數佔比(計數結果基於轉化事件發生的時間統計)
結果成效廣告最終實現成效的次數,與您的優化目標相對應。(計數結果基於展示時間點統計)
cost_per_result單次成效費用獲得單次成效的成本。(計數結果基於展示時間點統計)
result_rate成效率 (%)廣告觀看或點擊過程中獲得成效的佔比。(計數結果基於展示時間點統計)
real_time_result實時成效廣告最終實現成效的次數,與您的優化目標相對應。(計數結果基於轉化事件發生的時間統計)
real_time_cost_per_result實時單次成效費用獲得單次成效的成本。(計數結果基於轉化事件發生的時間統計)
real_time_result_rate實時成效率 (%)廣告觀看或點擊過程中獲得成效的佔比。(計數結果基於轉化事件發生的時間統計)
貨幣貨幣貨幣代碼, 比如 USD. 請注意要使currency生效,請求中的 ’dimensions‘字段需有adgroup_id/ ad_id/campaign_id/advertiser_id.

3.2.3 接口參數

3.2.4 入庫數據結構

廣告維度時間維度受衆維度層級事件名
ad_idstat_time_daycountry_code廣告層級tiktok_audience_report
ad_idstat_time_day平臺廣告層級tiktok_audience_report_platform
ad_idstat_time_day年齡、性別廣告層級tiktok_audience_report_age_gender

四、數據集成配置信息模板

在閱讀完以上文檔之後,建議您完成以下信息模板,完成 TikTok Marketing API 的數據拉取:

数据接收地址 push_url:XXX
---------
Tiktok 项目的 App ID:xxx
Tiktok 项目的 Secret:xxx
授权码 auth_code:xxxx
广告主 ID (advertiser_ids)列表:XXX
---------
数据类型:[Basic Report/Audience Report]
聚合维度:xxx, xxx
获取指标:xxx, xxx
历史数据拉取时间范围:yyyy/mm/dd - yyyy/mm/dd(仅支持拉取按天聚合的近一个月的数据)
定时拉取时间:xxx

五、問題解答

在對接任何廣告平台API時,若遇到無論是棘手的技術或者產品問題,歡迎聯繫我幫你解答查看我的履歷

Leave a Reply

Your email address will not be published. Required fields are marked *