Jump to Content
KARTE Developer Portal
HomeGuidesReference
KARTE Developer Portal
HomeGuidesReference

クイックスタート

  • はじめに
  • セットアップしよう
    • セットアップしよう（ウェブ）
    • セットアップしよう（アプリ）
  • イベントを送信しよう
    • イベントを送信しよう（ウェブ）
    • イベントを送信しよう（アプリ）
  • アクションを配信しよう
  • アクションをカスタマイズしよう

基本的な使い方

  • イベントを送信する
    • イベントの解析
    • 定義済みイベント
  • ユーザーを理解する
  • アクションをカスタマイズする
    • WebやNativeアプリへのアクション配信の仕組み
    • Widget APIでアクションをカスタマイズする
    • ユーザー情報を埋め込んでアクションする
    • テンプレート（Nunjucks）を利用する
    • アンケートの回答を KARTE に送る
    • CSSのモジュール化
  • チャットのカスタマイズを理解する
    • チャットからプロジェクトステータスを取得する
    • チャットメッセージをカスタマイズする
  • ネイティブアプリと連携する
  • チャットボットと繋げる
    • チャットボット連携のセットアップ
    • ユーザーにメッセージを送信する
    • ユーザーのメッセージを受け取る
    • ユーザーの担当者を変更する
    • ユーザーの担当者変更情報を受け取る
  • バッチでデータ連携する
  • API v2 を利用する
    • アプリを利用する
    • KARTE 内の変更を外部アプリケーションに送る
    • Bot を作成する
  • エディタ v2 のカスタムエディタを利用する
    • カスタムエディタを使ってみる
    • Action SDKの仕様について
    • アクションフック関数とアクションの状態
    • カスタムイベントの送信
    • カスタムエディタの変数について
    • カスタムエディタのイベントハンドラについて
    • スクリプトでデザインを修正する
    • ユーザー情報変数の利用
    • Web APIのTips
    • 外部モジュールの利用
    • スクリプトファイルの管理
    • コードエレメントについて

KARTE for App

  • KARTE for Appとは
  • iOS SDK Guides
    • SDKを導入する
    • イベントを送信する
    • アプリ内メッセージを表示する
    • プッシュ通知を受信する
    • 設定値を利用する
    • ビジュアルトラッキングを利用する
    • WebView内の行動をトラッキングする
    • リリースノート
    • アップグレードガイド
    • バージョニングポリシー
    • サポートポリシー
    • FAQ
    • Reference
    • Repository (GitHub)
  • iOS SDK Concepts
    • SDKの仕様について
    • — 利用可能なモジュール一覧
    • — 初期化オプション一覧
    • — SDKが標準で送るイベント
    • — イベントに自動追加されるフィールド
    • — 特別な扱いを受けるフィールド
    • — イベント送信の仕様について
    • — アプリ内メッセージの表示の仕組み
    • — アプリ内メッセージが非表示となる条件
    • — 画面の境界を認識する条件
    • SDKの各機能の使い方について
    • — Carthageを利用してSDKを導入する
    • — Objective-CからSDKを利用する
    • — SDK v1からv2のアップグレード方法
    • — カスタムURLスキームを設定する
    • — イベントの送信方法について理解する
    • — 広告ID（IDFA）を送信する
    • — オプトアウトに対応する
    • — アプリ内メッセージの表示を制御する
    • — アプリ内メッセージのリンクを制御する
    • — アプリ内メッセージの状態変化を検知する
    • — チャットの画像アップロードに対応する
    • — リッチプッシュ通知に対応する
    • — Universal Links に対応する
    • — アプリケーションのログアウトに対応する
    • — アクションからNative機能を呼び出す
    • — SDKログを出力する
  • Android SDK Guides
    • SDKを導入する
    • イベントを送信する
    • アプリ内メッセージを表示する
    • プッシュ通知を受信する
    • 設定値を利用する
    • ビジュアルトラッキングを利用する
    • WebView内の行動をトラッキングする
    • リリースノート
    • アップグレードガイド
    • バージョニングポリシー
    • サポートポリシー
    • FAQ
    • Reference
    • Repository (Github)
  • Android SDK Concepts
    • SDKの仕様について
    • — 利用可能なモジュール一覧
    • — 初期化オプション一覧
    • — SDKが標準で送るイベント
    • — イベントに自動追加されるフィールド
    • — 特別な扱いを受けるフィールド
    • — イベント送信の仕様について
    • — アプリ内メッセージの表示の仕組み
    • — アプリ内メッセージが非表示となる条件
    • — 画面の境界を認識する条件
    • SDKの各機能の使い方について
    • — SDK v1からv2のアップグレード方法
    • — カスタムURLスキームを設定する
    • — 難読化・最適化に対応する
    • — イベントの送信方法について理解する
    • — 広告ID（AAID）を送信する
    • — オプトアウトに対応する
    • — アプリ内メッセージの表示を制御する
    • — アプリ内メッセージのリンクを制御する
    • — アプリ内メッセージの状態変化を検知する
    • — チャットの画像アップロードに対応する
    • — 通知の表示をカスタマイズする
    • — アプリケーションのログアウトに対応する
    • — SDKログを出力する
    • — 再開されるActivityに対応する
  • React Native SDK
    • SDKを導入する
    • SDKを導入する (Expo)
    • イベントを送信する
    • アプリ内メッセージを表示する
    • プッシュ通知を受信する
    • 設定値を利用する
    • ビジュアルトラッキングを利用する
    • WebView内の行動をトラッキングする
    • リリースノート
    • アップグレードガイド
    • バージョニングポリシー
    • サポートポリシー
    • APIリファレンス
    • Repository (GitHub)
  • Flutter SDK
    • SDKを導入する
    • イベントを送信する
    • プッシュ通知を受信する
    • アプリ内メッセージを表示する
    • 設定値を利用する
    • ビジュアルトラッキング（Beta）を利用する
    • WebView内の行動をトラッキングする
    • リリースノート
    • アップグレードガイド
    • バージョニングポリシー
    • サポートポリシー
    • APIリファレンス
    • Repository (GitHub)
  • Unity SDK
    • SDKのセットアップ
    • SDKの初期化
    • イベントを送信する
    • アプリ内メッセージを表示する
    • プッシュ通知を受信する
    • 設定値を利用する
    • WebView内の行動をトラッキングする
    • リリースノート
    • サポートポリシー
    • APIリファレンス
    • Repository（GitHub）
  • Cordova SDK（Beta）
    • SDKを導入する
    • イベントを送信する
    • アプリ内メッセージを表示する
    • プッシュ通知を受信する
    • 設定値を利用する
    • アプリ内WebViewの行動をトラッキングする
    • リリースノート
    • サポートポリシー
    • Repository (GitHub)
  • プッシュ通知を送信する
    • サービスアカウントを設定する
    • テストメッセージを送信する
    • テストメッセージの送信対象ユーザーを探す
    • 通知ペイロードをカスタマイズする
  • 外部サービスと連携する
    • Adjust連携
    • AppsFlyer連携
  • FAQ
    • サポート・動作保証が終了したSDKを利用するとどのような影響がありますか？
    • クラッシュログはどのように取得できますか？
    • JCenterが閉鎖されますが影響はありますか？
    • SDKを導入するとビルドエラーが起きる
    • SDKのサイズはどれくらいですか？
    • iOS14におけるIDFAのオプトイン化の影響はありますか？
    • アプリの難読化・最適化に対応していますか？
    • Expoで開発したReact NativeアプリへのKARTE SDK導入は可能ですか？
    • Cordova以外のツールで開発したWebViewアプリへのKARTE SDK導入は可能ですか？
    • 標準で発生するイベントにフィールドを付加するのは可能ですか？
    • イベントの送信を監視することは可能ですか？
    • イベントの送信リクエストのタイムアウトは何秒ですか？
    • 送信できなかったイベントは再送（リトライ）されますか？
    • UserAgentをカスタマイズすることによる影響はありますか？
    • アプリ内WebViewの計測タグは無効化できますか
    • 意図しない画面にアプリ内メッセージが表示されてしまいます
    • アプリ内メッセージのレスポンシブ対応は可能ですか？
    • バックボタンでアプリ内メッセージを閉じることはできますか？
    • アプリ内メッセージで <select> タグは使えませんか？
    • アプリ内メッセージで動画の自動再生はできますか？
    • アプリ内メッセージからアプリにデータを渡すにはどうすれば良いですか？
    • アプリ内メッセージが特定の画面で表示されません
    • アプリ内の特定の画面に遷移させることは可能ですか？
    • UIWebViewは使用されていますか？
    • SKStoreReviewControllerとアプリ内メッセージはどちらが上に表示されますか？
    • 通知の開封を検知できません
    • ログアウト前のユーザーにデータを紐付けないようにすることは可能ですか？
    • 同一アカウントに複数台の端末でログインした場合どうなりますか？
    • 新OS対応版のSDKはいつリリースされますか？
    • 最新の Android OS で動作しますか？
    • 最新の iOS で動作しますか？
    • App-Bound Domains を有効にした場合はどうなりますか？
    • SDKはシミュレータでも動作しますか？

KARTE Talk

  • KARTE Talkとは
  • 設定をする
    • SendGrid（Mail）
    • LINE
    • ウェブプッシュ通知

KARTE Datahub

  • KARTE Datahub とは
  • データをKARTE内外と連携する
    • ジョブフローを設定する
    • データテーブルにインポートするファイルを作成する
    • データセットを参照できるGoogleサービスアカウントを払い出す
    • 外部のGoogleアカウントに権限を付与する
    • 外部サービス毎の連携設定をする
    • KARTEが払い出したGCSバケットを利用する
  • データセットを管理する
    • データセットとデータテーブル
    • Datahub がデフォルトで提供するデータテーブル
    • チャット関連のテーブルやビュー（β版）
    • Blocks関連のビュー
    • Message関連のビュー
    • データセットを作成する
    • 外部BigQueryのデータセットを登録する
    • KARTE Datahubのデータセットを外部に共有する
    • データセットを削除する
    • データテーブルを作成する
    • フェデレーションテーブルを作成する
    • データテーブルやインポートファイルのスキーマを指定する
    • データテーブルのレコードを更新する
    • データテーブルからレコードを削除する
    • 東京リージョンのデータセットを利用する（β版）
  • ユーザーにデータを紐付ける
    • 紐付けテーブルのレコードを追加・更新する
    • 紐付けテーブルを作成する
    • ユーザー紐付けの設定をする
    • ユーザー紐付けの仕組みを理解する
    • 紐付けテーブルからレコードを削除する
  • アクションテーブルからデータを参照する
    • アクションテーブルを作成する
    • アクションテーブルのレコードを追加・更新する
    • Widgetからアクションテーブルにアクセスする
    • Widget以外のアクションからアクションテーブルにアクセスする
    • アクションテーブルクエリを作成する
    • アクションテーブルからレコードを削除する
    • アクションテーブルモード
  • メール等をリスト配信する
    • クエリ結果をアクションに埋め込んで配信する
  • クエリでデータを抽出する
    • クエリを実行する
    • クエリパラメータを利用する
    • 外部Googleサービスアカウントのクエリリソースを使ってクエリを実行する
    • karte_eventテーブルへのクエリを作成する
    • クエリコレクションを活用する
    • サンプルクエリ集
    • クエリv2を利用する
  • Datahub利用の管理をする
    • Datahubに関する権限を設定する
    • Datahubの使用量を確認する
    • Datahubに関するシステム通知を受け取る
  • Datahub Direct Link を利用する
  • トラブルシューティング
    • ジョブフロー経由のファイルのインポートに失敗する
    • 管理画面経由のファイルのアップロードに失敗する
    • 型やヘッダー行の自動判別がうまくいかない
    • ジョブフローでのインポート時に全てのカラムが文字列になる
    • JSONなどクォーテーションを含むファイルのインポートに失敗する
    • Google Cloud Storageへの接続でエラーが発生する
    • Treasure Dataへの接続でエラーが発生する
    • SFTPへの接続でエラーが発生する
    • アクションテーブルへのデータ連携がうまくいかない
    • 紐付けテーブルのデータ紐付けがうまくいかない
    • クエリ実行時にエラーが発生する
    • 日時を表すデータのファイルインポートに失敗する
    • 繰り返し実行を有効にしたジョブフローが意図した時間に実行されない
    • ジョブフロー経由のファイルのエクスポートに失敗する
  • ジョブフローのトラブルシューティング
    • 共通のエラー
    • Google Spreadsheet
    • ターゲット配信
    • Google Cloud Storage (GCS)
    • Amazon S3
    • アクションテーブル
    • Marketo
    • 紐付けテーブル
    • SFTP
    • Salesforce Sales Cloud / Service Cloud
  • FAQ: ジョブフロー
    • インポートで指定したファイルが存在しない場合の挙動は？
    • インポートで指定したファイルが空の場合の挙動は？
    • ジョブの正常終了やエラー終了を検知する方法はありますか？
    • ヘッダー行が無いファイルをスキーマ指定ありでインポートできますか？
    • S3やGCSとの連携で、KARTE側のIPアドレスをホワイトリストに登録することはできますか？
    • ジョブフロー実行開始時に、前回ジョブフローが実行中の場合はどうなりますか？
    • テーブルのスキーマとジョブフローのスキーマが異なる場合はエラーになる？
    • ジョブフローを実行した後に途中で停止することはできますか？
    • ジョブフローでエクスポートするデータの順序は担保されますか？
    • 一つのジョブフロー内に複数のジョブが設定されている際に特定のジョブがエラーになった場合、後続のジョブは実行されますか？
  • FAQ: データセット・データテーブル・クエリ
    • 既存データテーブルのカラムを変更したい場合の手順は？
    • 既存データテーブルの一部のレコードを差分更新することはできますか？
    • データセットのレコード総数やデータ総量が上限を超えないようにするには？
    • 1万レコードを超えるクエリ結果をダウンロードする方法は？
    • クエリのCURRENT_DATE()などのタイムゾーンは？
    • 外部GoogleアカウントからDatahubを参照した場合のコストは？
    • クエリリソース処理量の概算が実際の処理量から大幅にズレる理由は？
  • FAQ: 紐付けテーブル
    • 紐付けテーブルに対してクエリを実行することはできますか？
    • 紐付けテーブルで1人のユーザーに複数レコードを紐付けることはできますか？
    • 紐付けテーブルに主キー重複ありのレコードを追加できますか？
    • 紐付けテーブルの紐付けが完了したことを確認する方法は？
    • セグメントの条件に使っている紐付けテーブルを削除するとどうなりますか？
    • 複数の紐付けテーブルで同じフィールドを紐付けた場合、どちらが優先されますか？
    • 紐付けテーブルを効率的に運用するには？
    • 紐付けテーブルのデータをダウンロードしたい
    • 紐付けテーブルで名寄せに使うフィールドに制約はありますか？
    • 紐付けテーブルのデータをデータセットにインポートするとデータが文字列型になる
    • 既存の紐付けテーブルをスキーマの異なるデータで更新できますか？
    • 紐付けテーブルで紐付けたフィールドを別の紐付けテーブルの「紐付け対象のフィールド」に指定できますか？
  • FAQ: アクションテーブル
    • アクションテーブルに対してSQLクエリを実行することはできますか？
    • アクションテーブルに主キー重複ありのレコードを追加できますか？
    • あるアクションテーブルをジョブフローから全件削除することはできますか？
    • アクションテーブルとユーザー情報変数とDatahubクエリフィールドの使い分けは？
  • FAQ: その他
    • 管理画面からのファイルインポートは、ジョブフロー機能を使ったインポートと違いありますか？
    • クエリリソース消費を節約するには？
  • 制限事項

外部サービス連携

  • 外部サービス毎のデータ連携作業をする
    • Google Cloud Storage
    • Amazon S3
    • Azure Blob Storage
    • Azure Blob Storage (Storage Transfer Service) (β版)
    • SFTP
    • Treasure Data
    • Google BigQuery
    • Googleスプレッドシート
    • Google Drive（β版）
    • Salesforce Sales Cloud / Service Cloud
    • Salesforce Marketing Cloud（sFTP連携）
    • Salesforce Marketing Cloud（API連携）
    • Looker
    • Tableau Desktop
    • Looker Studio（旧Google データポータル）
    • Chartio
    • Mode Analytics
    • Microsoft Power BI Desktop
    • DOMO
    • MotionBoard
    • Googleアナリティクス
    • Adobe Analytics
    • Marketo（β版）
    • Web File API（β版）
    • trocco（β版）
    • Reckoner（β版）
    • Xplenty（β版）
    • Snowflake（β版）
    • FANSHIP（β版）
    • Teradata Vantage
  • 固定IPアドレスから外部サービスと連携する
  • ファイルパスを動的に指定する
  • プレフィックスを動的に指定する

KARTE Live

  • KARTE Live とは
  • JavaScript API
    • レコード開始/停止を任意に制御する

ソリューション

  • Amazon EventBridge連携

KARTE CrafT

  • KARTE Craftとは
  • 権限設定
  • Craft Functions
    • Craft Functionsの作成、編集、削除
    • Craft Functionsの書き方
  • Craft Functionsで利用できるモジュール
    • secret
    • logger
    • kvs
    • karteApiClientForCraftTypeApp
    • RetryableError
    • npm modules
  • Craft Functionsのトリガー
    • Function実行時に受け取るデータ
    • サーバーサイドアクション
    • Hook v2
    • Craft Scheduler
    • Craft LINE Hook
    • Datahub Jobflow Connector
    • Craft Endpoint
  • Craft Secret Manager
  • Craft Key-Value Store
  • Craft AI Modules
  • ハンズオン
    • 接客スケジュールを複数設定する
    • ユーザーの天気情報に基づく接客

リリースノート

Suggest Edits

0.1.0（2020/8/07）

初回リリース

Updated about 3 years ago

  • Table of Contents
    • 0.1.0（2020/8/07）
KARTE © 2015 PLAID, Inc.
  • Guides
  • Reference