KARTE Developer Portal
ガイド
リファレンス
サポート
Home
ガイド
リファレンス
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
ガイド
リファレンス
discard
Save Edits
Submit
Suggested Edits
Search results for "
{{ search.query }}
"
No results found for "{{search.query}}".
Documentation {{result.subdomain ? 'in ' + result.subdomain : ''}}
{{result.method}}
Reference {{result.subdomain ? 'in ' + result.subdomain : ''}}
Changelog {{result.subdomain ? 'in ' + result.subdomain : ''}}
Discussions {{result.subdomain ? 'in ' + result.subdomain : ''}}
Page {{result.subdomain ? 'in ' + result.subdomain : ''}}
View All Results
クイックスタート
はじめに
セットアップしよう
セットアップしよう（ウェブ）
セットアップしよう（アプリ）
イベントを送信しよう
イベントを送信しよう（ウェブ）
イベントを送信しよう（アプリ）
アクションを配信しよう
アクションをカスタマイズしよう
基本的な使い方
イベントを理解する
イベントの解析
定義済みイベント
ユーザーを理解する
アクションのカスタマイズを理解する
Widget APIでアクションをカスタマイズする
ユーザー情報変数を理解する
テンプレート（Nunjucks）を利用する
アンケートの回答を KARTE に送る
CSSのモジュール化を理解する
チャットのカスタマイズを理解する
チャットからプロジェクトステータスを取得する
チャットメッセージをカスタマイズする
チャット対応終了時にアンケートを表示する
KARTE Appsを理解する
KARTE Apps をセットアップする
API リクエストの認証・認可を行う
Webhook を利用して通知を受け取る
アプリと連携する
チャットボットと繋げる
チャットボット連携のセットアップ
ユーザーにメッセージを送信する
ユーザーのメッセージを受け取る
ユーザーの担当者を変更する
ユーザーの担当者変更情報を受け取る
タグをカスタマイズする
計測タグをカスタマイズする
バッチでデータ連携する
KARTE for App
KARTE for Appとは
iOS SDK
SDKのセットアップ
SDKの初期化
イベントを送信する
プッシュ通知を受信する
リッチプッシュ通知を受信する
アクションを配信する
設定値を利用する
ビジュアルトラッキングを利用する（Beta）
WebViewのトラッキングを行う
よく聞かれる質問
トラブルシューティング
リリースノート
アップグレードガイド
サポートポリシー
SDKのパフォーマンス
iOS SDK v2
SDKを導入する
イベントを送信する
アプリ内メッセージを表示する
プッシュ通知を受信する
設定値を利用する
ビジュアルトラッキングを利用する
WebView内の行動をトラッキングする
リリースノート
アップグレードガイド
サポートポリシー
FAQ
Reference
Repository (GitHub)
iOS SDK v2 Appendix
初期化オプション一覧
イベントに自動追加されるフィールド
特別な扱いを受けるフィールド
アクションが非表示となる条件
広告ID（IDFA）を送信する
オプトアウトに対応する
SDKログを出力する
アプリケーションのログアウトに対応する
チャットの画像アップロードに対応する
リッチプッシュ通知に対応する
Objective-CからSDKを利用する
SDK v1からv2のアップグレード方法
Android SDK
SDKのセットアップ
SDKの初期化
イベントを送信する
プッシュ通知を受信する
アクションを配信する
設定値を利用する
ビジュアルトラッキングを利用する（Beta）
WebViewのトラッキングを行う
よく聞かれる質問
トラブルシューティング
リリースノート
アップグレードガイド
サポートポリシー
SDKのパフォーマンス
Android SDK v2
SDKを導入する
イベントを送信する
プッシュ通知を受信する
アプリ内メッセージを表示する
設定値を利用する
ビジュアルトラッキングを利用する
WebView内の行動をトラッキングする
リリースノート
アップグレードガイド
サポートポリシー
FAQ
Reference
Repository (Github)
Android SDK v2 Appendix
初期化オプション一覧
イベントに自動追加されるフィールド
特別な扱いを受けるフィールド
アクションが非表示となる条件
広告ID（AAID）を送信する
オプトアウトに対応する
SDKログを出力する
アプリケーションのログアウトに対応する
チャットの画像アップロードに対応する
通知の表示をカスタマイズする
React Native SDK（Beta）
SDKのセットアップ
SDKのセットアップ（iOS）
SDKのセットアップ（Android）
SDKの初期化
イベントを送信する
プッシュ通知を受信する
アクションを配信する
設定値を利用する
WebViewのトラッキングを行う
よく聞かれる質問
トラブルシューティング
リリースノート
アップグレードガイド
サポートポリシー
Cocos2d-x SDK（Beta）
SDKのセットアップ（iOS）
SDKのセットアップ（Android）
SDKの初期化
イベントを送信する
アクションを配信する（iOS）
アクションを配信する（Android）
設定値を利用する
リリースノート
サポートポリシー
Unity SDK（Beta）
SDKのセットアップ
SDKの初期化
イベントを送信する
アクションを配信する（iOS）
アクションを配信する（Android）
プッシュ通知を受信する
設定値を利用する
APIリファレンス
リリースノート
サポートポリシー
Cordova SDK v2（Beta）
SDKを導入する
イベントを送信する
アプリ内メッセージを表示する
プッシュ通知を受信する
設定値を利用する
リリースノート
サポートポリシー
プッシュ通知を送信する
サービスアカウントを設定する
テストメッセージを送信する
通知ペイロードをカスタマイズする
外部サービスと連携する
Adjust連携
AppsFlyer連携
KARTE Talk
KARTE Talkとは
設定をする
SendGrid（Mail）
LINE
ウェブプッシュ通知
KARTE Datahub
KARTE Datahub とは
データをKARTE内外と連携する
ジョブフローを設定する
データテーブルにインポートするファイルを作成する
データセットを参照できるGoogleサービスアカウントを払い出す
外部のGoogleアカウントに権限を付与する
外部サービス毎の連携設定をする
KARTEが払い出したGCSバケットを利用する
データセットを管理する
データセットとデータテーブル
Datahub がデフォルトで提供するデータテーブル
チャット関連のテーブルやビュー（β版）
データセットを作成する
データセットを外部に共有する
データセットを削除する
データテーブルを作成する
フェデレーションテーブルを作成する
データテーブルのスキーマを指定する
データテーブルのレコードを更新する
データテーブルからレコードを削除する
ユーザーにデータを紐付ける
紐付けテーブルのレコードを追加・更新する
紐付けテーブルを作成する
ユーザー紐付けの設定をする
ユーザー紐付けの仕組みを理解する
紐付けテーブルからレコードを削除する
アクションからデータを参照する
アクションテーブルを作成する
アクションテーブルのレコードを追加・更新する
Widgetからアクションテーブルにアクセスする
Widget以外のアクションからアクションテーブルにアクセスする
アクションテーブルクエリを作成する
アクションテーブルからレコードを削除する
アクションテーブルモード
メール等をリスト配信する
クエリ結果をアクションに埋め込んで配信する
クエリでデータを抽出する
クエリを実行する
クエリパラメータを利用する
karte_eventテーブルへのクエリを作成する
クエリコレクションを活用する
サンプルクエリ集
Datahub利用の管理をする
Datahubに関する権限を設定する
Datahubの使用量を確認する
Datahubに関するシステム通知を受け取る
トラブルシューティング
ジョブフロー経由のファイルのインポートに失敗する
管理画面経由のファイルのアップロードに失敗する
型やヘッダー行の自動判別がうまくいかない
JSONなどクォーテーションを含むファイルのインポートに失敗する
Google Cloud Storageへの接続でエラーが発生する
Google Spreadsheetへの接続でエラーが発生する
Treasure Dataへの接続でエラーが発生する
SFTPへの接続でエラーが発生する
アクションテーブルへのデータ連携がうまくいかない
紐付けテーブルのデータ紐付けがうまくいかない
クエリ実行時にエラーが発生する
日時を表すデータのファイルインポートに失敗する
繰り返し実行を有効にしたジョブフローが意図した時間に実行されない
FAQ: ジョブフロー
インポートで指定したファイルが無い場合の挙動は？
ジョブの正常終了やエラー終了を検知する方法はありますか？
ヘッダー行が無いファイルをスキーマ指定ありでインポートできますか？
S3やGCSとの連携で、KARTE側のIPアドレスをホワイトリストに登録することはできますか？
ジョブフロー実行開始時に、前回ジョブフローが実行中の場合はどうなりますか？
テーブルのスキーマとジョブフローのスキーマが異なる場合はエラーになる？
ジョブフローを実行した後に途中で停止することはできますか？
FAQ: データセット・データテーブル・クエリ
既存データテーブルのカラムを変更したい場合の手順は？
既存データテーブルの一部のレコードを差分更新することはできますか？
データセットのレコード総数やデータ総量が上限を超えないようにするには？
1万レコードを超えるクエリ結果をダウンロードする方法は？
クエリのCURRENT_DATE()などのタイムゾーンは？
外部GoogleアカウントからDatahubを参照した場合のコストは？
FAQ: 紐付けテーブル
紐付けテーブルに対してクエリを実行することはできますか？
紐付けテーブルで1人のユーザーに複数レコードを紐付けることはできますか？
紐付けテーブルに主キー重複ありのレコードを追加できますか？
紐付けテーブルの紐付けが完了したことを確認する方法は？
セグメントの条件に使っている紐付けテーブルを削除するとどうなりますか？
複数の紐付けテーブルで同じフィールドを紐付けた場合、どちらが優先されますか？
日次連携される全件データに含まれないレコードを紐付けテーブルから削除したい
紐付けテーブルを効率的に運用する
紐付けテーブルのレコード件数を確認できますか？
紐付けテーブルのデータをダウンロードしたい
FAQ: アクションテーブル
アクションテーブルに対してSQLクエリを実行することはできますか？
アクションテーブルに主キー重複ありのレコードを追加できますか？
あるアクションテーブルをジョブフローから全件削除することはできますか？
FAQ: その他
管理画面からのファイルインポートは、ジョブフロー機能を使ったインポートと違いありますか？
制限事項
外部サービス連携
外部サービス毎のデータ連携作業をする
Google Cloud Storage
Amazon S3
Azure Blob Storage（β版）
SFTP
Treasure Data
BigQuery
Googleスプレッドシート
Salesforce Sales Cloud / Service Cloud
Salesforce Marketing Cloud（sFTP連携）
Salesforce Marketing Cloud（API連携）
Looker
Tableau Desktop
Google データポータル
Chartio
Power BI Desktop
DOMO
Googleアナリティクス
Adobe Analytics
Web File API（β版）
trocco（β版）
固定IPアドレスから外部サービスと連携する
Support
V1 API
API 概要
Request URL
Request Headers
認証・承認
Response
API 制限
Scope
API一覧
Event
Track API
Talk
Message API
Assign API
Note API
Chat Status API
Datahub
Jobflow API
User
User Detail API
User List API
Campaign
Update Status API
Segment
Segment API
WEBHOOK
Webhook 概要
Request
Response
Talk関連Webhook一覧
Talk関連Webhook
Message Webhook
Message Operator Webhook
Assign Webhook
JS SDK
JS SDKについて
tracker
tracker.init
tracker.view
tracker.track
tracker.user
tracker.form
tracker.link
暗号化
Native SDK (iOS v1)
KarteTracker
sharedTracker
appKey
config
visitorId
sharedTrackerWithAppKey:
setupWithAppKey:
setupWithAppKey:withConfig:
initWithAppKey:
initWithAppKey:withConfig:
track:values:
track:values:view:
trackNotification:
identify:
identify:view:
view:
view:title:
view:title:values:
view:title:values:view:
view:values:
registerFCMToken:
logoutWithCompletionBlock:
logout
renewVisitorId
optOut
optIn
KarteTrackerConfig
configure
trackEndpoint
overlayEndpoint
enabledTrackingAppLifecycle
enabledTrackingAppOpen
enabledTrackingIdfa
enabledTrackingCrashError
enabledFCMTokenResend
enabledVisualTracking
enabledOptOutDefault
dryRun
IDFADelegate
initWithBuilder:
configureWithBuilder:
KarteTrackerConfigBuilder
trackEndpoint
overlayEndpoint
enabledTrackingAppLifecycle
enabledTrackingAppOpen
enabledTrackingIdfa
enabledTrackingCrashError
enabledFCMTokenResend
enabledVisualTracking
enabledOptOutDefault
dryRun
IDFADelegate
KarteTrackerJsUtil
stringByAppendingUserSyncQueryParameter:withURLString:
URLByAppendingUserSyncQueryParameter:withURL:
userSyncQueryParameter:
KarteRemoteNotificationHandler
canHandleRemoteNotification:
handleRemoteNotification:
retrieveURLFromUserInfo:
KarteLogger
sharedLogger
logLevel
KarteLogLevel
KarteLogLevelOff
KarteLogLevelError
KarteLogLevelWarn
KarteLogLevelInfo
KarteLogLevelDebug
KarteLogLevelVerbose
KarteVariable
campaignId
shortenId
isDefined
string
array
dictionary
stringWithDefaultValue:
integerWithDefaultValue:
doubleWithDefaultValue:
boolWithDefaultValue:
arrayWithDefaultValue:
dictionaryWithDefaultValue:
KarteVariables
variables
initWithAppKey:
variablesWithAppKey:
fetch
fetch
fetchWithCompletionBlock:
fetchWithCompletionBlock:
variableForKey:
variableForKey:
trackWithVariables:withEventName:
trackWithVariables:withEventName:withValues:
trackWithVariables:withEventName:
trackWithVariables:withEventName:withValues:
KarteInAppMessagingManager
sharedManager
delegate
presenting
dismiss
suppress
unsuppress
KarteInAppMessagingManagerDelegate
inAppMessagingManager:shouldOpenURL:
KarteIDFADelegate
advertisingIdentifierString
isAdvertisingTrackingEnabled
KarteUrlSchemeHandler
handle:
Native SDK (iOS v2)
Reference
Native SDK (Android v1)
Tracker
init(Context context, String key)
init(Context context, String key, TrackerConfig config)
getInstance(Context context, String key)
getInstance(Context context)
getInstance()
getVisitorId()
getAppKey()
getInAppMessagingManager()
track(String eventName, JSONObject values)
track(String eventName, JSONObject values, boolean withAppInfo)
track(String eventName, Bundle values)
track(String eventName, Bundle values, boolean withAppInfo)
identify(JSONObject values)
identify(Bundle values)
view(String viewName)
view(String viewName, String title)
view(String viewName, String title, JSONObject values)
view(String viewName, JSONObject values)
view(String viewName, String title, Bundle values)
view(String viewName, Bundle values)
trackFcmToken(String token)
logout(CompletionHandler completionHandler)
logout()
renewVisitorId()
optOut()
optIn()
Tracker.CompletionHandler
onCompleted(boolean isSuccessful)
TrackerConfig
getTrackEndpoint()
getOverlayEndpoint()
enabledTrackingCrashError()
enabledFCMTokenResend()
enabledTrackingAaid()
isDryRun()
autoControlSoftInputAdjust()
enabledTrackerOptOut()
TrackerConfig.Builder
Builder()
build()
setTrackEndpoint(String trackEndpoint)
setOverlayEndpoint(String overlayEndpoint)
setEnableTrackingCrashError(boolean enableTrackingCrashError)
setEnableFCMTokenResend(boolean enableFCMTokenResend)
setEnableTrackingAaid(boolean enableTrackingAaid)
setDryRun(boolean dryRun)
setAutoControlSoftInputAdjust(boolean autoControlSoftInputAdjust)
setEnableTrackerOptOut(boolean enableTrackerOptOut)
TrackerJsUtil
QUERY_KEY_USER_SYNC
appendUserSyncQueryParameter(Context context, String appKey, String url)
appendUserSyncQueryParameter(Context context, String appKey, Uri uri)
buildUserSyncParameter(Context context, String appKey)
KRLog
VERBOSE
DEBUG
INFO
WARN
ERROR
setLevel(int minLevel)
Variable
getCampaignId()
getShortenId()
getString(String defaultValue)
getLong(long defaultValue)
getDouble(double defaultValue)
getBoolean(boolean defaultValue)
getJSONObject(JSONObject defaultValue)
getJSONArray(JSONArray defaultValue)
Variables
getInstance(Context context)
getInstance(Context context, String appKey)
fetch()
fetch(final CompletionHandler completionHandler)
getVariable(String key)
track(Iterable<Variable> variables, String eventName)
track(Iterable<Variable> variables, String eventName, JSONObject values)
Variables.CompletionHandler
onCompleted(boolean isSuccessful)
KarteFirebaseInstanceIdService
getToken()
onTokenRefresh()
getTracker()
KarteMessageHandler
EXTRA_PUSH_FLAG
EXTRA_CAMPAIGN_ID
EXTRA_SHORTEN_ID
copyInfoToIntent(Map<String, String> data, Intent intent)
MessageHandler
KARTE_PUSH_NOTIFICATION_FLAG
KARTE_MASS_PUSH_NOTIFICATION_FLAG
EXTRA_CAMPAIGN_ID
EXTRA_SHORTEN_ID
EXTRA_MASS_PUSH_ID
canHandleMessage(RemoteMessage message)
handleMessage(Context context, RemoteMessage message)
handleMessage(Context context, RemoteMessage message, Intent defaultIntent)
copyInfoToIntent(Map<String, String> data, Intent intent)
extractKarteAttributes(Context context, RemoteMessage message)
KarteAttributes
getBody()
getBigImage()
getLink()
getChannel()
getSound()
getTitle()
InAppMessagingManager
dismiss()
isPresenting()
setOnOpenURLListener(OnOpenURLListener listener)
removeOnOpenURLListener()
registerPopupWindow(PopupWindow popupWindow)
registerWindow(Window window)
InAppMessagingManager.OnOpenURLListener
shouldOverrideOpenURL(Uri uri);
Native SDK (Android v2)
Reference
React Native SDK
KarteTracker
getAppKey
getVisitorId
track
view
identify
registerFCMToken
optOut
optIn
renewVisitorId
KarteTrackerJsUtil
appendUserSyncQueryParameter
KarteInAppMessagingManager
isPresenting
dismiss
suppress
unsuppress
KarteVariables
fetch
variable
track
KarteVariable
string
integer
double
bool
array
object
Cocos2d-x SDK
KarteTrackerCpp
getAppKey
getVisitorId
setup
setupWithConfig
optOut
optIn
track
trackNotification
identify
logout
registerFCMToken
KarteTrackerConfigCpp
setTrackEndpoint
setOverlayEndpoint
setIsEnabledTrackingAppLifecycle
setIsEnabledTrackingAppOpen
setIsEnabledTrackingCrashError
setIsEnabledFCMTokenResend
setIsEnabledOptOutDefault
setIsDryRun
setIsEnabledTrackingAaid
KarteLoggerCpp
setLogLevelError
setLogLevelWarn
setLogLevelInfo
setLogLevelDebug
setLogLevelVerbose
KarteVariableCpp
getCampaignId
getShortenId
getString
getIsDefined
getArrayJson
getDictionaryJson
getBool
getInteger
getDouble
KarteVariablesCpp
fetchWithCompletion
variableForKey
trackWithVariables
KarteInAppMessagingManagerCpp
dismiss
isPresenting
setDelegate
KarteInAppMessagingManagerDelegateCpp
shouldOpenUrl
Action API
Action APIとは
テンプレート変数
静的変数
プリセット変数
ユーザー情報変数
テンプレート構文（Nunjucks）
Tag Syntax
変数
if
for
set
Filters
算術演算子
比較演算子
論理演算子
Pluginの静的変数
Line
Widget API
Widget API とは
HTML ディレクティブ
krt-text
krt-html
krt-if / krt-else
krt-show
krt-for
krt-on
krt-bind
krt-model
HTML クラス
karte-close
widget
widget.show
widget.hide
widget.setVal
widget.getVal
widget.onChangeVal
widget.method
widget.on
widget.setState
widget.getState
widget.collection
widget.addChoiceAnswer
widget.addFreeAnswer
widget.removeAnswer
widget.getAnsweredQuestion
widget.getAnsweredQuestionIds
widget.sendAnswer
widget.sendAnswers
widget.storage.memory.store
widget.storage.memory.restore
widget.storage.local.store
widget.storage.local.restore
chat
chat.option
chat.open
chat.close
chat.activate
chat.deactivate
chat.send
chat.getProjectStatus
chat.fetchProjectStatus
chat.emitter.on
chat message
Buttons UI
Links UI
Input UI
Confirm Card UI
Input Card UI
Button Object
Link Object
Input Object
Action Object
collection
table.get(key)
table.get(keys)
table.getByQuery()
table.query()
table.set()
record.field()
record.set()
field.set()