プリセットプロパティとシステムフィールド
このセクションでは、AEのすべてのプリセットプロパティとシステムフィールドについて説明します。各プラットフォームのプリセットプロパティについては、以下を参照してください:
Androidプラットフォーム、iOSプラットフォーム、Webプラットフォーム、ミニアプリ&ミニゲームプラットフォーム、サーバー
プリセットプロパティとは、AEが生成または取得するプロパティです。すべてのプリセットプロパティは"#"で始まり、いずれもイベントプロパティです。また、これらのプロパティの表示名と意味はすでに決まっています。システムフィールドとは、データ内の構造フィールド(#account_id、#event_timeなど)や、データベース内で特別な用途を持つフィールドのことです。分析モデルでは使用されないか、間接的に使用されることがほとんどです。
以下に挙げるプリセットプロパティを除き、"#"で始まるプロパティはすべて不正なフィールドとみなされ、格納できません。そのため、カスタムプロパティを"#"で始まる名前にすることはお勧めしません。また、すべてのシステムフィールドは、データ送信時にイベントプロパティやユーザープロパティとして渡すことはできません。
ご注意ください。#ip以外のすべてのプリセットプロパティは、直接使用することをお勧めしません。クライアントSDKとほかの転送方式を併用していて、複数の端末のデータでプロパティを揃える必要がある場合にのみ、ThinkingAIの担当者の案内のもとで設定することをお勧めします。送信するデータのプリセットプロパティのプロパティタイプが表の内容と一致していることを必ず確認してください。タイプが一致しない場合、そのプロパティの値は破棄されます(つまり値はnullになります)。
- プリセットプロパティ
| プロパティ名 | 画面表示名 | プロパティタイプ | 説明 |
|---|---|---|---|
| #ip | クライアントIP | テキスト | ユーザーのIPアドレス。AEはこれを基にユーザーの位置情報を取得します |
| #country | 国・地域 | テキスト | ユーザーの所在国・地域。IPアドレスに基づいて生成されます |
#country_code | 国・地域コード | テキスト | ユーザーの所在国・地域の国・地域コード(ISO 3166-1 alpha-2、つまり大文字の英字2文字)。IPアドレスに基づいて生成されます |
| #province | 省 | テキスト | ユーザーの所在する省・州。IPアドレスに基づいて生成されます |
| #city | 都市 | テキスト | ユーザーの所在都市。IPアドレスに基づいて生成されます |
| #os_version | OS バージョン | テキスト | iOS 11.2.2、Android 8.0.0など |
| #manufacturer | メーカー | テキスト | ユーザーのデバイスのメーカー。Apple、vivoなど |
| #os | OS | テキスト | Android、iOSなど |
| #device_id | デバイスID | テキスト | ユーザーのデバイスID。iOSではユーザーのIDFVまたはUUID、AndroidではandroidIDを取得 |
| #screen_height | 画面の高さ | 数値 | ユーザーのデバイスの画面の高さ。1920など |
| #screen_width | 画面の幅 | 数値 | ユーザーのデバイスの画面の幅。1080など |
| #device_model | デバイスモデル | テキスト | ユーザーのデバイスのモデル。iPhone 8など |
| #device_type | デバイスタイプ | テキスト | ユーザーのデバイスのタイプ。iPad、iPhoneなど |
| #app_version | アプリバージョン | テキスト | APPのバージョン |
| #bundle_id | アプリパッケージ名 | テキスト | APPのパッケージ名またはプロセス名 |
| #lib | SDKタイプ | テキスト | 接続したSDKのタイプ。Android、iOSなど |
| #lib_version | SDKバージョン | テキスト | 接続したSDKのバージョン |
| #network_type | ネットワークタイプ | テキスト | イベント発生時のネットワーク状態。WIFI、3G、4Gなど |
| #carrier | 通信キャリア | テキスト | ユーザーのデバイスの通信キャリア。中国移动、中国电信など |
| #browser | ブラウザ | テキスト | ユーザーが使用しているブラウザの種類。Chrome、Firefoxなど |
| #browser_version | ブラウザバージョン | テキスト | ユーザーが使用しているブラウザのバージョン。Chrome 61.0、Firefox 57.0など |
| #duration | イベント継続時間 | 数値 | タイマー機能で記録した時間。単位は秒 |
| #url | ページアドレス | テキスト | 自動収集イベントで使用。現在のページ(業務で定義したページではない)のアドレス。Webページではlocation.href、Android / iOSプラットフォームではカスタムのページパスが値になります |
| #url_path | ページパス | テキスト | 自動収集イベントで使用。現在のページ(業務で定義したページではない)のパス。値はlocation.pathnameです |
#referrer | 参照元アドレス | テキスト | 自動収集イベントで使用。遷移前のページ(業務で定義したページではない)のアドレス。Webページではdocument.referrer、Android / iOSプラットフォームではカスタムの遷移元ページパスが値になります |
| #referrer_host | 参照元ドメイン | テキスト | 自動収集イベントで使用。遷移前のページ(業務で定義したページではない)のドメイン。値はreferrerのhostです |
| #title | ページタイトル | テキスト | 自動収集イベントで使用。現在のページ(業務で定義したページではない)のタイトル。Webページではdocument.titleが値になります。AndroidプラットフォームではActivityのタイトル、つまりActivityのtitleプロパティの値です。iOSプラットフォームではView Controllerのタイトル、つまりcontroller.navigationItem.titleプロパティの値です |
| #screen_name | ページ名 | テキスト | 自動収集イベントで使用。ページ(業務で定義したページではない)の名前。AndroidプラットフォームではActivityのパッケージ名.クラス名、iOSプラットフォームではView Controllerのクラス名が値になります |
| #element_id | 要素ID | テキスト | 自動収集イベントで使用。コントロールのID |
| #element_type | 要素タイプ | テキスト | 自動収集イベントで使用。コントロールのタイプ |
| #resume_from_background | バックグラウンドからの復帰かどうか | ブール値 | 自動収集イベントで使用。アプリがバックグラウンドから復帰したかどうか。ブール型 |
| #element_selector | 要素セレクター | テキスト | 自動収集イベントで使用。コントロールのviewPath |
| #element_position | 要素の位置 | テキスト | 自動収集イベントで使用。コントロールの位置情報 |
| #element_content | 要素の内容 | テキスト | 自動収集イベントで使用。コントロール上の内容 |
| #scene | シーン値 | 数値 | WeChatミニプログラムの起動時に渡されるシーン値 |
| #mp_platform | ミニアプリプラットフォーム | テキスト | アプリが動作しているプラットフォームを示します |
| #app_crashed_reason | 例外情報 | テキスト | 自動収集イベントで使用。APPがクラッシュしたときのスタック情報を記録します |
| #zone_offset | タイムゾーンオフセット | 数値 | データ時刻のUTCからのオフセット時間数 |
#system_language | システムのデフォルト言語 | テキスト | ユーザーのデバイスのシステム言語(ISO 639-1、つまり小文字の英字2文字)。zh、enなど |
| #install_time | Appのインストール時間 | 時間 | ユーザーがアプリをインストールした時間。値はシステムから取得されます |
| #simulator | シミュレーターかどうか | 数値 | デバイスがシミュレーターかどうか(true/false) |
| #ram | メモリ(GB) | テキスト | ユーザーのデバイスの現在の空きメモリと総メモリ。単位はGB。1.4/2.4など |
| #disk | ディスク(GB) | テキスト | ユーザーのデバイスの現在の空きストレージ容量と総ストレージ容量。単位はGB。30/200など |
| #fps | FPS | 数値 | ユーザーのデバイスの現在のフレームレート(1秒あたりのフレーム数)。60など |
| #background_duration | バックグラウンド滞在時間 | 数値 | 2回のstartイベントの間で、アプリがバックグラウンドにあった時間を記録します。単位は秒 |
| #start_reason | 起動理由 | テキスト | アプリがlauncher以外の方法で起動された場合にのみ存在するプロパティです。deeplinkによる起動や、ほかのアプリからのstartActivityによる起動などが該当します。データの例:"#start_reason":"{"url":"thinkingdata:\/\/","data":""}" |
| #ua | 現在のユーザーエージェント情報 | テキスト | クライアントが使用しているOSとそのバージョン、CPUの種類、ブラウザとそのバージョン、ブラウザのレンダリングエンジン、ブラウザの言語、ブラウザのプラグインなどを識別できる情報です。 |
#utm | 広告キャンペーンのソースプロパティ | テキスト | ユーザーの流入元の広告情報。広告のソース、広告のメディアなどの情報を含みます |
- イベントテーブルのシステムフィールド
| フィールド名 | 画面表示名 | プロパティタイプ | 説明 |
|---|---|---|---|
| $part_event | イベントパーティションフィールド | テキスト | イベントパーティションフィールド。#event_name、つまりイベント名から取得します |
| $part_date | 日付パーティションフィールド | 時間 | 日付パーティションフィールド。#event_time、つまりイベントの発生日から取得します |
| #app_id | プロジェクトID | テキスト | イベントが属するプロジェクトのID |
| #user_id | ユーザー一意ID | 数値 | システム内でのユーザーの一意の識別子 |
| #account_id | アカウント ID | テキスト | アカウント ID。データ内の#account_idに相当します |
| #distinct_id | ゲストID | テキスト | ゲストID。データ内の#distinct_idに相当します |
| #event_name | イベント名 | テキスト | イベント名。データ内の#event_nameフィールドに相当します |
| #event_time | イベント時間 | 時間 | イベント時間。データ内の#timeフィールドに相当します |
| #server_time | サーバー時間 | 時間 | サーバーがデータを受信した時刻 |
| #dw_create_time | 初回格納時間 | 時間 | このイベントデータの格納時間。更新可能イベントでは、このプロパティはすべてnullです |
| #dw_update_time | 格納更新時間 | 時間 | このイベントデータの格納更新時間。更新可能イベント以外では、このプロパティはすべてnullです |
| #kafka_offset | kafkaオフセット | 数値 | kafka上でのイベントのオフセット値 |
| #uuid | UUID | テキスト | イベントの識別ID |
- ユーザーテーブルのシステムフィールド
| フィールド名 | 画面表示名 | プロパティタイプ | 説明 |
|---|---|---|---|
| #user_id | ユーザー一意ID | 数値 | システム内でのユーザーの一意の識別子 |
| #account_id | アカウント ID | テキスト | アカウント ID。データ内の#account_idに相当します |
| #distinct_id | ゲストID | テキスト | ゲストID。データ内の#distinct_idに相当します |
| #active_time | アクティベーション時刻 | 時間 | このユーザーの最初のデータ(イベントデータとユーザープロパティデータを含む)が格納されたときの、そのデータの#timeフィールドの時刻 |
| #reg_time | 登録時間 | 時間 | このユーザーのアカウント IDを含む最初のデータ(イベントデータとユーザープロパティデータを含む)が格納されたときの、そのデータの#timeフィールドの時刻 |
| #update_time | 更新日時 | 時間 | 最後に受信したユーザープロパティデータの#timeフィールドの時刻 |
| #server_time | サーバー時間 | 時間 | 最後に受信したユーザープロパティデータのサーバー時刻 |
| #dw_update_time | 格納更新時間 | 時間 | このユーザーデータの最新の更新時刻 |
| #event_date | 最新のイベント日付 | 数値 | このユーザーの最新のイベントが格納された日付 |
| #user_operation | ユーザー操作タイプ | テキスト | ユーザープロパティデータの操作タイプ |
| #kafka_offset | kafkaオフセット | 数値 | kafka上でのユーザープロパティデータのオフセット値 |
| #uuid | UUID | テキスト | ユーザープロパティデータの識別ID |

