PhoneGap プラグインのメソッド

Android PhoneGap プラグインのメソッドを使用して、様々な作業を実行できます。

トラッキングを使用する html ファイル内で、以下を <head> タグに追加します。

<script type="text/javascript" charset="utf-8" src="ADB_Helper.js"></script>

設定メソッド

  • getPrivacyStatus

    現在のユーザーのプライバシーステータスを返します。

    利用可能なステータスは次のとおりです。

    • ADB.optedIn:ヒットは即座に送信されます。

    • ADB.optedOut:ヒットは破棄されます。

    • ADB.optUnknown:レポートスイートのタイムスタンプが​有効になっている​場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。レポートスイートのタイムスタンプが​有効になっていない​場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。

      デフォルト値は ADBMobileConfig.json ファイルに設定します。

    • このメソッドのコードサンプルを次に示します。

      getPrivacyStatus(function (value) { myTempVal = value; }, function () {myTempVal = null;}); 
      
  • setPrivacyStatus

    現在のユーザーのプライバシーステータスを status に設定します。

    次のいずれかのステータスを設定できます。

    • ADB.optedIn:ヒットは即座に送信されます。

    • ADB.optedOut:ヒットは破棄されます。

    • ADB.optUnknown:レポートスイートのタイムスタンプが​有効になっている​場合、プライバシーステータスがオプトイン(ヒットが送信される)またはオプトアウト(ヒットが破棄される)に変更されるまで、ヒットは保存されます。レポートスイートのタイムスタンプが​有効になっていない​場合、プライバシーステータスがオプトインに変更されるまで、ヒットは破棄されます。

    • このメソッドのコードサンプルを次に示します。

      ADB.setPrivacyStatus('ADB.optedIn');
      
  • getLifetimeValue

    現在のユーザーのライフタイム値を返します。デフォルト値は 0 です。

    • このメソッドのコードサンプルを次に示します。

      ADB.getLifetimeValue(function (value) { myTempVal = value }, function () { myTempVal = null; }); 
      
  • setDebugLogging

    デバッグ情報を表示する設定を、有効(true)または無効(false)にします。デフォルトでは、この変数は false です。

    • このメソッドのコードサンプルを次に示します。

      ADB.setDebugLogging(true);
      
  • getVersion

    ライブラリのバージョンを取得します。

    • このメソッドのコードサンプルを次に示します。

      ADB.getVersion(function (value) { versionNum = value }, function () { versionNum = 1.0;});
      
  • trackingIdentifier

    自動的に生成された訪問者識別子を返します。

    これは、アプリが最初に起動されたときに生成され、その時点から保存および使用される、アプリ固有の一意の訪問者 ID です。この ID は、アプリのアップグレード時に保持され、アプリをアンインストールする際に削除されます。

    ヒント

    アプリを Experience Cloud 3.x から 4.x SDK にアップグレードすると、以前の訪問者 ID(カスタム ID または自動生成された ID)が取得され、カスタムユーザー識別子として保存されます。詳しくは、以下の「getUserIdentifier」を参照してください。SDK をアップグレードしても、この ID の訪問者データは保持されます。

    4.x SDK を新規インストールした場合、ユーザー識別子は null なので、トラッキング識別子が使用されます。

    • このメソッドのコードサンプルを次に示します。

      ADB.trackingIdentifier(function (value) { myTempVal = value; }, function () { myTempVal = null; }); 
      
  • getUserIdentifier

    顧客ユーザー識別子が設定されている場合は、その識別子を返します。顧客ユーザー識別子が設定されていない場合は、null を返します。デフォルト値は null です。

    • このメソッドのコードサンプルを次に示します。

      getUserIdentifier(function(value) { myTempVal = value; }, function () { myTempVal = null; });
      
  • setUserIdentifier

    ユーザー識別子を identifier に設定します。

    • このメソッドのコードサンプルを次に示します。

      ADB.setUserIdentifier('testUser');
      
  • setPushIdentifier

    プッシュ通知用のデバイストークンを設定します。

    getUserIdentifier(function (value) { myTempVal = value; }, function () { myTempVal = null; });
    
    • このメソッドの構文を次に示します。

      ADB.setPushIdentifier(pushIdentifier, success, fail);
      
    • このメソッドのコードサンプルを次に示します。

      ADB.setPushIdentifier('test_push_identifier',function (value) { alert('success'); },function (value) { alert('fail'); }); 
      
  • keepLifecycleSessionAlive

    ライフサイクルセッションのキープアライブの設定をおこないます。

    重要

    keepLifecycleSessionAlive を呼び出すと、アプリを次回バックグラウンドから再開するときに新しいセッションを開始できなくなります。このメソッドは、アプリがバックグラウンドで通知を登録する場合にのみ使用してください。

    • このメソッドのコードサンプルを次に示します。

      ADB.keepLifecycleSessionAlive(); 
      
  • trackingSendQueuedHits

    現在のバッチオプションに関係なく、キュー内に格納されているすべてのヒットを強制的に送信します。

    • このメソッドのコードサンプルを次に示します。

      ADB.trackingSendQueuedHits();
      
  • trackingGetQueueSize

    オフラインキュー内に格納されているトラッキングコールの数を取得または設定します。

    • このメソッドのコードサンプルを次に示します。

      ADB.trackingGetQueueSize(function (value) { myTempVal = value;}, function () { myTempVal = null;}); 
      
  • trackingClearQueue

    オフラインキュー内に格納されているすべてのトラッキングコールを削除します。

    警告

    キューを手動でクリアする場合は、慎重に実行してください。この操作を元に戻すことはできません。

    • このメソッドのコードサンプルを次に示します。

      ADB.trackingClearQueue(function (value) { myTempVal = value; }, function () { myTempVal = null; }); 
      

PII メソッド

  • collectPII

    PII 収集リクエストを送信します。

    • このメソッドの構文を次に示します。
    ADB.collectPII(piiData,success, fail);
    
    • このメソッドのコードサンプルを次に示します。

      ADB.collectPII({'k1':'v1','k2':'v2','k3':'v3'}, function (value) { alert('success') },function (value) { alert('fail') ;});
      

トラッキングメソッド

  • trackAdobeDeepLink

    アドビディープリンクのクリックスルーを追跡します。

    ヒント

    ライフサイクル呼び出しが起動イベントの場合は、アドビリンクデータが追加されます。それ以外の場合は、追加の呼び出しが送信されます。

    • このメソッドの構文を次に示します。

      ADB.trackAdobeDeepLink(deeplinkURL, success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.trackAdobeDeepLink('xyz-deeplink-url',function (value) { alert('success'); },function (value) { alert('fail') }); 
      
  • trackState

    オプションのコンテキストデータを使用してアプリの状態を追跡します。状態はアプリで利用可能なビューで、home dashboardapp settingscart などがあります。これらの状態は Web サイト上のページによく似ており、trackState コールにより、ページビュー数が増分されます。

    cData:コンテキストデータで送信されるキーと値のペアを持つ JSON オブジェクト。

    • このメソッドの構文を次に示します。

      ADB.trackState(string stateName[,JSON cData]);
      
    • このメソッドのコードサンプルを次に示します。

        ADB.trackState("login&amp;nbsp;page"); 
      
        ADB.trackState("login page", {"user":"john","remember":"true"});
      
  • trackAction

    アプリのアクションを追跡します。アクションには、アプリで発生し、測定の対象となる loginsbanner tapsfeed subscriptions およびその他の指標が含まれます。

    • このメソッドの構文を次に示します。

      ADB.trackAction(string action[,JSON cData]); 
      
    • このメソッドのコードサンプルを次に示します。

        ADB.trackAction("login");
      
        ADB.trackAction("login", {"user":"john","remember":"true"}); 
      
  • trackLocation

    現在の XY 座標を送信します。また、現在位置が ADBMobileConfig.json ファイルで定義された目標地点内にあるかどうかを判定します。現在の座標が定義した目標地点内にある場合、コンテキストデータ変数に代入され、trackLocation 呼び出しで送信されます。

    • このメソッドの構文を次に示します。

      ADB.trackLocation(x, y[,JSON cData]); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.trackLocation('40.431596', '-111.893713'); 
      
  • trackLifetime​ValueIncrease

    ユーザーのライフタイム値に amount を加算します。

    • このメソッドの構文を次に示します。

      ADB.trackLifetimeValueIncrease(amount[,JSON cData]); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.trackLifetimeValueIncrease('10.01'); 
      
  • trackTimed​ActionStart

    action という名前の時間計測アクションを開始します。

    既に開始しているアクションでこのメソッドを呼び出すと、以前の時間計測アクションが上書きされます。

    ヒント

    この呼び出しはヒットを送信しません。

    • このメソッドの構文を次に示します。

      ADB.trackTimedActionStart(action[,JSON cData]);
      
    • このメソッドのコードサンプルを次に示します。

      ADB.trackTimedActionStart("cartToCheckout"); 
      
  • trackTimed​ActionUpdate

    cData を渡して、action に関連付けられているコンテキストデータを更新します。

    渡された cData は、アクションの既存のデータに追加されます。action に対して同じキーが既に定義されている場合は、データが上書きされます。

    • このメソッドの構文を次に示します。

      ADB.trackTimedActionUpdate(String action[,JSON cData]);
      
    • このメソッドのコードサンプルを次に示します。

      ADB.trackTimedActionUpdate("cartToCheckout",{'SampleContextDataKey3':'SampleContextDataVal3','SampleContextDataKey4':'SampleContextDataVal4'});
      
  • trackTimed​ActionEnd

    時間計測アクションを終了します。

    • このメソッドのコードサンプルを次に示します。

      ADB.trackTimedActionEnd("cartToCheckout"); 
      
  • trackingTimedActionExists

    時間計測アクションが進行中かどうかを返します。

    • このメソッドの構文を次に示します。

      ADB.trackingTimedActionExists(function (value) { myTempVal = value }, function () { myTempVal = null; }); 
      

ビーコンメソッド

  • trackBeacon

    ユーザーがいつビーコンの Proximity に入ったかを追跡します。

    • このメソッドの構文を次に示します。

      ADB.trackBeacon(uuid, major, minor, proximity, cData) 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.trackBeacon('2F234454-CF6D-4A0F-ADF2-F4911BA9FFA6', 1, 2, 
      ADB.beaconUnknown, {'hp':'hp_val','hp.company':'adobe'}
      
  • clearCurrentBeacon

    ユーザーがビーコンの Proximity を離れた場合に、ビーコンデータをクリアします。

    • このメソッドの構文を次に示します。

      ADB.clearCurrentBeacon(success, fail)
      
    • このメソッドのコードサンプルを次に示します。

      ADB.clearCurrentBeacon(); 
      

Target メソッド

  • targetLoadRequest

    設定した Target サーバーにリクエストを送信し、オファーの文字列値を返します。

    • このメソッドの構文を次に示します。

      ADB.targetLoadRequest(success, fail, name, defaultContent, parameters);
      
    • このメソッドのコードサンプルを次に示します。

      ADB.targetLoadRequest(function&nbsp;(value)
      {myTempVal = value }, function () { myTempVal = null;},'bannerOffer', 'none', {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'}); 
      
  • targetLoadOrderConfirmRequest

    設定した Target サーバーにリクエストを送信します。

    • このメソッドの構文を次に示します。

      ADB.targetLoadOrderConfirmRequest(success, fail name orderId, orderTotal, productPurchaseId, parameters); 
      
    • このメソッドの構文を次に示します。

      ADB.targetLoadRequest(function (value) { myTempVal = value }
      , function ()
      { myTempVal = null; } 
      , 'name' 'orderId' 'total', 'purchaseId',
      {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'}
      ); 
      
  • targetClearCookies

    共有 Cookie ストレージから Target の Cookie をクリアします。

    • このメソッドのコードサンプルを次に示します。

      ADB.targetClearCookies(); 
      
  • targetLoadRequestWithNameWithLocationParameters

    Target サービスリクエストを処理します。

    • このメソッドの構文を次に示します。

      ADB.targetLoadRequestWithNameWithLocationParameters(
        success, fail, name, defaultContent, profileParameters, orderParameters, mboxParameters requestLocationParameters
        ); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.targetLoadRequestWithNameWithLocationParameters  (function () { alert('success'); }, function () { alert('fail'); }, ;'bannerOffer', 'none', {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'}, {'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'},{'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'},{'hp':'hp_val_new','hp.company':'adobe', 'hp.val2':'hp_val2'});
      
  • targetLoadRequestWithName

    Target サービスリクエストを処理します。

    • このメソッドの構文を次に示します。

      ADB.targetLoadRequestWithRequestName(success, fail, name, defaultContent, profileParameters, orderParameters, mboxParameters);
      
    • このメソッドのコードサンプルを次に示します。

      ADB.targetLoadRequestWithName(
      function (value){ // handle target success} ,
      function() { // handle target failure }, 
      "mboxName",
      "defaultContent",
      {"profileParameters":"profileParametervalues"}
      {"orderId" : "32FGJ4XK" , "orderTotal" : "123.33" , "purchasedProductIds":"[46,34]" }
      {"mboxParameters":"mboxParametersvalues"}
      );
      
  • targetSessionID

    Target サーバーによってこの訪問者に対して返された SessionID Cookie の値を取得します。

    • このメソッドの構文を次に示します。

      ADB.targetSessionID (success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.targetSessionID(function (value) { alert(value) },function (value){ alert('fail'); });  
      
  • targetPcID

    PcID サーバーによってこの訪問者に対して返された Target Cookie の値を取得します。

    • このメソッドの構文を次に示します。

      ADB.targetPcID (success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.targetPcID(function  (value) { alert(value) },function (value) { alert('fail'); });
      
  • targetSetThirdPartyID

    Target のカスタム訪問者 ID を設定します。

    • このメソッドの構文を次に示します。

      ADB.targetSetThirdPartyID(thirdPartyID, success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.targetSetThirdPartyID('test-third-party-id' function (value) { alert('success'); },function (value) { alert('fail'); }); 
      
  • targetThirdPartyID

    Target のカスタム訪問者 ID を取得します。

    • このメソッドの構文を次に示します。

      ADB.targetThirdPartyID(success, fail);
      
    • このメソッドのコードサンプルを次に示します。

       ADB.targetThirdPartyID(function (value) { alert(value); },function (value) { alert('fail')__;});
      

獲得メソッド

  • acquisitionCampaignStartForApp

    設定した Target サーバーにリクエストを送信し、オファーの文字列値を返します。

    • このメソッドの構文を次に示します。

      ADB.acquisitionCampaignStartForApp(appId, data, success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.acquisitionCampaignStartForApp("appId", {‘key’:‘value’}, function() {…}, function() {…}));
      
      ADB.acquisitionCampaignStartForApp("appId", {‘key’:‘value’});  
      

広告識別子

Cordova によって生成されたメインアクティビティで、Config.submitAdvertisingIdentifierTask() メソッドの onResume() を呼び出します。詳しくは、「設定メソッド」を参照してください。

Audience Manager メソッド

  • audienceGetVisitorProfile

    訪問者のプロファイルを取得します。

    • このメソッドの構文を次に示します。

      ADB.audienceGetVisitorProfile(); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.audienceGetVisitorProfile(function(value) { profile = value;}, function() { profile = null; }); 
      
  • audienceGetDpuuid

    DPUUID を返します。

    • このメソッドの構文を次に示します。

      ADB.audienceGetDpuuid(success fail);
      
    • このメソッドのコードサンプルを次に示します。

      ADB.audienceGetDpuuid(function(value) { dpuuid = value;}, function(){dpuuid = null; }); 
      
  • audienceGetDpid

    DPID を返します。

    • このメソッドの構文を次に示します。

      ADB.audienceGetDpid(success, fail);
      
    • このメソッドのコードサンプルを次に示します。

      ADB.audienceGetDpid(function(value){dpid = value;}, function() {dpid =  null;}); 
      
  • audienceSetDpidAndDpuuid

    DPID および DPUUID を設定します。

    • このメソッドの構文を次に示します。

      ADB.audienceSetDpidAndDpuuid(dpid, dpuuid, success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.audienceSetDpidAndDpuuid(‘dpid’, ‘dpuuid’, function() {…}, function(){…};
      
      ADB.audienceSetDpidAndDpuuid(‘dpid’, ‘dpuuid’); 
      
  • audienceSignalWithData

    Audience Manager サービスリクエストを処理します。

    • このメソッドの構文を次に示します。

      ADB.audienceSignalWithData(success, fail, data);
      
    • このメソッドのコードサンプルを次に示します。

       ADB.audienceSignalWithData(function() {}, function() {} {‘key1’: ’value1’ ‘key2’: ‘value2’}); 
      
      ADB.audienceSignalWithData({‘key1’: ’value1’, ‘key2’:‘value2’}); 
      
  • audienceReset

    Audience Manager UUID をリセットし、現在の訪問者プロファイルを削除します。

    • このメソッドのコードサンプルを次に示します。

      ADB.audienceReset();
      

ID サービスメソッド

  • visitorGetMarketingCloudId

    ID サービスから Experience Cloud ID を返します。

    • このメソッドの構文を次に示します。

      ADB.visitorGetMarketingCloudId(success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.visitorGetMarketingCloudId(function (value) { mcid = value;},function (){ mcid = null;});
      
  • visitorSyncIdentifiers

    指定された識別子を ID サービスと同期します。

    • このメソッドの構文を次に示します。

      ADB.visitorSyncIdentifiers(identifiers, success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.visitorSyncIdentifiers({‘key_id_1’:’value_id_1’}, function() {…}, function() {…}));
      
      ADB.visitorSyncIdentifiers({‘key_id_1’: ‘value_id_1’});  
      
  • visitorSyncIdentifiersWithAuthenticationState

    指定された識別子を ID サービスに同期します。

    • このメソッドの構文を次に示します。

      ADB.visitorSyncIdentifiersWithAuthenticationState
      (identifiers, authenticationState, success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.visitorSyncIdentifiersWithAuthenticationState({'k1':'v1','k2':'v2','k3':'v3'}, ADB.mobileVisitorAuthenticationStateAuthenticated, function (value) { alert('success'); },function (value) { alert('fail'); }); 
      
  • visitorSyncIdentifierWithType

    指定された識別子を ID サービスに同期します。

    • このメソッドの構文を次に示します。

      ADB.visitorSyncIdentifierWithType(identifierType, identifier authenticationState, success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.visitorSyncIdentifierWithType('test-identifier-type', 'test-identifier', ADB.mobileVisitorAuthenticationStateAuthenticated, function (value) { alert('success') },function (value) { alert('fail'); }); 
      
  • visitorAppendToURL

    指定された URL に訪問者識別子を追加します。

    • このメソッドの構文を次に示します。

       ADB.visitorAppendToURL(urlToAppend, success, fail); 
      
    • このメソッドのコードサンプルを次に示します。

      ADB.visitorAppendToURL('test_visitor_url', function (value) alert(value);},'');
      
  • visitorGetIDs

    同期されたすべての visitorID を返します。

    • このメソッドの構文を次に示します。

      ADB.visitorGetIDs (success, fail);
      
    • このメソッドのコードサンプルを次に示します。

      ADB.visitorGetIDs(function (value) { alert(value); },function (value) { alert('fail') ;}); 
      

このページ