SDK API ガイド

ユーザー識別を設定する

インターフェース定義

• identifyAccount(user);
  • インターフェース説明：
    • ユーザー識別を設定します。例えば、ユーザーの会員カード番号など。
  • パラメーター説明
    • identity: ユーザー識別 ID。
    • completion: コールバック。

呼び出し例

              
                  let user = {completion: (code, message) => {}, identity: {"id": "value"}}
    window.MAInterface.identifyAccount(user)

            

EUID を取得する

インターフェース定義

• + EUID()
  • インターフェース説明：
    • EngageLab MA の EUID を取得します。

呼び出し例

              
                  window.MAInterface.EUID((code, euid) => {
        console.log(code, euid)
    })

            

ユーザー連絡先を設定する

インターフェース定義

• setUserContact(user)
  • インターフェース説明：
    • 複数の連絡先の値を同時に設定できます。Key は連絡先の名称、Value は連絡先の値です。現在、4 種類の連絡先をサポートしています：email、mobile_phone、landline_phone、whatsapp_phone。
  • パラメーター説明
    • contacts: ユーザーの連絡先。
    • completion: コールバック。

呼び出し例

              
                    let user = {
          completion: (code, message) => { },
          contacts: {}
       }
      user.contacts["連絡先名称"] = "連絡先の値"   // 例：mobile_phone = 18800000000
      window.MAInterface.setUserContact(user)

            

UTM 属性を設定する

インターフェース定義

• setUtmProperties(attrs:any)
  • インターフェース説明：
    • UTM 属性は標準のイベント属性です。開発者がユーザーがどの広告からアプリに遷移したかを認識できる場合、UTM 情報を設定することをお勧めします。イベント報告時にこのパラメーターを送信します。現在設定可能な UTM 属性は以下の通りです：
      • utm_source: 広告キャンペーンの出所。
      • utm_medium: 広告キャンペーンの媒体。
      • utm_term: 広告キャンペーンのキーワード。
      • utm_content: 広告キャンペーンの内容。
      • utm_campaign: 広告キャンペーンの名称。
      • utm_id: 広告キャンペーンの ID。

呼び出し例

              
                 window.MAInterface.setUtmProperties({"utm_source": "value1"})

            

ユーザー属性を設定する

ユーザー属性の値を設定します。ユーザー属性が存在しない場合、バックエンドで自動的に作成されます。

ユーザー属性を上書きして更新する

• setProperty(user, completion)
  • インターフェース説明：
    • ユーザー属性の値を上書きして更新します。
    • 最新の報告データのみを保存し、履歴データを上書きします。例えば、ユーザーの会員ランクなど。
    • これらのユーザー属性の内容はオブジェクトに保存され、Key はユーザー属性の名称（文字列である必要があります）、Value はユーザー属性の内容で、string、number、Array 型のみサポートされます。
    • 現在、Array 型の値の要素は文字列のみサポートされています。
    • 既存のユーザー属性がある場合は上書きされ、存在しない場合は作成されます。
  • 呼び出し例：

              
                 window.MAInterface.setProperty({key: "value"}, (code, message) => {})

            

ユーザー属性を増分更新する

• increaseProperty(user, completion)
  • インターフェース説明：
    • ユーザー属性の値に増分を設定します。
    • 数値型のユーザー属性に対して値を追加します。例えば、累計消費金額など。
    • このインターフェースは数値型のユーザー属性にのみ呼び出すことができ、それ以外は無視されます。該当ユーザー属性が存在しない場合、初期値は 0 と見なされます。
  • 呼び出し例：

              
               window.MAInterface.increaseProperty({key: 1}, (code, message) => {})

            

ユーザー属性を追加する

• addProperty(key, content completion)
  • インターフェース説明：
    • ユーザー属性の値に値を追加します。
    • この集合に要素を継続的に追加します。データベースに保存する際に重複を排除します。例えば、既存の値が ABC の場合、CD を追加すると最終的な結果は ABCD になります。例：ユーザーが「いいね」したニュース。
    • Array 型の属性に値を追加します。この Array の要素は文字列でなければならず、そうでない場合は無視されます。また、追加するユーザー属性が存在しない場合は空の Array として初期化されます。
  • 呼び出し例：

              
               window.MAInterface.addProperty("key", ["value1", "value2"], (code, message) => {})

            

ユーザー属性値を削除する

• removeProperty(key, content completion)
  • インターフェース説明：
    • Array 型の属性から 1 つまたは複数の値を削除します。
    • Array 型の属性から値を削除します。この Array の要素は文字列でなければならず、そうでない場合は無視されます。また、削除するユーザー属性が存在しない場合は影響を与えません。
  • 呼び出し例：

              
               window.MAInterface.removeProperty("key", ["value1", "value2"], (code, message) => {})

            

ユーザー属性を削除する

インターフェース定義

• deleteProperty(key, completion)
  • インターフェース説明：
    • 特定のユーザー属性のすべての値を削除します。
    • 該当ユーザー属性が存在しない場合は無視されます。

呼び出し例

              
               window.MAInterface.deleteProperty("key", (code, message) => {})

            

セッションタイムアウトを設定する

インターフェース定義

• setSessionTimeout(time)
  • インターフェース説明：
    • セッションタイムアウトを設定します。ページがバックグラウンドに置かれた場合、セッションタイムアウトが計算され始めます。設定された時間（デフォルトは 30 分）を超えると、そのセッションは終了します。

呼び出し例

              
               window.MAInterface.setSessionTimeout(60)

            

ページ滞在時間を設定する

インターフェース定義

• setPageStayTime(time)
  • インターフェース説明：
    • ページ滞在時間の長さを設定します。
    • ページにアクセスした後、計時を開始します。ユーザーがページに time 秒間滞在した場合、そのイベントが報告されます。
    • デフォルトでは 6 つのタイムポイントで報告されます：5 秒、30 秒、60 秒、2 分、5 分、10 分。開発者はこのインターフェースを呼び出してさらに多くのタイムポイントを追加できます。

呼び出し例

              
               window.MAInterface.setPageStayTime(60)

            

イベントを報告する

イベントが存在しない場合、直接報告され、バックエンドで自動的に作成されます。

インターフェース定義

• onEvent(event)
  • インターフェース説明：
    • イベントを報告します。
  • パラメーター説明
    • event: 報告するイベント。name はイベント名、properties はイベント属性情報で、その中の Key は属性名、Value は属性値です。

呼び出し例

              
                 let event = {name: "name", properties: {key: "value"}}
    window.MAInterface.onEvent(event)