Klaviyo データモデルのリファレンス
このページでは、Klaviyo データ転送を実行したときに BigQuery に転送されるデータの一覧を示します。データは、各フィールド名、関連する宛先データ型、ソースデータからの JSON パスを一覧表示するテーブルに整理されます。
アカウント
Klaviyo アカウントの情報とメタデータ。
- テーブル名: Accounts
- エンドポイント:
/accounts - Klaviyo API リファレンス: Get Accounts
| フィールド名 | タイプ | 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 - 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
特定のクーポン用に生成された個別の固有コード。
- テーブル名: CouponCode
- エンドポイント:
/coupon-codes - Klaviyo API リファレンス: Get Coupon Codes
| フィールド名 | タイプ | 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 |
イベントのユニバーサルに一意な識別子。 |
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 リファレンス: フォームを取得する
| フィールド名 | タイプ | 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 |
オプトイン設定(「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
- エンドポイント:
/metrics - Klaviyo API リファレンス: Get Metrics
| フィールド名 | タイプ | JSON パス | 説明 |
|---|---|---|---|
type |
STRING | $.type |
リソースタイプ(常に metric)。 |
id |
STRING | $.id |
一意の識別子(例: 汎用には 6 文字のコード、カスタムには長い UUID を使用します。 |
name |
STRING | $.attributes.name |
人が読める形式の名前(例: 「注文完了」)。 |
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 |
同意ステータスをプッシュします。 |
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 |
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
- エンドポイント:
/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。 |
セグメント
特定の条件に基づくプロファイルの動的グループ。
- テーブル名: Segments
- エンドポイント:
/segments - Klaviyo API リファレンス: セグメントを取得する
| フィールド名 | タイプ | 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 RECORD | $.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 - 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 リファレンス: ウェブフィードを取得する
| フィールド名 | タイプ | 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 に統合されたデータのソース。
- テーブル名: DataSources
- エンドポイント:
/data-sources - Klaviyo API リファレンス: Get Data Sources
| フィールド名 | タイプ | 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 リファレンス: キャンペーンを取得する
| フィールド名 | タイプ | 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 |
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 リファレンス: Get Catalog Categories
| フィールド名 | タイプ | JSON パス | 説明 |
|---|---|---|---|
type |
STRING | $.type |
リソースの種類。 |
id |
STRING | $.id |
固有識別子。 |
name |
STRING | $.attributes.name |
カテゴリ名。 |
external_id |
STRING | $.attributes.external_id |
外部システム ID。 |
updated |
TIMESTAMP | $.attributes.updated |
最終更新のタイムスタンプ。 |
アイテム
カタログ内の個々の商品またはアイテム。
- テーブル名: Items
- エンドポイント:
/catalog-items - Klaviyo API リファレンス: Get Catalog Items
| フィールド名 | タイプ | 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。 |
バリアント
カタログ アイテムの特定のバリエーション(サイズ、色など)。
- テーブル名: Variants
- エンドポイント:
/catalog-variants - Klaviyo API リファレンス: Get Catalog Variants
| フィールド名 | タイプ | 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 |
BOOLEAN | $.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 |
最終更新のタイムスタンプ。 |