Klaviyo 資料模型參考資料
本頁列出執行 Klaviyo 資料移轉時,系統會移轉至 BigQuery 的資料。資料會整理成表格,列出每個欄位名稱、相關聯的目的地資料類型,以及來源資料的 JSON 路徑。
帳戶
Klaviyo 帳戶資訊和中繼資料。
- 資料表名稱:帳戶
- 端點:
/accounts - Klaviyo API 參考資料:取得帳戶
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 account)。 |
id |
STRING | $.id |
帳戶的專屬 ID。 |
test_account |
STRING | $.attributes.test_account |
指出這是否為測試帳戶。 |
default_sender_name |
STRING | $.attributes.contact_information.default_sender_name |
電子郵件的預設寄件者名稱。 |
default_sender_email |
STRING | $.attributes.contact_information.default_sender_email |
預設電子郵件地址,用做寄件者。 |
website_url |
STRING | $.attributes.contact_information.website_url |
機構網站的網址。 |
organization_name |
STRING | $.attributes.contact_information.organization_name |
機構名稱。 |
address1 |
STRING | $.attributes.contact_information.street_address.address1 |
街道地址第 1 行。 |
address2 |
STRING | $.attributes.contact_information.street_address.address2 |
街道地址第 2 行。 |
city |
STRING | $.attributes.contact_information.street_address.city |
機構所在的城市。 |
region |
STRING | $.attributes.contact_information.street_address.region |
州、省或地區。 |
country |
STRING | $.attributes.contact_information.street_address.country |
國家/地區。 |
zip |
STRING | $.attributes.contact_information.street_address.zip |
郵遞區號。 |
industry |
STRING | $.attributes.industry |
帳戶的產業別。 |
timezone |
STRING | $.attributes.timezone |
帳戶的時區設定。 |
preferred_currency |
STRING | $.attributes.preferred_currency |
帳戶使用的主要貨幣。 |
public_api_key |
STRING | $.attributes.public_api_key |
用戶端整合的公開 API 金鑰 (網站 ID)。 |
locale |
STRING | $.attributes.locale |
語言代碼設定 (例如 en-US)。 |
優待券
折扣和促銷活動優待券。
- 資料表名稱:優待券
- 端點:
/coupons - Klaviyo API 參考資料:取得優待券
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 coupon)。 |
id |
STRING | $.id |
優待券的專屬內部 ID。 |
external_id |
STRING | $.attributes.external_id |
外部 ID (通常與名稱/ID 相同)。 |
description |
STRING | $.attributes.description |
優待券優惠說明。 |
low_balance_threshold |
STRING | $.attributes.monitor_configuration.low_balance_threshold |
觸發餘額偏低快訊的門檻。 |
CouponCode
系統為特定優待券產生的專屬代碼。
- 資料表名稱:CouponCode
- 端點:
/coupon-codes - Klaviyo API 參考資料:取得優待券代碼
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 coupon-code)。 |
id |
STRING | $.id |
這個特定程式碼執行個體的專屬 ID。 |
unique_code |
STRING | $.attributes.unique_code |
實際的英數字元代碼字串。 |
expires_at |
TIMESTAMP | $.attributes.expires_at |
這個代碼的失效時間戳記。 |
status |
STRING | $.attributes.status |
代碼狀態 (例如 已指派、未指派)。 |
coupon_id |
STRING | $.relationships.coupon.data.id |
父項優待券定義的 ID。 |
活動
系統為設定檔追蹤的活動事件 (例如下單、查看產品)。
- 資料表名稱:Events
- 端點:
/events - Klaviyo API 參考資料:Get Events
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 event)。 |
id |
STRING | $.id |
事件的專屬 ID。 |
timestamp |
FLOAT | $.attributes.timestamp |
事件發生的 Unix 時間戳記。 |
event_properties |
JSON | $.attributes.event_properties |
特定事件類型的自訂 JSON 屬性 (例如訂單中的項目)。 |
datetime |
TIMESTAMP | $.attributes.datetime |
事件的 ISO 8601 時間戳記。 |
uuid |
STRING | $.attributes.uuid |
事件的通用專屬 ID。 |
profile_id |
STRING | $.relationships.profile.data.id |
與事件相關聯的設定檔 (顧客) ID。 |
metric_id |
STRING | $.relationships.metric.data.id |
指標 (事件類型) 定義的 ID。 |
attribution_ids |
REPEATED STRING | $.relationships.attributions.data[*].id |
歸因於這個事件的廣告活動/流程 ID。 |
流量數
由特定事件或條件觸發的自動行銷流程。
- 資料表名稱:Flows
- 端點:
/flows - Klaviyo API 參考資料:Get Flows
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 flow)。 |
id |
STRING | $.id |
流程的專屬 ID。 |
name |
STRING | $.attributes.name |
流程名稱。 |
status |
STRING | $.attributes.status |
運作狀態 (例如有效、草稿)。 |
archived |
BOOLEAN | $.attributes.archived |
流程是否已封存。 |
created |
TIMESTAMP | $.attributes.created |
建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次修改的時間戳記。 |
trigger_type |
STRING | $.attributes.trigger_type |
觸發流程的機制 (例如「已新增至清單」、「指標」)。 |
flow_actions_ids |
REPEATED STRING | $.relationships.flow-actions.data[*].id |
這個流程中動作 (步驟) 的 ID。 |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
指派給此流程的標記 ID。 |
表單
收集訂閱者資訊的註冊表單。
- 資料表名稱:表單
- 端點:
/forms - Klaviyo API 參考資料:Get Forms
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 form)。 |
id |
STRING | $.id |
表單的專屬 ID。 |
name |
STRING | $.attributes.name |
表單名稱。 |
status |
STRING | $.attributes.status |
表單狀態 (例如有效、草稿)。 |
ab_test |
BOOLEAN | $.attributes.ab_test |
表單是否正在執行 A/B 測試。 |
created_at |
TIMESTAMP | $.attributes.created_at |
建立時間戳記。 |
updated_at |
TIMESTAMP | $.attributes.updated_at |
上次修改的時間戳記。 |
圖片
上傳至 Klaviyo 的圖片,可用於廣告活動和範本。
- 資料表名稱:Images
- 端點:
/images - Klaviyo API 參考資料:取得圖片
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 image)。 |
id |
STRING | $.id |
專屬 ID。 |
name |
STRING | $.attributes.name |
圖片的檔案名稱或名稱。 |
image_url |
STRING | $.attributes.image_url |
可存取圖片的公開網址。 |
format |
STRING | $.attributes.format |
圖片檔案格式 (例如 jpeg、png)。 |
size |
FLOAT | $.attributes.size |
檔案大小 (以位元組為單位)。 |
hidden |
BOOLEAN | $.attributes.hidden |
圖片是否隱藏在 UI 中。 |
updated_at |
TIMESTAMP | $.attributes.updated_at |
上次修改的時間戳記。 |
清單
聯絡人/個人資料的靜態清單。
- 資料表名稱:清單
- 端點:
/lists - Klaviyo API 參考資料:取得清單
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 list)。 |
id |
STRING | $.id |
清單的專屬 ID。 |
name |
STRING | $.attributes.name |
聯絡人清單名稱。 |
created |
TIMESTAMP | $.attributes.created |
建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次修改的時間戳記。 |
opt_in_process |
STRING | $.attributes.opt_in_process |
啟用設定 (例如「single_opt_in」或「double_opt_in」)。 |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
指派給這份清單的標籤 ID。 |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
將設定檔新增至這個清單時觸發的流程 ID。 |
指標
可追蹤的事件類型 (例如「Received Email」)。
- 資料表名稱:指標
- 端點:
/metrics - Klaviyo API 參考資料:Get Metrics
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 metric)。 |
id |
STRING | $.id |
專屬 ID (例如6 個字元的代碼 (適用於一般情況),或自訂的長 UUID。 |
name |
STRING | $.attributes.name |
使用者可解讀的名稱 (例如「Placed Order」)。 |
created |
TIMESTAMP | $.attributes.created |
建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次修改的時間戳記。 |
integration |
JSON | $.attributes.integration |
提供這項指標的整合服務相關資訊 (例如名稱、類別、圖片)。 |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
這項指標觸發的流程 ID。 |
設定檔
包含屬性和活動記錄的完整顧客資料。
- 資料表名稱:Profiles
- 端點:
/profiles - Klaviyo API 參考資料:Get Profiles
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 profile)。 |
id |
STRING | $.id |
設定檔的專屬 Klaviyo ID。 |
email |
STRING | $.attributes.email |
主要電子郵件地址。 |
phone_number |
STRING | $.attributes.phone_number |
電話號碼 (E.164 格式)。 |
external_id |
STRING | $.attributes.external_id |
外部系統的 ID。 |
first_name |
STRING | $.attributes.first_name |
名字。 |
last_name |
STRING | $.attributes.last_name |
姓氏。 |
organization |
STRING | $.attributes.organization |
公司或機構名稱。 |
locale |
STRING | $.attributes.locale |
地區/語言設定。 |
title |
STRING | $.attributes.title |
職稱。 |
image |
STRING | $.attributes.image |
個人資料圖片網址。 |
created |
TIMESTAMP | $.attributes.created |
設定檔建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次更新的時間戳記。 |
last_event_date |
TIMESTAMP | $.attributes.last_event_date |
最近一次事件的時間戳記。 |
address1 |
STRING | $.attributes.location.address1 |
地址行 1。 |
address2 |
STRING | $.attributes.location.address2 |
地址行 2。 |
city |
STRING | $.attributes.location.city |
城市。 |
country |
STRING | $.attributes.location.country |
國家/地區。 |
latitude |
STRING | $.attributes.location.latitude |
緯度座標。 |
longitude |
STRING | $.attributes.location.longitude |
經度座標。 |
region |
STRING | $.attributes.location.region |
州/省或區域。 |
zip |
STRING | $.attributes.location.zip |
郵遞區號。 |
timezone |
STRING | $.attributes.location.timezone |
時區。 |
ip |
STRING | $.attributes.location.ip |
完全不需要外部 IP 位址 |
properties |
JSON | $.attributes.properties |
自訂屬性鍵/值組合。 |
email_marketing_can_receive_email_marketing |
BOOLEAN | $.attributes.subscriptions.email.marketing.can_receive_email_marketing |
設定檔是否可接收電子郵件行銷內容。 |
email_marketing_consent |
STRING | $.attributes.subscriptions.email.marketing.consent |
同意聲明狀態 (例如:SUBSCRIBED、UNSUBSCRIBED)。 |
email_marketing_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.email.marketing.consent_timestamp |
同意聲明的提供時間。 |
email_marketing_last_updated |
TIMESTAMP | $.attributes.subscriptions.email.marketing.last_updated |
上次更新電子郵件同意聲明的時間。 |
email_marketing_method |
STRING | $.attributes.subscriptions.email.marketing.method |
同意聲明方法 (例如:FORM)。 |
email_marketing_method_detail |
STRING | $.attributes.subscriptions.email.marketing.method_detail |
方法的具體來源。 |
email_marketing_custom_method_detail |
STRING | $.attributes.subscriptions.email.marketing.custom_method_detail |
同意聲明方法的自訂詳細資料。 |
email_marketing_double_optin |
BOOLEAN | $.attributes.subscriptions.email.marketing.double_optin |
雙重驗證訂閱是否完成。 |
sms_marketing_can_receive_sms_marketing |
BOOLEAN | $.attributes.subscriptions.sms.marketing.can_receive_sms_marketing |
商家檔案是否可接收簡訊行銷訊息。 |
sms_marketing_consent |
STRING | $.attributes.subscriptions.sms.marketing.consent |
簡訊同意聲明狀態。 |
sms_marketing_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.sms.marketing.consent_timestamp |
使用者同意接收簡訊的時間。 |
sms_marketing_last_updated |
TIMESTAMP | $.attributes.subscriptions.sms.marketing.last_updated |
上次更新簡訊同意聲明的時間。 |
sms_marketing_method |
STRING | $.attributes.subscriptions.sms.marketing.method |
簡訊同意聲明方法。 |
sms_marketing_method_detail |
STRING | $.attributes.subscriptions.sms.marketing.method_detail |
簡訊同意聲明方法的詳細資料。 |
sms_transactional_can_receive_sms_transactional |
BOOLEAN | $.attributes.subscriptions.sms.transactional.can_receive_sms_transactional |
設定檔是否可以接收交易簡訊。 |
sms_transactional_consent |
STRING | $.attributes.subscriptions.sms.transactional.consent |
交易簡訊同意聲明狀態。 |
sms_transactional_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.sms.transactional.consent_timestamp |
提供交易同意聲明時。 |
sms_transactional_last_updated |
TIMESTAMP | $.attributes.subscriptions.sms.transactional.last_updated |
上次更新交易狀態的時間。 |
sms_transactional_method |
STRING | $.attributes.subscriptions.sms.transactional.method |
交易簡訊方法。 |
sms_transactional_method_detail |
STRING | $.attributes.subscriptions.sms.transactional.method_detail |
交易簡訊方法詳細資料。 |
mobile_push_can_receive_push_marketing |
BOOLEAN | $.attributes.subscriptions.mobile_push.marketing.can_receive_push_marketing |
設定檔是否可接收推播行銷訊息。 |
mobile_push_consent |
STRING | $.attributes.subscriptions.mobile_push.marketing.consent |
推送同意聲明狀態。 |
mobile_push_consent_timestamp |
TIMESTAMP | $.attributes.subscriptions.mobile_push.marketing.consent_timestamp |
使用者同意接收推播通知的時間。 |
predictive_analytics_historic_number_of_orders |
FLOAT | $.attributes.predictive_analytics.historic_number_of_orders |
歷來訂單總數。 |
predictive_analytics_predicted_number_of_orders |
FLOAT | $.attributes.predictive_analytics.predicted_number_of_orders |
預測未來的訂單。 |
predictive_analytics_average_days_between_orders |
FLOAT | $.attributes.predictive_analytics.average_days_between_orders |
訂單間的平均天數。 |
predictive_analytics_average_order_value |
FLOAT | $.attributes.predictive_analytics.average_order_value |
歷來平均訂單價值。 |
predictive_analytics_historic_clv |
FLOAT | $.attributes.predictive_analytics.historic_clv |
顧客終身價值記錄。 |
predictive_analytics_predicted_clv |
FLOAT | $.attributes.predictive_analytics.predicted_clv |
預估顧客終身價值。 |
predictive_analytics_total_clv |
FLOAT | $.attributes.predictive_analytics.total_clv |
歷史記錄和預測顧客終身價值。 |
predictive_analytics_churn_probability |
FLOAT | $.attributes.predictive_analytics.churn_probability |
流失機率 (0 到 1)。 |
predictive_analytics_expected_date_of_next_order |
TIMESTAMP | $.attributes.predictive_analytics.expected_date_of_next_order |
預測的下單日期。 |
email_marketing_suppression_reason |
重複的 JSON | $.attributes.subscriptions.email.marketing.suppression[*] |
電子郵件遭封鎖的原因 (例如遭退信)。 |
email_marketing_list_suppressions_reason |
重複的 JSON | $.attributes.subscriptions.email.marketing.list_suppressions[*] |
清單專屬的停用原因。 |
push_tokens_ids |
REPEATED STRING | $.relationships.push-tokens.data[*].id |
相關聯的推送權杖 ID。 |
評論
顧客提交的產品評論。
- 資料表名稱:評論
- 端點:
/reviews - Klaviyo API 參考資料:取得評論
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 review)。 |
id |
STRING | $.id |
評論的專屬 ID。 |
email |
STRING | $.attributes.email |
審查者的電子郵件地址。 |
value |
STRING | $.attributes.status.value |
狀態值 (例如:已發布、已拒絕)。 |
reason |
STRING | $.attributes.status.rejection_reason.reason |
拒絕原因 (如適用)。 |
status_explanation |
STRING | $.attributes.status.rejection_reason.status_explanation |
狀態的詳細說明。 |
verified |
BOOLEAN | $.attributes.verified |
購買交易是否已通過驗證。 |
review_type |
STRING | $.attributes.review_type |
評論類型 (例如產品評論)。 |
created |
TIMESTAMP | $.attributes.created |
建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次修改的時間戳記。 |
images |
REPEATED STRING | $.attributes.images[*] |
附加至評論的圖片網址。 |
product_url |
STRING | $.attributes.product.url |
受評論產品的網址。 |
product_name |
STRING | $.attributes.product.name |
產品名稱。 |
product_image_url |
STRING | $.attributes.product.image_url |
產品的圖片網址。 |
product_external_id |
STRING | $.attributes.product.external_id |
產品的外部 ID。 |
rating |
INTEGER | $.attributes.rating |
評分。 |
author |
STRING | $.attributes.author |
評論者名稱。 |
content |
STRING | $.attributes.content |
評論的文字內容。 |
title |
STRING | $.attributes.title |
評論標題。 |
smart_quote |
STRING | $.attributes.smart_quote |
評論中醒目顯示的引文。 |
public_reply_content |
STRING | $.attributes.public_reply.content |
商家公開回覆的內容。 |
public_reply_author |
STRING | $.attributes.public_reply.author |
回覆的作者。 |
public_reply_updated |
STRING | $.attributes.public_reply.updated |
回覆更新的時間戳記。 |
event_ids |
REPEATED STRING | $.relationships.events.data[*].id |
相關聯的活動 ID。 |
路段
根據特定條件建立的動態設定檔群組。
- 資料表名稱:區隔
- 端點:
/segments - Klaviyo API 參考資料:Get Segments
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 segment)。 |
id |
STRING | $.id |
區隔的專屬 ID。 |
name |
STRING | $.attributes.name |
區隔名稱。 |
created |
TIMESTAMP | $.attributes.created |
建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次修改的時間戳記。 |
is_active |
BOOLEAN | $.attributes.is_active |
區隔是否有效。 |
is_processing |
BOOLEAN | $.attributes.is_processing |
區隔是否正在處理中。 |
is_starred |
BOOLEAN | $.attributes.is_starred |
路段是否已加星號/設為最愛。 |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
相關聯代碼的 ID。 |
flow_triggers_ids |
REPEATED STRING | $.relationships.flow-triggers.data[*].id |
這個區隔觸發的流程 ID。 |
condition_groups |
REPEATED RECORD | $.attributes.definition.condition_groups[*] |
定義區隔的邏輯條件群組。 |
ConditionGroup
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
conditions |
REPEATED 條件 | conditions[*] |
群組中的個別條件清單。 |
條件
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | type |
條件類型 (例如:profile-property)。 |
value |
JSON | N/A |
條件值/設定。 |
標記
用於整理廣告活動、流程和名單的標記。
- 資料表名稱:標記
- 端點:
/tags - Klaviyo API 參考資料:Get Tags
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 tag)。 |
id |
STRING | $.id |
專屬代碼 ID。 |
name |
STRING | $.attributes.name |
代碼名稱。 |
tag_group_id |
STRING | $.relationships.tag-group.data.id |
這個代碼所屬的代碼群組 ID。 |
範本
電子郵件和訊息範本。
- 資料表名稱:範本
- 端點:
/templates - Klaviyo API 參考資料:Get Templates
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 template)。 |
id |
STRING | $.id |
專屬 ID。 |
name |
STRING | $.attributes.name |
範本名稱。 |
editor_type |
STRING | $.attributes.editor_type |
使用的編輯器 (例如拖曳)。 |
html |
STRING | $.attributes.html |
HTML 內容 |
text |
STRING | $.attributes.text |
範本的文字版本。 |
| amp | STRING | $.attributes.amp |
範本的 AMP 版本。 |
created |
TIMESTAMP | $.attributes.created |
建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次更新的時間戳記。 |
WebFeeds
用於在訊息中填入內容的網路動態消息。
- 資料表名稱:WebFeeds
- 端點:
/web-feeds - Klaviyo API 參考資料:Get Web Feeds
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 web-feed)。 |
id |
STRING | $.id |
專屬 ID。 |
name |
STRING | $.attributes.name |
動態饋給名稱。 |
url |
STRING | $.attributes.url |
動態饋給來源網址。 |
request_method |
STRING | $.attributes.request_method |
HTTP 方法 (GET/POST)。 |
content_type |
STRING | $.attributes.content_type |
內容類型 (例如JSON)。 |
status |
STRING | $.attributes.status |
動態饋給的狀態。 |
created |
TIMESTAMP | $.attributes.created |
建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次更新的時間戳記。 |
DataSources
整合至 Klaviyo 的資料來源。
- 資料表名稱:DataSources
- 端點:
/data-sources - Klaviyo API 參考資料:取得資料來源
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 data-source)。 |
id |
STRING | $.id |
專屬 ID。 |
title |
STRING | $.attributes.title |
資料來源的標題。 |
visibility |
STRING | $.attributes.visibility |
可見度等級。 |
description |
STRING | $.attributes.description |
說明文字。 |
倡議活動
傳送給名單或區隔的行銷活動。
- 表格名稱:廣告活動
- 端點:
/campaigns - Klaviyo API 參考資料:Get Campaigns
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 campaign)。 |
id |
STRING | $.id |
專屬 ID。 |
name |
STRING | $.attributes.name |
廣告活動名稱。 |
status |
STRING | $.attributes.status |
廣告活動狀態 (例如已傳送、排定傳送時間)。 |
archived |
BOOLEAN | $.attributes.archived |
廣告活動是否已封存。 |
included |
REPEATED STRING | $.attributes.audiences.included |
所含清單/區隔的 ID。 |
excluded |
REPEATED STRING | $.attributes.audiences.excluded |
排除清單/區隔的 ID。 |
send_options |
JSON | $.attributes.send_options |
傳送設定 (例如智慧傳送)。 |
tracking_options |
JSON | $.attributes.tracking_options |
追蹤設定 (例如 utm 參數)。 |
send_strategy |
JSON | $.attributes.send_strategy |
運送時間策略。 |
created_at |
TIMESTAMP | $.attributes.created_at |
建立時間戳記。 |
scheduled_at |
TIMESTAMP | $.attributes.scheduled_at |
廣告活動預計傳送的時間。 |
updated_at |
TIMESTAMP | $.attributes.updated_at |
上次更新的時間戳記。 |
send_time |
TIMESTAMP | $.attributes.send_time |
實際傳送時間。 |
tag_ids |
REPEATED STRING | $.relationships.tags.data[*].id |
相關聯代碼的 ID。 |
campaign_message_ids |
REPEATED STRING | $.relationships.campaign-messages.data[*].id |
這個廣告活動中包含的訊息 ID。 |
CampaignMessages
廣告活動中的個別訊息 (電子郵件/簡訊)。
- 資料表名稱:CampaignMessages
- 端點:
/campaign-messages - Klaviyo API 參考資料:Get Campaign Message
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型 (一律為 campaign-message)。 |
id |
STRING | $.id |
專屬 ID。 |
definition |
JSON | $.attributes.definition |
訊息內容和設定。 |
send_times |
重複的 JSON | $.attributes.send_times[*] |
排定的傳送時間。 |
created_at |
TIMESTAMP | $.attributes.created_at |
建立時間戳記。 |
updated_at |
TIMESTAMP | $.attributes.updated_at |
上次更新的時間戳記。 |
campaign_id |
STRING | $.relationships.campaign.data.id |
父項廣告活動的 ID。 |
template_id |
STRING | $.relationships.template.data.id |
所用範本的 ID。 |
image_id |
STRING | $.relationships.image.data.id |
附加圖片的 ID。 |
類別
目錄中的產品類別。
- 資料表名稱:Categories
- 端點:
/catalog-categories - Klaviyo API 參考資料:取得目錄類別
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型。 |
id |
STRING | $.id |
專屬 ID。 |
name |
STRING | $.attributes.name |
類別名稱。 |
external_id |
STRING | $.attributes.external_id |
外部系統 ID。 |
updated |
TIMESTAMP | $.attributes.updated |
上次更新的時間戳記。 |
項目
目錄中的個別產品或項目。
- 資料表名稱:項目
- 端點:
/catalog-items - Klaviyo API 參考資料:Get Catalog Items
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型。 |
id |
STRING | $.id |
專屬 ID。 |
external_id |
STRING | $.attributes.external_id |
外部系統 ID。 |
title |
STRING | $.attributes.title |
項目標題/名稱。 |
description |
STRING | $.attributes.description |
提供說明。 |
price |
FLOAT | $.attributes.price |
商品價格。 |
url |
STRING | $.attributes.url |
項目的網址。 |
image_full_url |
STRING | $.attributes.image_full_url |
原尺寸圖片的網址。 |
image_thumbnail_url |
STRING | $.attributes.image_thumbnail_url |
縮圖網址。 |
images |
REPEATED STRING | $.attributes.images[*] |
其他圖片網址清單。 |
custom_metadata |
JSON | $.attributes.custom_metadata |
自訂中繼資料鍵/值。 |
published |
BOOLEAN | $.attributes.published |
出版品狀態。 |
created |
TIMESTAMP | $.attributes.created |
建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次更新的時間戳記。 |
variants_ids |
REPEATED STRING | $.relationships.variants.data[*].id |
這項商品的子類 ID。 |
變化版本
目錄項目的特定子類 (例如尺寸、顏色)。
- 資料表名稱:Variants
- 端點:
/catalog-variants - Klaviyo API 參考資料:取得目錄變體
| 欄位名稱 | 類型 | JSON 路徑 | 說明 |
|---|---|---|---|
type |
STRING | $.type |
資源類型。 |
id |
STRING | $.id |
專屬 ID。 |
external_id |
STRING | $.attributes.external_id |
外部系統 ID。 |
title |
STRING | $.attributes.title |
子類名稱。 |
description |
STRING | $.attributes.description |
提供說明。 |
sku |
STRING | $.attributes.sku |
存貨單位。 |
inventory_policy |
FLOAT | $.attributes.inventory_policy |
商品目錄管理政策。 |
inventory_quantity |
FLOAT | $.attributes.inventory_quantity |
目前的庫存數量。 |
price |
FLOAT | $.attributes.price |
價格。 |
url |
STRING | $.attributes.url |
變體的網址。 |
image_full_url |
BOOLEAN | $.attributes.image_full_url |
提供完整圖片網址 (布林值)。 |
image_thumbnail_url |
STRING | $.attributes.image_thumbnail_url |
縮圖網址。 |
images |
REPEATED STRING | $.attributes.images[*] |
圖片清單。 |
published |
BOOLEAN | $.attributes.published |
出版品狀態。 |
created |
TIMESTAMP | $.attributes.created |
建立時間戳記。 |
updated |
TIMESTAMP | $.attributes.updated |
上次更新的時間戳記。 |