Klaviyo データモデルのリファレンス

このページでは、Klaviyo データ転送を実行するときに BigQuery に転送されるデータの一覧を示します。データは、各フィールド名、関連付けられた宛先データ型、ソースデータからの JSON パスを一覧表示するテーブルに整理されます。

アカウント

Klaviyo のアカウント情報とメタデータ。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に account）。
id STRING $.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 組織のウェブサイトの 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
  • エンドポイント: /coupons
  • Klaviyo API リファレンス: Get Coupons
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に coupon）。
id STRING $.id クーポンの固有の内部識別子。
external_id STRING $.attributes.external_id 外部 ID（多くの場合、名前 / ID と同じ）。
description STRING $.attributes.description クーポン特典の説明。
low_balance_threshold STRING $.attributes.monitor_configuration.low_balance_threshold 残高不足アラートをトリガーするしきい値。

CouponCode

特定のクーポン用に生成された個別の固有コード。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に coupon-code）。
id STRING $.id この特定のコード インスタンスの固有識別子。
unique_code STRING $.attributes.unique_code 実際の英数字コード文字列。
expires_at TIMESTAMP $.attributes.expires_at このコードの有効期限を示すタイムスタンプ。
status STRING $.attributes.status コードのステータス（例: ASSIGNED、UNASSIGNED）。
coupon_id STRING $.relationships.coupon.data.id 親クーポン定義の ID。

イベント

プロファイルでトラッキングされるアクティビティ イベント（例: 注文、商品の閲覧）。

  • テーブル名: Events
  • エンドポイント: /events
  • Klaviyo API リファレンス: Get Events
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に event）。
id STRING $.id イベントの固有識別子。
timestamp FLOAT $.attributes.timestamp イベントが発生した時刻の Unix タイムスタンプ。
event_properties JSON $.attributes.event_properties イベントタイプに固有のカスタム JSON プロパティ（注文内の商品など）。
datetime TIMESTAMP $.attributes.datetime イベントの ISO 8601 タイムスタンプ。
uuid STRING $.attributes.uuid イベントの Universally Unique Identifier。
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 フローの固有識別子。
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
  • エンドポイント: /forms
  • Klaviyo API リファレンス: Get Forms
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に form）。
id STRING $.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 リファレンス: Get Images
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に image）。
id STRING $.id 固有識別子。
name STRING $.attributes.name 画像のファイル名または名前。
image_url STRING $.attributes.image_url 画像にアクセスするための公開 URL。
format STRING $.attributes.format 画像ファイル形式（jpeg、png など）。
size FLOAT $.attributes.size ファイルサイズ（バイト単位）。
hidden BOOLEAN $.attributes.hidden UI で画像が非表示になっているかどうか。
updated_at TIMESTAMP $.attributes.updated_at 最終変更のタイムスタンプ。

リスト

連絡先 / プロファイルの静的リスト。

  • テーブル名: Lists
  • エンドポイント: /lists
  • Klaviyo API リファレンス: Get Lists
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に list）。
id STRING $.id リストの固有識別子。
name STRING $.attributes.name 連絡先リストの名前。
created TIMESTAMP $.attributes.created 作成のタイムスタンプ。
updated TIMESTAMP $.attributes.updated 最終変更のタイムスタンプ。
opt_in_process STRING $.attributes.opt_in_process オプトイン設定（例: 「singleoptin」または「doubleoptin」）。
tag_ids REPEATED STRING $.relationships.tags.data[*].id このリストに割り当てられたタグの ID。
flow_triggers_ids REPEATED STRING $.relationships.flow-triggers.data[*].id このリストにプロファイルを追加することでトリガーされるフローの ID。

指標

トラッキング可能なイベントのタイプ（「メールを受信」など）。

  • テーブル名: Metrics
  • エンドポイント: /metrics
  • Klaviyo API リファレンス: 指標を取得する
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に metric）。
id STRING $.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 プロフィール画像の URL。
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 カスタム プロパティの Key-Value ペア。
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 マーケティングを受信できるかどうか。
sms_marketing_consent STRING $.attributes.subscriptions.sms.marketing.consent SMS の同意ステータス。
sms_marketing_consent_timestamp TIMESTAMP $.attributes.subscriptions.sms.marketing.consent_timestamp SMS の同意が得られた日時。
sms_marketing_last_updated TIMESTAMP $.attributes.subscriptions.sms.marketing.last_updated SMS の同意が最後に更新された日時。
sms_marketing_method STRING $.attributes.subscriptions.sms.marketing.method SMS の同意方法。
sms_marketing_method_detail STRING $.attributes.subscriptions.sms.marketing.method_detail SMS 同意方法の詳細。
sms_transactional_can_receive_sms_transactional BOOLEAN $.attributes.subscriptions.sms.transactional.can_receive_sms_transactional プロファイルがトランザクション SMS を受信できるかどうか。
sms_transactional_consent STRING $.attributes.subscriptions.sms.transactional.consent トランザクション SMS の同意ステータス。
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 メソッド。
sms_transactional_method_detail STRING $.attributes.subscriptions.sms.transactional.method_detail トランザクション SMS メソッドの詳細。
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 同意ステータスを push します。
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 過去の CLV + 予測 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 REPEATED JSON $.attributes.subscriptions.email.marketing.suppression[*] メールが抑制された理由（バウンスなど）。
email_marketing_list_suppressions_reason REPEATED JSON $.attributes.subscriptions.email.marketing.list_suppressions[*] リスト固有の除外理由。
push_tokens_ids REPEATED STRING $.relationships.push-tokens.data[*].id 関連付けられているプッシュ トークン ID。

レビュー

お客様から送信された商品レビュー。

  • テーブル名: Reviews
  • エンドポイント: /reviews
  • Klaviyo API リファレンス: Get Reviews
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に review）。
id STRING $.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[*] クチコミに添付された画像の URL。
product_url STRING $.attributes.product.url レビュー対象の商品の URL。
product_name STRING $.attributes.product.name 商品の名前。
product_image_url STRING $.attributes.product.image_url 商品の画像 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。

セグメント

特定の条件に基づくプロファイルの動的グループ。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に segment）。
id STRING $.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 ConditionGroup $.attributes.definition.condition_groups[*] セグメントを定義する論理条件のグループ。

ConditionGroup

フィールド名 種類 JSON パス 説明
conditions REPEATED 条件 conditions[*] グループ内の個々の条件のリスト。

条件

フィールド名 種類 JSON パス 説明
type STRING type 条件のタイプ（profile-property など）。
value JSON N/A 条件値 / 設定。

タグ

キャンペーン、フロー、リストの整理に使用されるタグ。

  • テーブル名: Tags
  • エンドポイント: /tags
  • Klaviyo API リファレンス: Get Tags
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に tag）。
id STRING $.id 一意のタグ識別子。
name STRING $.attributes.name タグの名前。
tag_group_id STRING $.relationships.tag-group.data.id このタグが属するタググループの ID。

テンプレート

メールとメッセージのテンプレート。

  • テーブル名: Templates
  • エンドポイント: /templates
  • Klaviyo API リファレンス: Get Templates
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に template）。
id STRING $.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 固有識別子。
name STRING $.attributes.name フィード名。
url STRING $.attributes.url フィードソースの 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 に統合されたデータのソース。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に data-source）。
id STRING $.id 固有識別子。
title STRING $.attributes.title データソースのタイトル。
visibility STRING $.attributes.visibility 公開設定レベル。
description STRING $.attributes.description 説明テキスト。

キャンペーン

リストまたはセグメントに送信されるマーケティング キャンペーン。

  • テーブル名: Campaigns
  • エンドポイント: /campaigns
  • Klaviyo API リファレンス: Get Campaigns
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に campaign）。
id STRING $.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

キャンペーン内の個々のメッセージ（メール / SMS）。

  • テーブル名: CampaignMessages
  • エンドポイント: /campaign-messages
  • Klaviyo API リファレンス: Get Campaign Message
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ（常に campaign-message）。
id STRING $.id 固有識別子。
definition JSON $.attributes.definition メッセージの内容と構成。
send_times REPEATED 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。

カテゴリ

カタログの商品カテゴリ。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。
id STRING $.id 固有識別子。
name STRING $.attributes.name カテゴリ名。
external_id STRING $.attributes.external_id 外部システム ID。
updated TIMESTAMP $.attributes.updated 最終更新のタイムスタンプ。

アイテム

カタログ内の個々の商品またはアイテム。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。
id STRING $.id 固有識別子。
external_id STRING $.attributes.external_id 外部システム ID。
title STRING $.attributes.title アイテムのタイトル / 名前。
description STRING $.attributes.description 説明を利用できます。
price FLOAT $.attributes.price 商品アイテムの価格。
url STRING $.attributes.url アイテムの URL。
image_full_url STRING $.attributes.image_full_url フルサイズ画像の URL。
image_thumbnail_url STRING $.attributes.image_thumbnail_url サムネイル画像の URL。
images REPEATED STRING $.attributes.images[*] 追加の商品画像 URL のリスト。
custom_metadata JSON $.attributes.custom_metadata カスタム メタデータの Key-Value。
published BOOLEAN $.attributes.published パブリケーションのステータス。
created TIMESTAMP $.attributes.created 作成のタイムスタンプ。
updated TIMESTAMP $.attributes.updated 最終更新のタイムスタンプ。
variants_ids REPEATED STRING $.relationships.variants.data[*].id この商品のバリエーションの ID。

バリアント

カタログ アイテムの特定のバリエーション（サイズ、色など）。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。
id STRING $.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 バリエーションの URL。
image_full_url STRING $.attributes.image_full_url 完全な画像 URL が利用可能かどうか（ブール値）。
image_thumbnail_url STRING $.attributes.image_thumbnail_url サムネイル画像の URL。
images REPEATED STRING $.attributes.images[*] 画像のリスト。
published BOOLEAN $.attributes.published パブリケーションのステータス。
created TIMESTAMP $.attributes.created 作成のタイムスタンプ。
updated TIMESTAMP $.attributes.updated 最終更新のタイムスタンプ。

FlowActions

フローに関連付けられたフロー アクション。

  • テーブル名: FlowActions
  • エンドポイント: /flows/{id}/flow-actions
  • Klaviyo API リファレンス: Get Flow Actions
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。常に flow-action です。
id STRING $.id フローアクションの固有識別子。
created TIMESTAMP $.attributes.created 作成のタイムスタンプ。
updated TIMESTAMP $.attributes.updated 最終変更のタイムスタンプ。
message_id STRING $.attributes.definition.id アクション メッセージ定義の一意の ID。
message_temporary_id STRING $.attributes.definition.temporary_id メッセージ定義に割り当てられた一時 ID。
message_type STRING $.attributes.definition.type メッセージの種類（email、sms など）。
condition_groups REPEATED ConditionGroup $.attributes.definition.data.action_output_filter.condition_groups[*] フロー アクションの出力フィルタに関連付けられた条件。
next_if_true STRING $.attributes.definition.links.next_if_true 条件が true と評価された場合の次のフロー アクションの ID。
next_if_false STRING $.attributes.definition.links.next_if_false 条件が false と評価された場合の次のフローアクションの ID。

FormVersions

特定のフォームのフォーム バージョン。

  • テーブル名: FormVersions
  • エンドポイント: /forms/{id}/form-versions
  • Klaviyo API リファレンス: Get Form Versions
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。常に form-version です。
id STRING $.id フォーム バージョンの固有識別子。
form_type STRING $.attributes.form_type フォームのタイプ（popup、embed、banner など）。
variation_name STRING $.attributes.variation_name フォーム バリエーションの名前。
ab_test JSON $.attributes.ab_test A/B テストの構成とパターンの設定。
status STRING $.attributes.status フォーム バージョンの運用ステータス（draft、live など）。
created_at TIMESTAMP $.attributes.created_at 作成のタイムスタンプ。
updated_at TIMESTAMP $.attributes.updated_at 最終変更のタイムスタンプ。

PushTokens

プッシュ通知用のモバイルアプリ プロフィールに関連付けられたプッシュ トークン。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。常に push-token です。
id STRING $.id プッシュ トークンの固有識別子。
created TIMESTAMP $.attributes.created 作成のタイムスタンプ。
token STRING $.attributes.token デバイスのプッシュ トークン文字列。
enablement_status STRING $.attributes.enablement_status プッシュ通知の有効化ステータス（AUTHORIZED、UNAUTHORIZED など）。
platform STRING $.attributes.platform モバイル プラットフォーム（ios、android など）。
vendor STRING $.attributes.vendor ベンダー サービス提供者（apns、fcm など）。
background STRING $.attributes.background プッシュ通知のバックグラウンド更新ステータス。
recorded_date TIMESTAMP $.attributes.recorded_date プッシュ トークンが記録された日付。
metadata JSON $.attributes.metadata カスタム デバイスまたはプッシュ トークンのメタデータ。
profile_id STRING $.relationships.profile.data.id このプッシュ トークンに関連付けられている顧客プロファイルの ID。

TagGroups

タグを整理、分類するために使用されるタググループ。

  • テーブル名: TagGroups
  • エンドポイント: /tag-groups
  • Klaviyo API リファレンス: Get Tag Groups
フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。常に tag-group です。
id STRING $.id タググループの固有識別子。
name STRING $.attributes.name タググループの名前。
exclusive BOOLEAN $.attributes.exclusive このグループ内のタグが相互に排他的かどうか。
default BOOLEAN $.attributes.default このタググループがアカウントのデフォルトのタググループかどうか。

UniversalContent

メッセージとテンプレート用の再利用可能なユニバーサル コンテンツ ブロック。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。常に template-universal-content です。
id STRING $.id ユニバーサル コンテンツ ブロックの固有識別子。
name STRING $.attributes.name ユニバーサル コンテンツ ブロックの名前。
definition_content_type STRING $.attributes.definition.content_type 定義のコンテンツ タイプ（block、template など）。
definition_type STRING $.attributes.definition.type コンテンツのコンポーネント タイプ（text、button、image など）。
definition_data JSON $.attributes.definition.data コンテンツ定義の構造データとペイロード。
created TIMESTAMP $.attributes.created 作成のタイムスタンプ。
updated TIMESTAMP $.attributes.updated 最終変更のタイムスタンプ。
screenshot_status STRING $.attributes.screenshot_status プレビュー スクリーンショットの生成ステータス（completed、pending など）。
screenshot_url STRING $.attributes.screenshot_url コンテンツ プレビューのスクリーンショットの公開 URL。

MetricProperties

特定の指標に対して定義されたプロパティと構造属性。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。常に metric-property です。
id STRING $.id 指標プロパティの固有識別子。
sample_values JSON $.attributes.sample_values この指標プロパティでキャプチャされたサンプルデータ値。
label STRING $.attributes.label 人が読める形式のプロパティのラベル。
property STRING $.attributes.property イベント プロパティのキー名。
inferred_type STRING $.attributes.inferred_type このプロパティに対して Klaviyo が推測したデータ型（string、boolean、numeric など）。
metric_id STRING $.relationships.metric.data.id 親指標定義の ID。

TrackingSettings

キャンペーンとフローのアカウント単位の UTM トラッキング パラメータ。

フィールド名 種類 JSON パス 説明
type STRING $.type リソースタイプ。常に tracking-setting です。
id STRING $.id トラッキング設定の固有識別子。
auto_add_parameters BOOLEAN $.attributes.auto_add_parameters UTM パラメータをメッセージ リンクに自動的に追加するかどうか。
utm_source UtmParameter $.attributes.utm_source フローとキャンペーンの _utm_source parameter の構成。
utm_medium UtmParameter $.attributes.utm_medium フローとキャンペーンの _utm_medium parameter の構成。
utm_campaign UtmParameter $.attributes.utm_campaign フローとキャンペーンの _utm_campaign パラメータの構成。
utm_id UtmParameter $.attributes.utm_id フローとキャンペーンの _utm_id パラメータの構成。
utm_term UtmParameter $.attributes.utm_term フローとキャンペーンの _utm_term パラメータの構成。
custom_parameters REPEATED CustomParameter $.attributes.custom_parameters キャンペーン リンクとフローリンクに追加されたカスタム トラッキング パラメータ。

UtmParameter

フィールド名 種類 JSON パス 説明
flow ParameterContext flow フローの UTM パラメータ設定のコンテキスト。
campaign ParameterContext campaign キャンペーンの UTM パラメータ設定のコンテキスト。

ParameterContext

フィールド名 種類 JSON パス 説明
type STRING type リソースタイプ。
value STRING value パラメータ テンプレートの値または属性キー（emailsubject、campaignid など）。

CustomParameter

フィールド名 種類 JSON パス 説明
flow ParameterContext flow フローのカスタム トラッキング パラメータ コンテキスト。
campaign ParameterContext campaign キャンペーンのカスタム トラッキング パラメータのコンテキスト。
name STRING name カスタム トラッキング パラメータの名前。