デリゲートメソッド — Android

最終更新:

Chartboost SDKのデリゲートメソッドを使えば、統合されたシステムをより大きな範囲で制御できるようになります。お客様の広告の目的に合わせてご活用ください。


目次


概要

Chartboost SDKのデリゲートメソッドを使用すると、統合されたシステムをより大きな範囲で制御できるようになります。例えば、次のようなことが実行できます。

  • ゲームがインタースティシャル広告を読み込もうとするときに、デバッグ メッセージをログに記録する
  • ユーザーがゲームを初めてプレイするときには、広告を表示しないようにする
  • ユーザーが広告をクリックしたか、または単に閉じたかを判断し、それに応じた動作を行う
  • ゲームの邪魔をするタイミングや場所では、インタースティシャル広告またはMoreAppsページが表示されないようにする

Chartboost Android SDKメソッドはダウンロード済みSDKdocフォルダ内にあり、いつでも好きな時に見ることができます。主なメソッドの実装例は、SDKパッケージのサンプルプロジェクトに入っています。


SDK構成メソッド

Chartboost SDK機能と設定へのアクセスを許可するメソッドです。

// 指定した場所でキャッシュされたインタースティシャル広告を確認する。
public static boolean hasInterstitial(String location)

// 指定した場所でキャッシュされたMoreAppsページを確認する。
public static boolean hasMoreApps(String location)

// 指定した場所でキャッシュされたリワードビデオを確認する。
public static boolean hasRewardedVideo(String location) 

// 何らかのビューが可視化されているか確認する。
public static boolean isAnyViewVisible()

// オートキャッシュ機能を有効/無効にする(デフォルトでは有効)には、これを設定する。*
public static void setAutoCacheAds(boolean autoCacheAds)

// 現在のオートキャッシュ動作(デフォルトではtrue)を取得する。*
public static boolean getAutoCacheAds()

// すべてのChartboost APIサーバーリクエストのPOSTボディに含めて送信するカスタム識別子を設定する。
public static void setCustomId(String customID)

// すべてのChartboost APIサーバーリクエストのPOSTボディに含まれる、現在送信されているカスタム識別子を取得する。
public static String getCustomID()

// Chartboost SDKが初回セッションでインタースティシャル広告を表示するかどうかを決定する。
public static void setShouldRequestInterstitialsInFirstSession(boolean shouldRequest)

//  Chartboost SDKがMoreApps UI表示準備中に読み込み画面を表示するかどうかを決定する。
public static void setShouldDisplayLoadingViewForMoreApps(boolean shouldDisplay)

// Chartboost SDKがChartboost APIサーバーからビデオデータ取得を試みるかどうかを決定する。
public static void setShouldPrefetchVideoContent(boolean shouldPrefetch)

* 自動キャッシュやその他、通常の広告キャッシュについてはこちらをご覧ください。


SDKデリゲートの設定

まず、以下のようにアクティビティのonCreate()メソッドにChartboostデリゲートを設定します。

Chartboost.setDelegate(YourDelegateObject);

次に、デリゲート オブジェクトのインスタンスを作成し、以下のようにデリゲートメソッドを宣言します。

private ChartboostDelegate YourDelegateObject = new ChartboostDelegate() {
// ここにデリゲートメソッドを宣言する。CBSampleプロジェクトの例を参照。
};

スタティック/ビデオ・インタースティシャル広告のデリゲートメソッド

// Chartboost APIサーバーからインタースティシャル広告をリクエストする前に呼び出される。
public boolean shouldRequestInterstitial(String location)

// インタースティシャル広告が画面に表示される前に呼び出される。
public boolean shouldDisplayInterstitial(String location)

// インタースティシャル広告が画面に表示された後に呼び出される。
public void didDisplayInterstitial(String location)

// Chartboost APIサーバーからインタースティシャル広告が読み込まれ、
// ローカルにキャッシュされた後に呼び出される。
public void didCacheInterstitial(String location)

// Chartboost APIサーバーからインタースティシャル広告読み込みが試行され、
// 失敗した後に呼び出される。
public void didFailToLoadInterstitial(String location, CBImpressionError error)

// インタースティシャル広告が破棄された後に呼び出される。
public void didDismissInterstitial(String location)

// インタースティシャル広告が閉じられた後に呼び出される。
public void didCloseInterstitial(String location)

// インタースティシャル広告がクリックされた後に呼び出される。
public void didClickInterstitial(String location)

MoreAppsのデリゲートメソッド

// MoreAppsページが画面に表示される前に呼び出される。
public boolean shouldDisplayMoreApps(String location)

// MoreAppsページが画面に表示された後に呼び出される。
public void didDisplayMoreApps(String location)

// Chartboost APIサーバーからMoreAppsページが読み込まれ、
// ローカルにキャッシュされた後に呼び出される。
public void didCacheMoreApps(String location)

// MoreAppsページが破棄された後に呼び出される。
public void didDismissMoreApps(String location)

// MoreAppsページが閉じられた後に呼び出される。
public void didCloseMoreApps(String location)

// MoreAppsページがクリックされた後に呼び出される。
public void didClickMoreApps(String location)

// Chartboost APIサーバーからMoreAppsページ読み込みが試行され、
// 失敗した後に呼び出される。
public void didFailToLoadMoreApps(String location, CBImpressionError error)

リワードビデオのデリゲートメソッド

(Chartboostビデオの詳細は、こちらをご覧ください。)

// リワードビデオが画面に表示される前に呼び出される。
public boolean shouldDisplayRewardedVideo(String location)

// リワードビデオが画面に表示された後に呼び出される。
public void didDisplayRewardedVideo(String location)

// Chartboost APIサーバーからリワードビデオが読み込まれ、
// ローカルにキャッシュされた後に呼び出される。
public void didCacheRewardedVideo(String location)

// Chartboost APIサーバーからリワードビデオ読み込みが試行され、
// 失敗した後に呼び出される。
public void didFailToLoadRewardedVideo(String location, CBImpressionError error)

// リワードビデオが破棄された後に呼び出される。
public void didDismissRewardedVideo(String location)

// リワードビデオが閉じられた後に呼び出される。
public void didCloseRewardedVideo(String location)

// リワードビデオがクリックされた後に呼び出される。
public void didClickRewardedVideo(String location)

// ユーザーがリワードビデオの視聴を完了し、リワードを獲得できるようになると呼び出される。
public void didCompleteRewardedVideo(String location, int reward)

// 指定したCBLocationでビデオが画面に表示される旨を通知されるようにするには、 
// これを実装する。エフェクトやサウンドを消音にすることもできる。
public void willDisplayVideo(String location)

ネイティブ広告のデリゲートメソッド

// Chartboost APIサーバーからネイティブ広告が読み込まれ、
// ローカルにキャッシュされた後に呼び出される。
public void didCacheInPlay(String location)

// Chartboost APIサーバーからネイティブ広告読み込みが試行され、
// 失敗した後に呼び出される。
public void didFailToLoadInPlay(String location, CBImpressionError error)

その他のデリゲートメソッド

// アプリによりクリックが登録されると呼び出されるが、ユーザーはApp Storeには転送されない。
public void didFailToRecordClick(String uri, CBClickError error)

// SDKが正常に初期化され、ビデオの事前取得が完了した後に呼び出される。
public void didInitialize()
{ Log.i("Chartboost, DID INITIALIZE! ")); }

年齢確認デリゲートメソッド

Androidの年齢確認デリゲートメソッドは廃止されました。