Jumptap Android SDK Integration

提供：

目次 1 概要 2 ライブラリのダウンロード 3 インストール 4 ライブラリの使用 4.1 アクセス許可 4.2 初期化 4.3 アドビューリスナの設定 5 JtAdViewメソッド 5.1 JtAdViewクラスのオプションのメソッド 5.2 JtAdWidgetSettingsクラスのオプションのメソッド 6 XMLで設定可能なプロパティ 7 FAQ(よくある質問)

概要

このWikiページでは、Android開発者を対象としたJumpTap Android(JtAdView)広告ライブラリのインストールおよび使用方法について説明します。 最新バージョンのライブラリ(1.1.10.4)はSDK 1.5(API 3)と互換性があります。

ライブラリのダウンロード

最新バージョンのライブラリをダウンロードするには、ここをクリックしてください(バージョン2.1.10.2、リリース日8/16/2011)-> ファイル:Download.gif

インストール

ライブラリを使用するには、Jumptapライブラリ(jarファイル)をプロジェクトに追加します。

ライブラリの使用

アクセス許可

次のアクセス許可をAndroidManifest.xmlに追加します：

<uses-permission android:name="android.permission.INTERNET" />

<uses-permission android:name="android.permission.READ_PHONE_STATE" />

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

ACCESS_COARSE_LOCATIONアクセス許可を使用すると、場所情報をJumptapに送信できるため、場所別にターゲットを絞った広告をアプリに配信することができます。 場所でターゲットを絞った広告を受け取りたくない場合は、このアクセス許可を省いても構いません。

初期化

JtAdWidgetSettings s = JtAdWidgetSettingsFactory.createWidgetSettings();
s.setHostURL("http://a.adjust-sp.jp/a/ads?textOnly=f");
s.setLanguage("ja");
s.setPublisherId(パブリッシャーID)；
s.setSpotId(アドスポットID)；
s.setSiteId(サイトID)；
JtAdView adView = new JtAdView(TestActivity.this, s);

アドビューリスナの設定

JtAdViewウィジェットから通知を受け取るには、JtAdViewListenerインターフェイスを実装し、JtAdView.setAdViewListener(listener) apiを使用してこれを設定します。

JtAdViewメソッド

JtAdViewクラスのオプションのメソッド

public void refreshAd() 広告を今すぐ最新状態に更新します。 </pre>

JtAdWidgetSettingsクラスのオプションのメソッド

public JtAdWidgetSettings copy()

同じ設定が含まれる新しいインスタンスにJtAdWidgetSettingsのインスタンスをコピーします。

戻り値： 同じ設定が含まれるJtAdWidgetSettingsの新規インスタンス

public java.lang.String getPublisherId()

Jumptapから指定された"パブリッシャーID"

戻り値： パブリッシャーIDの文字列

public void setPublisherId(java.lang.String publisherId)

Jumptapから指定された"パブリッシャーID"を設定します。

パラメータ： publisherId - 新規パブリッシャーID

public java.lang.String getSiteId()

"サイト"はオプションで、追加のアプリケーション(Jumptap提供)を指定する際に使用されます。"サイト"はアプリケーションが複数ある場合に使用されます。 サイトはオプションで、アプリケーションが1つしかない場合は、通常は提供されません。 サイト名はJumptapから指定されます。

戻り値： サイトIDの文字列

public void setSiteId(java.lang.String siteId)

Jumptapから指定された"サイトID"を設定します。

パラメータ： siteId - 新規サイトID

public java.lang.String getSpotId()

"アドスポット"は、アプリケーション(Jumptap提供)内の特定のページ、またはセクションを指定する場合に使用されます。

戻り値： スポットIDの文字列

public void setSpotId(java.lang.String spotId)

Jumptapより指定されたアドスポットIDを設定します。

パラメータ： spotId - 新規スポットID

public java.lang.String getHostURL()

HttpホストURL

戻り値： JumptapサーバーホストURLの文字列

public void setHostURL(java.lang.String host)

JumptapサーバーのホストURLを設定します。

パラメータ： host - 新規ホストURL

public java.lang.String getUserAgent(WebView webView)

WebViewのユーザーエージェント文字列を返します。

パラメータ： webView - ユーザーエージェントが含まれるWebview

戻り値： WebViewのユーザーエージェント文字列。

public java.lang.String getLanguage()

ユーザー定義の言語IDを指定します。

戻り値： 定義されている言語IDの文字列

public void setLanguage(java.lang.String language)

新規言語IDを設定します。

パラメータ： language - 新規言語

public java.lang.String getAdultContentType()

広告のどのアダルト区分を返せるか

戻り値： ユーザー定義のアダルトコンテンツの文字列

public void setAdultContentType(java.lang.String adultContent)

アダルトコンテンツを設定します。 JtAdWidgetSettings.AdultContentクラスを使用します。

パラメータ： adultContent - 許可されるアダルトコンテンツのタイプを設定します。

public java.lang.String getPostalCode()

ユーザー定義の郵便番号が提供されます。

戻り値： ユーザー定義の郵便番号の文字列

public void setPostalCode(java.lang.String postalCode)

郵便番号を設定します。

パラメータ： postalCode - 新規郵便番号

public java.lang.String getCountry()

ユーザー定義の国が提供されます。

戻り値： ユーザー定義の国の文字列

public void setCountry(java.lang.String country)

国を設定します。

パラメータ： country - 新規の国

public java.lang.String getAge()

ユーザーの年齢が提供されます。

戻り値： ユーザーの年齢を示す文字列

public void setAge(java.lang.String age)

ユーザーの年齢を設定します。

パラメータ： age - 新規の年齢

public java.lang.String getGender() ユーザーの性別が提供されます。

戻り値： ユーザーの性別を示す文字列

public void setGender(java.lang.String gender)

ユーザーの性別を設定します。

パラメータ： gender - ユーザーの性別

public java.lang.String getHHI()

ユーザーの世帯収入が提供されます。

戻り値： ユーザー定義の世帯収入を示す文字列

public void setHHI(java.lang.String hhi)

世帯収入を設定します。

パラメータ： hhi - 新規の世帯収入

public int getRefreshPeriod()

ユーザー定義の更新期間が提供されます。「0」は更新がないことを示します。更新が0に設定されている場合に広告を取得するには、JtAdViewでrefreshAdを使用する必要があります。

戻り値： ユーザー定義の更新期間を示す文字列

public void setRefreshPeriod(int refreshPeriod)

更新期間を設定します。「0」は更新がないことを示します。

パラメータ： refreshPeriod - 新規の更新期間

public java.lang.String getBundleVersion()

バンドルのバージョンを取得します。

戻り値： バンドルのバージョン

public void setAdFormat(java.lang.String adFormat)

広告形式を設定します。

パラメータ： adFormat - 新規の広告形式

public java.lang.String getJtLibVer()

Jumptap Android SDKバージョンを取得します。

戻り値： Jumptap Android SDKバージョン

public java.lang.String getVersion()

JumptapサーバーAPIのバージョンを取得します。

戻り値： Jumptapサーバーのバージョン

public void setVersion(java.lang.String version)

JumptapサーバーAPIのバージョンを設定します。

パラメータ： version - 新規バージョン

public void setShouldSendLocation(boolean shouldSendLocation)

場所をJumptapサーバーに送信するかどうかを制御するブール値。 デフォルトは「true」です。

パラメータ： shouldSendLocation - trueの場合、場所が送信されます。

public boolean isShouldSendLocation()

Jumptapウィジェットで場所をJumptapサーバーに送信するかどうかを返します。

戻り値： trueの場合、場所が送信されます。 falseの場合は、場所は送信されません。

public Bitmap getAlternateImage()

代替画像を取得します。

戻り値： 代替画像

public void setAlternateImage(Bitmap alternateImage)

広告取得中に表示される代替画像を設定します。 代替画像は背景色よりも優先順位が高くなります。

パラメータ： alternateImage - 代替画像

public int getBackgroundColor()

広告取得中に表示される背景色を取得します。

戻り値： 背景色

public void setBackgroundColor(int backgroundColor)

広告の処理中に表示される背景色を設定します。代替画像は背景色よりも高い優先順位で表示されます。

パラメータ： backgroundColor - 新規の背景色

public void setDismissButtonLabel(java.lang.String dismissButtonLabel)

インタースティシャルの表示中に表示される[閉じる]ボタンのラベルを設定します。

パラメータ： dismissButtonLabel - 新しい[閉じる]ボタンのラベル

public java.lang.String getDismissButtonLabel()

[閉じる]ボタンのラベルを取得します。

戻り値： [閉じる]ボタンのラベル

public void setInterstitialshowTime(int interstitialshowTime)

インタースティシャルの表示時間を秒単位で設定します。 このパラメータによって、インタースティシャルが自動終了するまでの表示時間が決定されます。

パラメータ： interstitialshowTime - 新規のinterstitial表示時間(秒)

public int getInterstitialshowTime()

ユーザー定義のインタースティシャル表示時間を取得します。 デフォルトは60秒です。

戻り値： インタースティシャル表示時間(秒)。

public java.lang.String getOs()

AndroidのOS名を返します。

戻り値： Android OS名

public void setApplicationId(java.lang.String appId)

ユーザーのアプリケーションIDを設定します(例"com.test.foo")

パラメータ： appId - ユーザーのアプリケーションID

public java.lang.String getApplicationId()

アプリケーションIDを返します。デフォルトは空の文字列です("")。

戻り値： アプリケーションID

public void setApplicationVersion(java.lang.String appVer)

アプリケーションのバージョンを設定します(例"2.2.2")。

パラメータ： appVer - アプリのアプリケーションバージョン

public java.lang.String getApplicationVersion()

アプリケーションのバージョンを返します。 デフォルトは空の文字列です("")。

戻り値： アプリケーションのバージョン

XMLで設定可能なプロパティ

プロパティ	メモ	必須
jumptapLib:publisherId	Jumptapから指定された"パブリッシャーID"	○
jumptapLib:siteId	サイトはオプションで、アプリケーションが1つしかない場合は通常は提供されません。 サイトIDはJumptapが指定します。	×
jumptapLib:spotId	アプリケーション(Jumptap提供)内の特定のページまたはセクションを指定する場合に使用されます。	×
jumptapLib:language	ユーザーの使用言語。 有効な値はISO-639-1の2文字の言語コードです。http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes	×
jumptapLib:category	広告が表示されるページ/サイト/アプリケーションについて最も正確に説明したカテゴリー。 このパラメータの値は、コンテキストに関する追加のターゲティング情報を広告サーバーに提供します。 有効なカテゴリー値の一覧は、有効なカテゴリーを参照してください。||×
jumptapLib:postalCode	緯度/経度を渡している場合は、postalCodeパラメータを設定しないでください。 このパラメータの値はエンコードする必要があります。 要求に郵便番号が含まれている場合は、国パラメータが必要になります。	×
jumptapLib:country	発信元ユーザーのリクエストの2文字のISO国コード。http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 広告リクエストを発信しているユーザーの国がはっきりとわかっている場合にのみ国を渡すようにしてください。すべてのリクエストの静的値として設定しないでください。 リクエストに国が含まれていない場合、国はユーザーまたはゲートウェイのIPに基づいて自動判別されます。 郵便番号(pc)パラメータを渡した場合は、国パラメータが必要です。 緯度/経度を渡している場合は、国パラメータを渡さないでください。	×
jumptapLib:age	ユーザーの年齢がわかっている場合に使用します。 1～199の任意の整数が有効な値となります。	×
jumptapLib:gender	ユーザーの性別がわかっている場合に使用します。 有効な値は'm'(男性)または'f'(女性)です。	×
jumptapLib:hhi	ユーザーの世帯収入がわかっている場合に、収入を1000ドル単位で示します。 有効な値は次のとおりです。 000_015 世帯収入が$15,000未満の場合 015_020 世帯収入が$15,000～$19,999の場合 020_030 世帯収入が$20,000～$29,999の場合 030_040 世帯収入が$30,000～$39,999の場合 040-050 世帯収入が$40,000～$49,999の場合 050-075 世帯収入が$50,000～$74,999の場合 075-100 世帯収入が$75,000～$99,999の場合 100_125 世帯収入が$100,000～$124,999の場合 125_150 世帯収入が$125,000～$149,999の場合 150_OVER 世帯収入が$150,000を超える場合	×
jumptapLib:alternateImage	広告取得中に表示される代替画像を設定します。 代替画像は背景色よりも高い優先順位で表示されます。	×
jumptapLib:jumptapLib:alternateColor	広告取得中に表示される背景色を設定します。 代替画像は背景色よりも高い優先順位で表示されます。	×
jumptapLib:refreshPeriodInSec	広告の更新時間(秒)。 0は更新がないことを示します(広告を取得するにはrefreshAdを呼び出す必要があります)。 デフォルトは60秒です。	×
jumptapLib:dismissLabel	インタースティシャル広告を閉じるためのボタンラベル。	×
jumptapLib:interstitialTime	このパラメータは、インターステーシャルが自動終了するまでの表示時間を設定します。	×
jumptapLib:applicationId	application Id (例 "com.test.foo")。イベントのトラッキングに使用されます。	×
jumptapLib:applicationVersion	現在のアプリケーションのバージョンです (例"2.2.2")。 イベントのトラッキングに使用されます。	×

FAQ(よくある質問)

1. 広告が返されていない場合、どうすれば確認できますか。

新しい広告が取得されると、JtAdViewListener. onNewAd,(JtAdView widget, int widgetId,String responseContent)が呼び出されます。

返されている広告がない場合は、JtAdViewListener.onNoAdFound(JtAdView widget, int widgetId)が呼び出されます。

エラー(ネットワークエラーなど)が発生すると、JtAdViewListener. onAdError ,(JtAdView widget, int widgetId, int errorCode)が呼び出されます。

JtAdViewListenerインターフェイスを実装し、これらのメソッドをオーバーライドすることができます(自社広告を表示するには、別のアドプロバイダを呼び出すか、アドウィジェットを非表示にします)。

2. Jumptap Android SDKでインタースティシャルを実装するにはどうすればよいですか。

<com.jumptap.adtag.JtAdInterstitial
android:layout_width="fill_parent" android:layout_height="wrap_content"
android:id="@+id/inter" jumptapLib:publisherId="add your publisher id"
jumptapLib:siteId="add your site id" jumptapLib:spotId="add your spot id" />

//JtAdWidgetSettingsインスタンスを作成します。
JtAdWidgetSettings s = JtAdWidgetSettingsFactory.createWidgetSettings();
		
//パブリッシャーID - お使いのパブリッシャーIDを設定します。
s.setPublisherId(set publisher Id);
//スポットID - お使いのスポットIDを設定します。
s.setSpotId(set spot Id);
/*ここに別の設定を追加します。*/

JtAdInterstitial inter = null;	
try {
	inter = new JtAdInterstitial(this, s);
} catch (JtException e) {
	e.printStackTrace();
	finish();
	return;
}
inter.setAdViewListener(this);
setContentView(inter);

タイムアウトする、およびユーザーが閉じる前にインタースティシャルを閉じるには：
inter.dismmiss();

ポップアップにインタースティシャルを表示するには：
inter.showAsPopup();

3. インタースティシャルの[閉じる]ボタンが機能しません

A. onInterstitialDismissedメソッドを実装して、インタースティシャルを閉じます。

B. setAdViewListenerメソッドを使用して、インタースティシャルリスナを設定します。

例：

inter.setAdViewListener(new JtAdViewListener() {
                  
      @Override
      public void onNoAdFound(JtAdView arg0, int arg1) {
      // TODO自動生成メソッドのスタブ
                        
      }
                  
      @Override
      public void onNewAd(JtAdView arg0, int arg1, String arg2) {
      // TODO自動生成メソッドのスタブ
                        
      }
                  
      @Override
      public void onInterstitialDismissed(JtAdView arg0, int arg1) {
      inter.setVisibility(View.GONE); //提案
                        
      }
                  
      @Override
      public void onFocusChange(JtAdView arg0, int arg1, boolean arg2) {
      // TODO自動生成メソッドのスタブ
                        
      }
                  
      @Override
      public void onAdError(JtAdView arg0, int arg1, int arg2) {
      // TODO自動生成メソッドのスタブ
                        
      }
});