アドバンスト設定

ユーザー ID の設定

サーバー間コールバックを使用してリワード広告ユニットでユーザーにリワードを提供している場合、または Ad Quality ユーザージャーニーを使用する場合は、setUserID メソッドを使用して各ユーザーにユニークな識別子( UserID )を定義する必要があります。
userID 設定はユーザーデータのロスを防ぐため、init リクエストの前に行う必要があります。userID には、1 〜 64 文字のユニークな英数字を使用してください。

IronSource.setUserId("UserID");
Note: 全てのユーザーにユニークなIDを設定できる事を保証するため、ID に GAID/AAID は使用しないでください。

セグメントの定義

特定のオーディエンスに合わせて広告の配信方法を簡単にカスタマイズできるようになりました。ユーザーが属するセグメントに従って SDK が広告を配信できるように、ユーザーの詳細を ironSource のサーバーに通知する必要があります。

ironSource SDK は、ユーザーセグメントのアウトラインのために、サーバーにデータを伝達する三つの方法をサポートしています:

  • デバイスのプロパティ:ironSource SDK は、位置情報、デバイスモデル、デバイスの製造元、アプリのバージョン、OS など、ユーザーのデバイスに関連する特定の標準パラメーターを自動的に収集します。したがって、このデータを手動で送信する必要はありません。
  • ユーザープロパティ:年齢、性別、作成日などの包括的なユーザーデータ(サポートされている全てのセグメントプロパティのリストと以下の説明を参照)は、API で中継する必要があります。LevelPlay プラットフォームで定義したセグメントに基づいて SDK がさまざまなユーザーを分類できるよう、指示に従ってユーザーの詳細を送信してください。
  • カスタムセグメント:ユーザーの詳細をそのままサーバーへ送信せずに、アプリ側で事前に定義された条件でカスタムセグメントを作成し、そのユーザーセグメントの広告設定を調整できます。
ダイナミックセグメント ironSource SDK 7.2.0+ を使用している場合は、IronSourceSegment API を使用してセッション中にセグメントを変更できます。
これは次に読み込まれる広告に影響するので、各広告ユニットを読み込む前に呼び出すことで動的にウォーターフォールに影響を与えることができます。 LevelPlay セグメントの詳細については、こちらをご覧ください。

ユーザープロパティを渡す

LevelPlay プラットフォームでセグメントを定義したら、サーバーにユーザーの詳細を通知する必要があります。

セグメントのベースとするための、サーバーに送信するプロパティを定義します。この情報は、次のいずれかの方法で送信できます:

  1. ユーザーが属するセグメントが分かる場合は、セグメント名を入力します:
    mIronSegment.setSegmentName(name);

  2. ユーザーの詳細を送信します。ironSource SDK は、セグメントにユーザーを関連付けるために設定できる一連の標準ユーザープロパティをAPIで提供します。下にスクロールして、サポートユーザーセグメントのプロパティの表をご覧ください。
    final segment = IronSourceSegment();
    segment.age = ageParam;
    segment.gender = genderParam;
    segment.level = levelParam;
    segment.isPaying = isPayingParam;
    segment.userCreationDateInMillis = dateTimeParam;
    segment.iapTotal = iaptParam;
     
    // up to 5 cusom params
    segment.setCustom(key: 'CustomKey1', value: 'CustomVal1');
    
    // Set ironSource Segment
    IronSource.setSegment(segment);

    [/code-snippet]

サポートされているユーザーセグメントのプロパティ

Segment Properties Type Limitation Description
segmentName String
  • 英数字
  • 32 文字まで
LevelPlay アカウントで設定したセグメント名
Age Int 1-99 ユーザーの年齢
Gender String female または male ユーザーの性別
Paying Boolean True または False
  • アプリ内課金で購入した事がある場合は True
  • アプリ内課金で購入した事がない場合は False
iap_total Double 1-999999.99 ユーザーがアプリ内課金に費やした累計金額
userCreationDate Long 0または0以上 ユーザーがアプリをインストールした日付のミリ秒
Custom Parameters key=string, value=string
  • ironSource SDK は最大五つのカスタムパラメータをサポートします
  • 英数字
  • 32 文字まで
サーバーに送信したい追加データ

カスタムパラメーター

ironSource SDK は、動画リワードのカスタムパラメーターをサポートします。広告ユニットの初期化時にカスタムパラメータを渡し、ユーザーの完了イベント時にパラメータを受け取ることができます。

これで、LevelPlay メディエーションプラットフォーム上のすべてのメディエーションネットワークにカスタムパラメータを渡すことができます。

Note:
  1. カスタムパラメーターは、サーバー間の完了コールバックとのみ連携して機能し、コールバック文字列の一部としてパラメータを受け取ります。
  2. init リクエストに複数のカスタムパラメータを挿入できます。

実装コード

動画リワード

Note:
  • カスタムパラメータは、セッションごとに数回設定できます。
  • 値をリセットするには、clearRewardedVideoServerParameters を使用してから、新しい値を設定します。
IronSource.setRewardedVideoServerParameters(Map<String, String> params);
IronSource.clearRewardedVideoServerParameters();

ウォーターフォールコンフィギュレーションを使用した価格制限( beta )

ウォーターフォールコンフィギュレーションは、ウォーターフォールの上限価格と下限価格の制限を動的に設定する事ができる API です。これを使用して設定された制限は、ユーザーごとに返されるウォーターフォールに対して動的に作用し、ロード時間やレイテンシーを短縮する事ができます。

制限設定には以下のパラメータが含まれ、これらを任意に組み合わせることもできます:

プロパティ 説明
ceiling double Non-bidder インスタンスに適用される最大 eCPM を定義する米ドルでの価格
floor double Non-bidder インスタンスとBidder インスタンスに適用される最小 eCPM を定義する米ドルでの価格

ウォーターフォールコンフィギュレーションを作成する

WaterfallConfiguration クラスは、ウォーターフォールをカスタマイズまたはフィルタリングするための構成オブジェクトを表します。ウォーターフォールコンフィギュレーションを作成するには、以下の様に実装します:

// Build the WaterfallConfiguration and add data to constrain or control a waterfall
WaterfallConfiguration config = WaterfallConfiguration.builder()
            .SetCeiling(ceiling)
            .SetFloor(floor)
            .build();

// set a configuration for an ad unit
IronSource.setWaterfallConfiguration(config, adUnit);

ウォーターフォールコンフィギュレーションをリセットする

セッション中にウォーターフォールコンフィギュレーションを変更することができます。特定の広告ユニットの設定をリセットするには、WaterfallConfiguration の empty 関数を使用します:

IronSource.setWaterfallConfiguration(WaterfallConfiguration.empty(), adUnit);

ウォーターフォールコンフィギュレーションを上書きする

構築された WaterfallConfiguration は不変であるため、既存の設定を変更するには、新しいウォーターフォールコンフィギュレーションを作成する必要があります。ビルダーをインライン化し、ビルダーパターンに合わせて定義することもできます。

... IronSource.setWaterfallConfiguration(waterfallconfiguration, IronSourceAdUnit.RewardedVideo);
WaterfallConfiguration waterfallConfiguration2 = WaterfallConfiguration.builder()
  .SetFloor(ceiling)
  .SetCeiling(floor)
  .Build();

IronSource.setWaterfallConfiguration(waterfallConfiguration2, IronSourceAdUnit.RewardedVideo);

価格の下限設定

Floor Configuration API を使用すると、特定の広告ユニットに最低価格を設定できます。ユーザーごとに最低価格を設定することで、ターゲティングの効率性を向上させ、レイテンシを短縮し、広告パフォーマンスを最適化できます。

最低価格を広告オブジェクトの作成時に割り当てる必要があり、そのオブジェクトの後続のすべてのロードに適用されます。

Note: SDK 8.9.0 以上
プロパティ 説明
Bid floor double Non-bidder と Bidder インスタンス両方に適用される最低 eCPM を定義する米ドルでの価格

インタースティシャル広告での使用例

// Define a price floor configuration
var adConfig = new LevelPlayInterstitialAd.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build();

// Apply the configuration to an interstitial ad unit
var interstitialAd = new LevelPlayInterstitialAd("adUnitId", adConfig);
// Define a price floor configuration
val adConfig = LevelPlayInterstitialAd.Config.Builder()
    .setBidFloor(1.23) // Set the price floor in USD
    .build()

// Apply the configuration to an interstitial ad unit
val interstitialAd = LevelPlayInterstitialAd("adUnitId", adConfig)

インタースティシャルの完全な実装についてはこちら

動画リワードでの使用例

// Define a price floor configuration
val adConfig = LevelPlayRewardedAd.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build()

// Apply the configuration to a rewarded ad unit
val rewardedAd = LevelPlayRewardedAd("adUnitId", adConfig)
// Define a price floor configuration
val adConfig = LevelPlayRewardedAd.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build()

// Apply the configuration to a rewarded ad unit
val rewardedAd = LevelPlayRewardedAd("adUnitId", adConfig)

動画リワードの完全な実装についてはこちら

バナー広告での使用例

// Define a price floor configuration
var adConfig = new LevelPlayBannerAd.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build();

// Apply the configuration to a banner ad unit
var bannerAd = new LevelPlayBannerAdView(context, "adUnitId", adConfig);
// Define a price floor configuration
val adConfig = LevelPlayBannerAdView.Config.Builder()
 .setBidFloor(1.23) // Set the price floor in USD
 .build()

// Apply the configuration to a banner ad unit
val bannerAd = LevelPlayBannerAdView(context, "adUnitId", adConfig)

バナーの完全な実装についてはこちら

ironSource SDK エラーコード

ironSource は、SDK実装の失敗の説明を提供するエラーフィードバックメカニズムを提供します。何か問題が発生した場合、または実装の一部が正しく完了しなかった場合に、これらのエラーが発生します。

ironSource Error オブジェクトには、error codemessage が含まれています。以下これらはすべて、考えられるエラーとその機能に基づくメッセージです:

Error Codes Ad Unit Description
508 N/A • メディエーション・ネットワークの初期化失敗
• Demand Only モード以外で Demand Only API が呼ばれた
• Demand Only モードで Demand Only ではない API が呼ばれた
509 Interstitial 表示失敗:表示できる広告が無い
Rewarded Video
510 Interstitial ロード失敗:サーバーレスポンス失敗
Rewarded Video
Banner
520 Interstitial 表示失敗:インターネット接続無し( ShouldTrackNetworkState が有効の場合)
Rewarded Video 表示失敗:インターネット接続無し
524 Interstitial 表示失敗:プレースメントがペーシング制限に達している
表示失敗:プレースメントがキャッピング制限に達している
Rewarded Video
526 Interstitial 表示失敗:広告ユニットが一日のキャッピング制限に達している
Rewarded Video
604 Banner ロード失敗:プレースメントがキャッピング制限に達している
605 Banner ロード失敗:バナーのロード中に予期しない例外が発生
606 Banner ロード失敗:全てのアドネットワークインスタンスの在庫無
1007 Interstitial オークション失敗:オークションリクエストに必要な情報を全て含まれていない
Rewarded Video
1022 Rewarded Video 表示失敗:RV 表示中に新たな RV の表示は不可
1023 Rewarded Video 表示失敗:表示できる広告がない時に Show RV が呼ばれた
1036 Interstitial 表示失敗:インタースティシャルの表示中に新たなインタースティシャルの表示は不可
1037 Interstitial ロード失敗:インタースティシャルの表示中に新たなインタースティシャルのロードは不可
1055 Rewarded Video ロード失敗:タイムアウトによるロードキャンセル
1056 Rewarded Video ロード失敗: RV の表示中に新たな RV のロードは不可