Android の Target メソッド

Android ライブラリによって提供される Adobe Target メソッドのリストを示します。

SDK は現在、Analytics、Target、Audience Manager、Adobe Experience Platform ID サービスなど、複数の Adobe Experience Cloud ソリューションをサポートしています。これらのメソッドには、ソリューションに応じたプレフィックスが付けられています。例えば、Experience Cloud ID メソッドのプレフィックスは、target です。

ヒント

ライフサイクル指標は、各 mbox が読み込むパラメーターとして送信されます。

クラス参照：TargetLocationRequest

プロパティ：

public String name; 
public String defaultContent; 
public HashMap<String, Object> parameters;

文字列定数

ヒント

次の定数は、カスタムパラメーターのキーを設定するのに便利です。

public static final String TARGET_PARAMETER_ORDER_ID   = "orderId"; 
public static final String TARGET_PARAMETER_ORDER_TOTAL         = "orderTotal"; 
public static final String TARGET_PARAMETER_PRODUCT_PURCHASE_ID = "productPurchasedId"; 
public static final String TARGET_PARAMETER_CATEGORY_ID         = "categoryId"; 
public static final String TARGET_PARAMETER_MBOX_3RDPARTY_ID    = "mbox3rdPartyId"; 
public static final String TARGET_PARAMETER_MBOX_PAGE_VALUE     = "mboxPageValue"; 
public static final String TARGET_PARAMETER_MBOX_PC             = "mboxPC"; // pcId in cookie 
public static final String TARGET_PARAMETER_MBOX_SESSION_ID     = "mboxSession"; // sessionId in cookie 
public static final String TARGET_PARAMETER_MBOX_HOST           = "mboxHost";

重要

バージョン 4.14.0 より前の SDK を使用している場合、パラメーターの制限については、「https://developers.adobetarget.com/api/#input-parameters」を参照してください。
SDKバージョン 4.14.0 以降を使用している場合は、パラメーターの制限について https://developers.adobetarget.com/api/#batch-input-parameters を参照してください。

loadRequest

設定した Target サーバーに request を送信し、ブロック callback で生成されたオファーの文字列値を返します。
- このメソッドの構文を次に示します。
```
public static void loadRequest(TargetLocationRequest request, TargetCallback<String> callback);
```
- このメソッドのコードサンプルを次に示します。
```
Target.loadRequest(heroBannerRequest, new Target.TargetCallback<String>() {  @Override  public void call(String item) {   // do something with item  } });
```

loadRequest

設定した Target サーバーに request を送信し、ブロック callback で生成されたオファーの文字列値を返します。

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

public static void loadRequest(final String name final String defaultContent, final Map `<String, Object>` profileParameters, 
                               final Map `<String, Object>` orderParameters,final Map `<String Object>` mboxParameters, final TargetCallback<String> callback)

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

Map `<String, Object>` profileParameters = new HashMap `<String, Object>`(); profileParameters.put("profile-parameter-key", "profile-parameter-value"); 
Map `<String, Object>` orderParameters = new HashMap `<String, Object>`(); orderParameters.put("order-parameter-key", "order-parameter-value");
Map `<String, Object>` mboxParameters = new HashMap `<String, Object>`(); 
mboxParameters.put("mbox-parameter-key", "mbox-parameter-value"); 
Target.loadRequest("mboxName", "defaultContent", profileParameters, orderParameters, mboxParameters
new TargetCallback<String>() {
    @Override
    public void call (String item) {
       Log.d("Target Content", item); 
    }
});

loadRequest

設定した Target サーバーにリクエストを送信し、TargetCallback で生成されたオファーの文字列値を返します。
- このメソッドの構文を次に示します。
```
public static void loadRequest(final String name, final String defaultContent, final Map<String, Object> profileParameters, final Map<String, Object> orderParameters, final Map<String, Object> mboxParameters, final Map<String, Object> requestLocationParameters, final TargetCallback<String> callback);
```
- 戻り値：なし
- パラメーター：
  
  このメソッドのパラメーターを次に示します。
  - name
    
    取得する Target の mbox／ロケーションの名前。
    - 型： String
  - defaultContent
    
    Target サーバーに到達できない場合、またはユーザーがキャンペーンの対象にならない場合にコールバックで返される値。
    - 型： String
  - profileParameters
    
    この辞書の値は、Target へのリクエストの「profileParameters」オブジェクトに格納されます。
    - 型：マップ<String, Object>
  - orderParameters
    
    この辞書の値は、Target へのリクエストの「order」オブジェクトに格納されます。
    - 型：マップ<String, Object>
  - mboxParameters
    
    この辞書の値は、Target へのリクエストに含まれます。
    - 型：マップ<String, Object>
  - requestLocationParameters
    
    この辞書の値は、Target へのリクエストの「requestLocation」オブジェクトに格納されます。
    - 型：マップ<String, Object>
  - callback
    
    このメソッドは、Target サーバーからのオファーのコンテンツで呼び出されます。Target サーバーに到達できない場合、またはユーザーがキャンペーンの対象にならない場合、defaultContent が返されます。
    - 型： TargetCallback <String>
- このメソッドのコードサンプルを次に示します。
```
Map `<String, Object>` profileParameters = new HashMap `<String, Object>`(); profileParameters.put("profile-parameter-key", "profile-parameter-value"); 
Map `<String, Object>` orderParameters = new HashMap `<String, Object>`(); orderParameters.put("order-parameter-key", "order-parameter-value"); 
Map `<String, Object>` mboxParameters = new HashMap `<String, Object>`(); mboxParameters.put("mbox-parameter-key", "mbox-parameter-value"); 
Map `<String, Object>` requestLocationParameters = new HashMap `<String, Object>`(); requestLocationParameters.put("request-location-parameter-key", "request-location-parameter-value"); 

Target.loadRequest("mboxName", "defaultContent", profileParameters, orderParameters, mboxParameters, requestLocationParameters,new TargetCallback<String>() {
   @Override
   public void call (String item) { 
      Log.d("Target Content", item);
   } 
});
```
  基になる Target API について詳しくは、Target API リファレンスの Target リクエストの読み込みを参照してください。

createOrderConfirmRequest

指定されたパラメーターで TargetLocationRequest オブジェクトを作成します。

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

public static TargetLocationRequest createOrderConfirmRequest(String name, String orderId, String orderTotal, String productPurchasedId, Map<String, Object> parameters);

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

TargetLocationRequest orderConfirm = Target.createOrderConfirmRequest("orderConfirm", "order", "47.88", "3722", null);

createRequest

指定されたパラメーターで TargetLocationRequest オブジェクトを作成します。
- このメソッドの構文を次に示します。
```
public static TargetLocationRequest createRequest(String name, String defaultContent, Map<String, Object> parameters);
```
- このメソッドのコードサンプルを次に示します。
```
TargetLocationRequest heroBannerRequest = Target.createRequest("heroBanner", "default.png", null);
```
clearCookies

アプリから対象の cookie をクリアします。
- このメソッドの構文を次に示します。
```
public static void clearCookies();
```
- このメソッドのコードサンプルを次に示します。
```
Target.clearCookies();
```
getPcID

pcID を返します。
- このメソッドの構文を次に示します。
```
public static String getPcID();
```
- このメソッドのコードサンプルを次に示します。
```
Target.getPcID();
```
getSessionID

セッション ID を返します。
- このメソッドの構文を次に示します。
```
public static String getSessionID();
```
- このメソッドのコードサンプルを次に示します。
```
Target.getSessionID();
```
setThirdPartyID

サードパーティの ID を設定します。
- このメソッドの構文を次に示します。
```
public static String setThirdPartyID(final String thirdPartyId);
```
- このメソッドのコードサンプルを次に示します。
```
Target.setThirdPartyID("third-party-id");
```
getThirdPartyID

サードパーティの ID を返します。
- このメソッドの構文を次に示します。
```
public static String getThirdPartyID();
```
- このメソッドのコードサンプルを次に示します。
```
String thirdPartyId = Target.getThirdPartyID();
```