KARTE Messageでは、管理画面上の設定情報が保持された次の4つのテーブルが存在しています。
masspush_setting_value_campaign：キャンペーンの設定情報masspush_setting_value_push_content：アクションの設定情報masspush_setting_value_campaign_folder：フォルダの設定情報masspush_setting_value_address_profile：プロファイルの設定情報
ここでは、これら4つのテーブルの概要と主なスキーマについて説明します。
なお、すべてのフィールドを記載しているわけではありません。記載していないフィールドには、開発中または利用を終了した機能に関するものなどが含まれます。
ご注意ください
これらのテーブルを利用する際には、以下の点にご注意ください。
【データの信頼性について】
- 開発中の機能に関するカラムが含まれます
- 利用が終了した機能に関する古いカラムが残っているケースがあります
- 予告なくデータが変更される可能性があります
【テーブルへの反映タイミングについて】
- 管理画面で作成・更新した設定情報がテーブルに反映されるまで、2時間程度かかります
masspush_setting_value_campaign
配信チャネル・スケジュール・配信対象リストなど、キャンペーンの設定情報を管理するテーブルです。
| カラム | 型 | 説明 |
|---|---|---|
_id | STRING | キャンペーン ID |
name | STRING | キャンペーン名 |
description | STRING | キャンペーンの目的 |
api_key | STRING | プロジェクトAPI キー |
enabled | STRING | キャンペーンが公開されているかどうか |
push_type | STRING | 配信タイプ |
status | STRING | キャンペーンのステータス |
content | STRUCT | 配信コンテンツ設定 |
target | STRUCT | 配信対象設定 |
schedule | STRUCT | 配信スケジュール設定 |
option | STRUCT | 配信オプション設定 |
modified_by | STRUCT | 更新者 |
is_archived | BOOLEAN | キャンペーンがアーカイブされているかどうか |
folder_id | STRING | 所属するフォルダの ID |
created | TIMESTAMP | キャンペーン作成日時 |
modified | TIMESTAMP | キャンペーン更新日時 |
content
| カラム | 型 | 説明 |
|---|---|---|
content.push_contents | STRUCT（REPEATED） | アクション設定 |
content.push_contents._id | STRING | システムID |
content.push_contents.name | STRING | アクション名 |
content.push_contents.push_content_id | STRING | アクションID |
content.push_contents.assign_rate | NUMBER | アクションの配信比率 |
content.push_contents.is_archived | BOOLEAN | キャンペーンに設定されたアクションがアーカイブされているかどうか |
content.push_contents.created | TIMESTAMP | アクション作成日時 |
content.push_contents.modified | TIMESTAMP | アクション更新日時 |
| - | - | - |
content.ses_setting | STRUCT | SES設定 |
content.ses_setting.address_profile_id | STRING | SESプロファイルID |
| - | - | - |
content.line_setting | STRUCT | LINE設定 |
content.line_setting.line_profile_id | STRING | LINEプロファイルID |
target
| カラム | 型 | 説明 |
|---|---|---|
target.primary | STRUCT | マスタリスト情報 |
target.primary._id | STRING | システムID |
target.primary.list_id | STRING | リストID |
target.primary.list_name | STRING | リスト名 |
target.primary.list_type | STRING | リスト種別 |
target.primary.created | TIMESTAMP | キャンペーンにリストを設定した時刻 |
target.primary.modified | TIMESTAMP | キャンペーンのリスト設定を更新した時刻 |
| - | - | - |
target.subsets | STRUCT（REPEATED） | さらに絞り込むで設定した情報※AND条件で追加した数だけ配列要素が存在します |
target.subsets._id | STRING | システムID |
target.subsets.logic_gate | STRING | 絞り込み方法 |
target.subsets.filter_lists | STRUCT（REPEATED） | 絞り込みに使ったリスト詳細情報 ※OR条件で追加したリストの数だけ配列要素が存在します |
target.subsets.filter_lists.list_id | STRING | リストID |
target.subsets.filter_lists.list_name | STRING | リスト名 |
target.subsets.filter_lists.list_type | STRING | リスト種別 |
target.subsets.join_field_name | STRING | リスト間の結合に利用するフィールド |
| - | - | - |
target.subsets_for_event_filters | STRUCT（REPEATED） | 施策配信結果で絞り込むで設定した情報※AND条件で追加した数だけ配列要素が存在します |
target.subsets_for_event_filters._id | STRING | システムID |
target.subsets_for_event_filters.logic_gate | STRING | 絞り込み方法 |
target.subsets_for_event_filters.event_filters | STRUCT（REPEATED） | 絞り込みに使ったリスト詳細情報 ※OR条件で追加したリストの数だけ配列要素が存在します |
target.subsets_for_event_filters.event_filters._id | STRING | システム ID |
target.subsets_for_event_filters.event_filters.conditions | STRUCT（REPEATED） | 絞り込み条件 ※ キャンペーン、イベント、期間に紐づく形で配列要素が存在します |
target.subsets_for_event_filters.event_filters.conditions.field_name | STRING | 絞り込みに使うフィールド名 |
target.subsets_for_event_filters.event_filters.conditions.field_type | STRING | 絞り込みに使うフィールドの型 |
target.subsets_for_event_filters.event_filters.conditions.logic | STRING | 絞り込み方法 |
target.subsets_for_event_filters.event_filters.conditions.value | STRING | 実際に指定した値 |
| - | - | - |
target.subsets_for_frequency_filters | STRUCT（REPEATED） | フリークエンシー制御で設定した情報※最大で4つの配列要素が存在します |
target.subsets_for_frequency_filters.send_limit | NUMBER | 配信回数上限 |
target.subsets_for_frequency_filters.campaign_id | STRING | フリークエンシー制御の対象とするキャンペーンID |
target.subsets_for_frequency_filters.address_profile_id | STRING | フリークエンシー制御の対象とするプロファイルID |
target.subsets_for_frequency_filters.past_days | NUMBER | 過去◯日間での制御なのか |
target.subsets_for_frequency_filters.push_type | STRING | 配信タイプ |
| - | - | - |
target.variables | STRUCT（REPEATED） | 埋め込み変数の設定 ※存在する埋め込み変数の数だけ配列要素が存在します |
target.variables.variables_name | STRING | 埋め込み変数名 |
target.variables.list_id | STRING | 埋め込み変数を参照しているリストID |
target.variables.embeded_field_name | STRING | 埋め込み変数としてリストから参照しているフィールド名 |
schedule
| カラム | 型 | 説明 |
|---|---|---|
schedule._id | STRING | システムID |
schedule.repeats | BOOLEAN | 繰り返し配信しているかどうか |
schedule.repeat_type | STRING | 繰り返し配信間隔 |
schedule.repeat_days | BOOLEAN（REPEATED） | 実行間隔が「毎日」のときの実行曜日 |
schedule.repeat_hours | BOOLEAN（REPEATED） | 実行間隔が「毎時」のときの実行日時 |
schedule.repeat_day_in_week | NUMBER | 実行間隔が「毎週」のときの実行曜日 ※0が日曜日です |
schedule.repeat_day_in_month | NUMBER | 実行間隔が「毎月」のときの実行日 |
schedule.repeat_hour_in_day | NUMBER | 繰り返し配信の時間（時間） |
schedule.repeat_minute | NUMBER | 繰り返し配信の時間（分） |
schedule.has_end | BOOLEAN | 繰り返し配信で終了日を指定しているかどうか |
schedule.start_date | TIMESTAMP | 繰り返し配信スケジュール開始日時 |
schedule.end_date | TIMESTAMP | 繰り返し配信スケジュール終了日時 |
schedule.reservation_type | STRING | 実行タイプ |
schedule.created | TIMESTAMP | 配信スケジュールを作成した日時 |
schedule.modified | TIMESTAMP | 配信スケジュールを更新した日時 |
option
| カラム | 型 | 説明 |
|---|---|---|
option.force_send_to_unsubscribe_list | BOOLEAN | 購読停止ユーザーへの送信するかどうか |
option.max_sendable_size_per_minute | NUMBER | 1分あたりの最大送信数 |
option.enable_click_tracking_for_line | BOOLEAN | LINEのクリックトラッキングを有効化するかどうか |
modified_by
| カラム | 型 | 説明 |
|---|---|---|
modified_by.account_id | STRING | 更新を行ったアカウントID |
modified_by.username | STRING | 更新を行ったユーザー名 |
masspush_setting_value_push_content
アクションの設定を管理するテーブルです。
| カラム | 型 | 説明 |
|---|---|---|
_id | STRING | アクションID |
api_key | STRING | プロジェクトAPI キー |
title | STRING | アクション名 |
push_type | STRING | 配信タイプ |
thumbnail_url | STRING | アクションのサムネイルURL |
is_archived | BOOLEAN | アクションに設定されているテンプレートがアーカイブされているかどうか ※テンプレートがアーカイブ(is_template: true)されている場合のみtrueになります |
is_template | BOOLEAN | テンプレートを利用しているかどうか |
campaign_id | STRING | アクションに紐づくキャンペーンID |
content | STRUCT | アクション設定 |
created | TIMESTAMP | アクションを作成した日時 |
modified | TIMESTAMP | アクションを最終更新した日時 |
modified_by | STRUCT | アクション更新情報 |
content
| カラム | 型 | 説明 |
|---|---|---|
content.title | STRING | アプリプッシュアクションの「タイトル」 |
content.body | STRING | アプリプッシュアクションの「本文」 |
content.url | STRING | アプリプッシュアクションの「ディープリンク / URL」 |
content.attachment_type | STRING | アプリプッシュアクションの「添付タイプ」 |
content.attachment_url | STRING | アプリプッシュアクションの「添付タイプ」で指定したURL |
content.badge_for_ios | STRING | アプリプッシュアクションの「iOSバッジ表示数」 |
content.SES_SUBJECT | STRING | メールアクションの「件名」 |
content.SES_CONTENT_HTML | STRING | メールアクションの本文（HTML版） |
content.SES_CONTENT_TEXT | STRING | メールアクションの本文（テキスト版） |
content.custom_data | STRING | アプリプッシュアクションの「カスタムペイロード」 |
content.line | STRING | LINEアクションの配信データ |
content.line_validation_error | STRING | LINEアクションのバリデーションエラー |
content.auto_text | BOOLEAN | メールアクションの「テキストパート編集」でHTMLコンテンツを自動変換したテキストパートを利用するを有効にしているかどうか |
content.use_bee_html | BOOLEAN | メールアクションでテンプレートから作成しているかどうか |
content.text | STRING | テキストメールのデータ |
content.additional_query_param_string | JSON | メールキャンペーンの「追加するURLパラメーター」 |
modified_by
| カラム | 型 | 説明 |
|---|---|---|
modified_by.account_id | STRING | 更新を行ったアカウントID |
modified_by.username | STRING | 更新を行ったユーザー名 |
masspush_setting_value_campaign_folder
フォルダを管理するテーブルです。
| カラム | 型 | 説明 |
|---|---|---|
_id | STRING | フォルダID |
api_key | STRING | プロジェクトAPI キー |
name | STRING | フォルダ名 |
modified_by | STRUCT | 更新情報 |
created | TIMESTAMP | フォルダを作成した日時 |
modified | TIMESTAMP | フォルダを最終更新した日時 |
modified_by
| カラム | 型 | 説明 |
|---|---|---|
modified_by.account_id | STRING | 更新を行ったアカウントID |
modified_by.username | STRING | 更新を行ったユーザー名 |
masspush_setting_value_address_profile
メールのプロファイルを管理するテーブルです。
| カラム | 型 | 説明 |
|---|---|---|
_id | STRING | メールのプロファイルID |
api_key | STRING | プロジェクトAPI キー |
from_address | STRING | 送信元アドレス |
from_name | STRING | プロファイル名 |
reply_to | STRING | 返信先アドレス |
customOneClickUnsubscribeURL | STRING | 独自の購読停止リンクURL |
enableOneClickUnsubscribe | BOOLEAN | ワンクリック購読停止を設定するかどうか |
created | TIMESTAMP | プロファイルの作成日時 |
modified | TIMESTAMP | プロファイルの更新日時 |
クエリサンプル
サンプルとして「enabled=公開状態」にあるすべてのキャンペーンの設定情報を出力するクエリは以下のようになります。
with raw as(
SELECT
c.name as folder_name
,a.name as campaign_name
,a._id as campaign_id
,a.description
,a.enabled
,a.push_type
,a.status
,a.schedule.*
,a.option
,b.content.SES_SUBJECT as mail_subject
,b.content.use_bee_html as mail_use_bee_html
,b.content.title as native_app_title
,b.content.body as native_app_body
,b.content.url as native_app_url
,b.content.attachment_url as native_app_attachment_url
FROM
`prd-karte-message-per-client.csv_upload_{{api_key}}.masspush_setting_value_campaign`as a
,unnest(content.push_contents) as contents
inner join `prd-karte-message-per-client.csv_upload_{{api_key}}.masspush_setting_value_push_content` as b
on contents.push_content_id = b._id
inner join `prd-karte-message-per-client.csv_upload_{{api_key}}.masspush_setting_value_campaign_folder` as c
on a.folder_id = c._id
where
a.enabled = 'true'
)
select * from raw