Leanplumコネクタの構成ガイド | サーバーサイドコネクタ

API情報

このコネクタは、次のベンダーAPIを使用します：

API名：Leanplum API
APIバージョン：v1.0
APIエンドポイント：https://api.leanplum.com/api
ドキュメント：Leanplum API

コネクタアクション

アクション名	AudienceStream	EventStream
複数リクエストの送信（バッチ処理）	✓	✓
ユーザ属性の構成	✓	✓
メッセージの送信	✓	✓
イベントのトラッキング	✓	✓

構成の構成

コネクタマーケットプレイスに移動し、新しいコネクタを追加します。コネクタの追加方法については、コネクタの概要の記事を参照してください。

コネクタを追加した後、以下の構成を構成します：

App ID：アプリケーションID。自分のアプリをナビゲーションカラムで選択し、[アプリの管理]をクリックして、[キーと構成]をクリックして、自分のアプリのIDを見つけます。
APIバージョン：使用するLeanplum APIのバージョン。
クライアントキー：Leanplumアプリの本番キー。

アクション

アクションの名前を入力し、ドロップダウンメニューからアクションのタイプを選択します。

このセクションでは、各アクションのパラメータとオプションの構成方法について説明します。

複数リクエストの送信（バッチ処理）

バッチ制限

このアクションは、ベンダーへの高容量データ転送をサポートするためにバッチリクエストを使用します。リクエストは、次のいずれかの閾値に達するまでキューに入れられます：

最大リクエスト数：50
最も古いリクエストからの経過時間の最大値：10分
リクエストの最大サイズ：1MB

パラメータ

パラメータ	説明
アクション	APIアクション
時間	リクエストが発行された時間（UNIX時間）。これは、LeanplumとAPI呼び出し元の時間差を解決するために使用されます。
ユーザID	現在のユーザID。会社がユーザIDとして使用するものに構成できます。デバイスIDを使用する場合は空白のままにします。詳細については、ユーザの選択を参照してください。
デバイスID	デバイスの固有ID。
App ID	アプリケーションID。自分のアプリをナビゲーションカラムで選択し、[アプリの管理]をクリックして、[キーと構成]をクリックして、自分のアプリのIDを見つけます。
APIバージョン	使用するLeanplum APIのバージョン。
作成ディスポジション	APIによってユーザが作成されるかどうかを決定するポリシー。このメソッドのデフォルト値はCreateIfNeededです。可能な値は次のとおりです： CreateIfNeeded：指定されたIDでユーザが存在しない場合、ユーザを作成します。 CreateNever：ユーザが既に存在する必要があります。存在しない場合、API呼び出しがスキップされ、警告が返されます。
Devモード	ユーザが開発モードにあるかどうか（リクエストに関連するユーザが開発者であり、ユーザではない場合）。レポート目的で重要です。デフォルト値：`false`。
イベント	イベントの名前。収益を示すために「Purchase」を使用し、イベント値を収益とします。
メッセージID	このイベントに関連するメッセージID。ユーザのメッセージとのやり取りを追跡するために構成します。メッセージの送信または表示を追跡するには、イベント引数を空の文字列に構成します。
ディスポジション	トラッキングされたイベントがセッションとユーザのアクティビティにどのように影響するかを決定します。存在する場合、ディスポジションは次のいずれかの値を持っている必要があります： `active` これがデフォルト値です。ユーザのアクティビティを反映するイベントに使用されます。アクティブなイベントはユーザをアクティブとしてマークし、セッション内で追跡する必要があります。非推奨のオプション`allowOffline: false`を置き換えます。 `passive` ユーザのアクティビティに対応しないイベントに使用されます。これらのイベントはセッション内で発生する必要はなく、ユーザをアクティブとしてマークしません。例：ユーザにメッセージを送信する場合、ユーザに影響を与えますが、ユーザのアクティビティを表すものではありません。非推奨のオプション`allowOffline: true`を置き換えます。 `requireActive` セッション内でのみ追跡する必要があるイベントに使用されます。これらのイベントは、ユーザにアクティブなセッションがない場合、警告応答とともに`ignored: true`を返します。警告メッセージは変更される可能性があるため、クライアントはignoredフィールドで警告を検出する必要があります。
Force	ユーザがターゲット条件を満たしているかどうかに関係なく、メッセージを送信するかどうかを指定します。デフォルト：`false`。
作成日時	ユーザが作成された時間（1970年1月1日午前0時（UTC）からの経過秒数）。
最終アクティブ日時	ユーザが最後にアクティブになった時間（1970年1月1日午前0時（UTC）からの経過秒数）。
総セッション数	ユーザが生涯で持っているセッションの総数。
アプリ内での経過時間	ユーザの生涯でアプリ内で過ごした合計秒数。
ロケール	ユーザがいる現在のロケール。例：en_US。
国	ユーザがいる国。ISO 2文字コードで指定します。例：アメリカ合衆国の場合はUS。ユーザのIPアドレスに基づいて国を検出するには、(detect)に構成します。
地域	ユーザがいる地域（州）。例：カリフォルニア州の場合はca。ユーザのIPアドレスに基づいて地域を検出するには、(detect)に構成します。
都市	ユーザがいる都市。例：サンフランシスコ。ユーザのIPアドレスに基づいて都市を検出するには、(detect)に構成します。
位置	ユーザの位置（緯度/経度）。例：37.775、-122.4183。ユーザのIPアドレスに基づいて位置を検出するには、(detect)に構成します。
位置の精度タイプ	提供される位置のタイプ（IP、CELL、またはGPS）。デフォルト：IP。
タイムゾーン	ユーザのタイムゾーンの略称。タイムゾーンの略称のリストを参照してください。
タイムゾーンオフセット（秒）	GMTからのタイムゾーンオフセット（秒）。
ユーザ属性	ユーザ属性のマップ（キーと値のペア）。各キーは文字列である必要があります。属性はセッション間で保存されます。指定された属性のみが更新されます（例：既存の属性を省略すると、保持されます）。
追加するユーザ属性値	既存のユーザ属性セットに追加する値のマップ。たとえば、既存のInterestsセットにSportsを追加するには、{“Interests”:“Sports”}を指定します。
値	イベントの値。たとえば、購入イベントの場合、これは購入価格になります。
通貨コード	値に関連するISO 4217通貨コード。Leanplumは、値を優先通貨に自動的に変換しますが、元の価格と通貨コードはイベントパラメータlocalCurrencyとlocalPriceとして保持されます。通貨換算レートは毎時更新されます。
時間	イベントが発生したUNIXタイムスタンプを指定するオプション。現在の時間と異なる場合があります。
情報	イベントに添付された情報。
パラメータ	キーと値のペアとしてのパラメータのフラットオブジェクト。各キーは文字列であり、最大50個のパラメータを構成できます。
値	メッセージで使用されるテンプレート変数を上書きするキーと値のJSONオブジェクト。

ユーザ属性の構成

パラメータ

パラメータ	説明
ユーザID	現在のユーザID。会社がユーザIDとして使用するものに構成できます。デバイスIDを使用する場合は空白のままにします。詳細については、ユーザの選択を参照してください。
デバイスID	デバイスの固有ID。
ユーザ属性	ユーザ属性のマップ（キーと値のペア）。各キーは文字列である必要があります。属性はセッション間で保存されます。指定された属性のみが更新されます（例：既存の属性を省略すると、保持されます）。
App ID	アプリケーションID。自分のアプリをナビゲーションカラムで選択し、[アプリの管理]をクリックして、[キーと構成]をクリックして、自分のアプリのIDを見つけます。
APIバージョン	使用するLeanplum APIのバージョン。
作成ディスポジション	APIによってユーザが作成されるかどうかを決定するポリシー。このメソッドのデフォルト値はCreateIfNeededです。可能な値は次のとおりです： CreateIfNeeded：指定されたIDでユーザが存在しない場合、ユーザを作成します。 CreateNever：ユーザが既に存在する必要があります。存在しない場合、API呼び出しがスキップされ、警告が返されます。
追加するユーザ属性値	既存のユーザ属性セットに追加する値のマップ。たとえば、既存のInterestsセットにSportsを追加するには、{“Interests”:“Sports”}を指定します。
Devモード	ユーザが開発モードにあるかどうか、たとえば、リクエストに関連するユーザが開発者であり、ユーザではない場合。レポート目的で重要です。デフォルト：`false`。
作成日時	ユーザが作成された時間（1970年1月1日午前0時（UTC）からの経過秒数）。
最終アクティブ日時	ユーザが最後にアクティブになった時間（1970年1月1日午前0時（UTC）からの経過秒数）。
総セッション数	ユーザが生涯で持っているセッションの総数。
アプリ内での経過時間	ユーザの生涯でアプリ内で過ごした合計秒数。
ロケール	ユーザがいる現在のロケール。例：en_US。
国	ユーザがいる国。ISO 2文字コードで指定します。例：アメリカ合衆国の場合はUS。ユーザのIPアドレスに基づいて国を検出するには、(detect)に構成します。
地域	ユーザがいる地域（州）。例：カリフォルニア州の場合はca。ユーザのIPアドレスに基づいて地域を検出するには、(detect)に構成します。
都市	ユーザがいる都市。例：サンフランシスコ。ユーザのIPアドレスに基づいて都市を検出するには、(detect)に構成します。
位置	ユーザの位置（緯度/経度）。例：37.775、-122.4183。ユーザのIPアドレスに基づいて位置を検出するには、(detect)に構成します。
位置の精度タイプ	提供される位置のタイプ（IP、CELL、またはGPS）。デフォルト：IP。
タイムゾーン	ユーザのタイムゾーンの略称。タイムゾーンの略称のリストを参照してください。
タイムゾーンオフセット（秒）	GMTからのタイムゾーンオフセット（秒）。

イベントのトラッキング

パラメータ

パラメータ	説明
ユーザID	現在のユーザID。会社がユーザIDとして使用するものに構成できます。デバイスIDを使用する場合は空白のままにします。詳細については、ユーザの選択を参照してください。
デバイスID	デバイスの固有ID。
イベント	イベントの名前。収益を示すために「Purchase」を使用し、イベント値を収益とします。
App ID	アプリケーションID。自分のアプリをナビゲーションカラムで選択し、[アプリの管理]をクリックして、[キーと構成]をクリックして、自分のアプリのIDを見つけます。
APIバージョン	使用するLeanplum APIのバージョン。
作成ディスポジション	APIによってユーザが作成されるかどうかを決定するポリシー。このメソッドのデフォルト値はCreateIfNeededです。可能な値は次のとおりです： CreateIfNeeded：指定されたIDでユーザが存在しない場合、ユーザを作成します。 CreateNever：ユーザが既に存在する必要があります。存在しない場合、API呼び出しがスキップされ、警告が返されます。
Devモード	ユーザが開発モードにあるかどうか、たとえば、リクエストに関連するユーザが開発者であり、ユーザではない場合。レポート目的で重要です。デフォルト：`false`。
値	イベントの値。たとえば、購入イベントの場合、これは購入価格になります。
通貨コード	値に関連するISO 4217通貨コード。Leanplumは、値を優先通貨に自動的に変換しますが、元の価格と通貨コードはイベントパラメータlocalCurrencyとlocalPriceとして保持されます。通貨換算レートは毎時更新されます。
時間	イベントが発生したUNIXタイムスタンプを指定するオプション。現在の時間と異なる場合があります。
情報	イベントに添付された情報。
パラメータ	キーと値のペアとしてのパラメータのフラットオブジェクト。各キーは文字列であり、最大50個のパラメータを構成できます。
メッセージID	このイベントに関連するメッセージのID。ユーザのメッセージとのやり取りを追跡するために構成します。メッセージの送信または表示を追跡するには、イベント引数を空の文字列に構成します。
ディスポジション	トラッキングされたイベントがセッションとユーザのアクティビティにどのように影響するかを決定します。存在する場合、ディスポジションは次のいずれかの値を持っている必要があります： `active` これがデフォルト値です。ユーザのアクティビティを反映するイベントに使用されます。アクティブなイベントはユーザをアクティブとしてマークし、セッション内で追跡する必要があります。非推奨のオプション`allowOffline: false`を置き換えます。 `passive` ユーザのアクティビティに対応しないイベントに使用されます。これらのイベントはセッション内で発生する必要はなく、ユーザをアクティブとしてマークしません。例：ユーザにメッセージを送信する場合、ユーザに影響を与えますが、ユーザのアクティビティを表すものではありません。非推奨のオプション`allowOffline: true`を置き換えます。 `requireActive` セッション内でのみ追跡する必要があるイベントに使用されます。これらのイベントは、ユーザにアクティブなセッションがない場合、警告応答とともに`ignored: true`を返します。警告メッセージは変更される可能性があるため、クライアントはignoredフィールドで警告を検出する必要があります。

メッセージの送信

パラメータ

パラメータ	説明
ユーザID	現在のユーザID。会社がユーザIDとして使用するものに構成できます。デバイスIDを使用する場合は空白のままにします。詳細については、ユーザの選択を参照してください。
デバイスID	デバイスの固有ID。
メッセージID	メッセージのID。メッセージを表示する際のURLに表示されます（例：`www.leanplum.com/dashboard#/{APP_ID}/messaging/{MESSAGE_ID}`）。
App ID	アプリケーションID。自分のアプリをナビゲーションカラムで選択し、[アプリの管理]をクリックして、[キーと構成]をクリックして、自分のアプリのIDを見つけます。
APIバージョン	使用するLeanplum APIのバージョン。
作成ディスポジション	APIによってユーザが作成されるかどうかを決定するポリシー。このメソッドのデフォルト値はCreateIfNeededです。可能な値は次のとおりです： CreateIfNeeded：指定されたIDでユーザが存在しない場合、ユーザを作成します。 CreateNever：ユーザが既に存在する必要があります。存在しない場合、API呼び出しがスキップされ、警告が返されます。
Devモード	ユーザが開発モードにあるかどうか、たとえば、リクエストに関連するユーザが開発者であり、ユーザではない場合。レポート目的で重要です。デフォルト：`false`。
Values	メッセージで使用されるテンプレート変数を上書きするキーと値のJSONオブジェクト。
Force	ユーザがターゲット条件を満たしているかどうかに関係なく、メッセージを送信するかどうかを指定します。デフォルト：`false`。