Android InRead Ads

簡介

InRead廣告是SDK6新增的內嵌式廣告, 您可將廣告放置在文章、列表中, 當App使用者滑動到您指定的位置時便可看見InRead廣告, 若該廣告為影音廣告, 會等待廣告出現在畫面中才會進行撥放。

InRead廣告分為下列三種:

大圖式: 夾雜在文章、列表中, 長寬比例為1200:627, 會根據父元件的大小縮放(Fit-Width)

300x250: 與大圖式相似, 差別為300x250並不會根據父元件的大小縮放

Anchor: 固定在螢幕下方的廣告, 廣告高度不會超過螢幕的30%

在介接方式上, 大圖、300x250與橫幅廣告相似, 而Anchor與懸浮廣告相似, 下列章節將說明如何串接InRead廣告

廣告串接方式

大圖式

大圖式和橫幅廣告的介接方式相似, 設置XML、初始廣告物件並請求廣告

Step 1: 設置廣告的XML (以ScrollView為例)

假設InRead廣告被夾在兩個TextView之間

 <?xml version="1.0" encoding="utf-8"?>
 <ScrollView xmlns:android="http://schemas.android.com/apk/res/android"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
     android:layout_marginLeft="15sp"
     android:layout_marginRight="15sp"
     android:layout_marginTop="50sp">
 
     <LinearLayout
         android:layout_width="match_parent"
         android:layout_height="match_parent"
         android:orientation="vertical"
         android:descendantFocusability="blocksDescendants"> <!-- Prevent auto-scroll after webview loaded -->
 
         <TextView
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:text="This is a long article. Please scroll down to find your inread ad.  ....">
         </TextView>
 
         <RelativeLayout
             android:id="@+id/inread_ad_container"
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:gravity="center_horizontal">
         </RelativeLayout>
 
         <TextView
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:text="This is a long article. Please scroll up to find your inread ad.  ....">
         </TextView>
 
     </LinearLayout>
 
 </ScrollView> 

Step 2: 廣告初始設置

您必須依序輸入Activity、廣告大小(TWMAdSize)、InRead大圖式版位ID以初始化InRead物件, 並且設置Listener偵聽廣告的Callback

重要! 請務必在onResume、onPause和onDestroy分別加上resume、pause和destroy函式, 避免廣告發生無法預期的問題

 public class MainActivity extends Activity{
    private RelativeLayout adContainer = null;
    private TWMInReadAdRect rectView = null;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       setContentView(R.layout.activity_main);
       adContainer = (RelativeLayout) findViewById(R.id.inread_ad_container);
    
       // Init InRead Object
       rectView = new TWMInReadAdRect(MainActivity.this,
             TWMAdSize.IN_READ_1200X627, "<TAMedia_InRead_AdUnitId>");
   
       // Set listener for inread.
       rectView.setAdListener(adListener); 
 
       // Add inread into container.
       adContainer.addView(rectView); 
    }
 
    @Override
    protected void onResume() {
       super.onResume();
       if (rectView != null) {
           rectView.resume();
       }
    }
    
    @Override
    protected void onPause() {
       if (rectView != null) {
           rectView.pause();
       }    
       super.onPause();
    }
    
    @Override
    protected void onDestroy() {
       if (rectView != null) {
           rectView.destroy();
       }   
       super.onDestroy();
    }
 
    private TWMAdViewListener adListener = new TWMAdViewListener() {
        @Override
        public void onReceiveAd(TWMAd twmAd) {
            // The callback is trigger when ad load successfully.
        }
        
        @Override
        public void onFailedToReceiveAd(TWMAd twmAd, TWMAdRequest.ErrorCode errorCode) {
            // The callback is trigger when ad load fail.
        }
        
        @Override
        public void onPresentScreen(TWMAd twmAd) {
            // The callback is triggered when user has clicked ad.
        }
        
        @Override
        public void onDismissScreen(TWMAd twmAd) {
            // The callback is triggered when user has returned to the app after clicking ad.
        }
 
        @Override
        public void onLeaveApplication(TWMAd twmAd) {
            // The callback would be trigeer when user has left the app.
        }
    };
 
 }

Step 3: 請求廣告

在您需要的地方呼叫loadAd以進行廣告請求

 // Request inread from TAMedia.
 if (rectView != null) {
    rectView.loadAd(new TWMAdRequest());
 }

300 x 250

介接方式上基本上與大圖式相同, 差別僅是初始InRead物件時, TWMAdSize必須設置為IAB_MRECT

Step 1: 設置廣告的XML (以ScrollView為例)

此部分設置與大圖式相同, 請參考大圖式 Step 1

Step 2: 廣告初始設置

您必須依序輸入Activity、廣告大小(TWMAdSize)、InRead 300x250版位ID以初始化InRead物件, 並且設置Listener偵聽廣告的Callback

重要! 請務必在onResume、onPause和onDestroy分別加上resume、pause和destroy函式, 避免廣告發生無法預期的問題

 public class MainActivity extends Activity{
    private RelativeLayout adContainer = null;
    private TWMInReadAdRect rectView = null;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       setContentView(R.layout.activity_main);
       adContainer = (RelativeLayout) findViewById(R.id.inread_ad_container);
    
       // Init InRead Object
       rectView = new TWMInReadAdRect(MainActivity.this,
             TWMAdSize.IAB_MRECT, "<TAMedia_InRead_AdUnitId>");
   
       // Set listener for inread.
       rectView.setAdListener(adListener); 
 
       // Add inread into container.
       adContainer.addView(rectView); 
    }
 
    @Override
    protected void onResume() {
       super.onResume();
       if (rectView != null) {
           rectView.resume();
       }
    }
    
    @Override
    protected void onPause() {
       if (rectView != null) {
           rectView.pause();
       }    
       super.onPause();
    }
    
    @Override
    protected void onDestroy() {
       if (rectView != null) {
           rectView.destroy();
       }   
       super.onDestroy();
    }
 
    private TWMAdViewListener adListener = new TWMAdViewListener() {
        @Override
        public void onReceiveAd(TWMAd twmAd) {
            // The callback is trigger when ad load successfully.
        }
        
        @Override
        public void onFailedToReceiveAd(TWMAd twmAd, TWMAdRequest.ErrorCode errorCode) {
            // The callback is trigger when ad load fail.
        }
        
        @Override
        public void onPresentScreen(TWMAd twmAd) {
            // The callback is triggered when user has clicked ad.
        }
        
        @Override
        public void onDismissScreen(TWMAd twmAd) {
            // The callback is triggered when user has returned to the app after clicking ad.
        }
 
        @Override
        public void onLeaveApplication(TWMAd twmAd) {
            // The callback would be trigeer when user has left the app.
        }
    };
 
 }

Step 3: 請求廣告

在您需要的地方呼叫loadAd以進行廣告請求

 // Request inread from TAMedia.
 if (rectView != null) {
    rectView.loadAd(new TWMAdRequest());
 }

Anchor

Anchor和前面兩種廣告較為不同, 不需事先設置XML或透過程式動態加入廣告View(addView), 只要直接初始InRead物件並請求廣告即可。

Step 1: 廣告初始設置

您必須依序輸入Activity、InRead Anchor版位ID以初始化InRead物件, 並且設置Listener偵聽廣告的Callback

重要! 請務必在onResume、onPause和onDestroy分別加上resume、pause和destroy函式, 避免廣告發生無法預期的問題

 public class MainActivity extends Activity{
    private TWMInReadAdAnchor anchorView = null;
    
    @Override
    protected void onCreate(Bundle savedInstanceState) {
       super.onCreate(savedInstanceState);
       setContentView(R.layout.activity_main);
    
       // Init InRead Object
       anchorView = new TWMInReadAdAnchor(MainActivity.this, "<TAMedia_InRead_AdUnitId>");
   
       // Set listener for inread.
       anchorView.setAdListener(adListener); 
    }
 
    @Override
    protected void onResume() {
       super.onResume();
       if (anchorView != null) {
           anchorView.resume();
       }
    }
    
    @Override
    protected void onPause() {
       if (anchorView != null) {
           anchorView.pause();
       }    
       super.onPause();
    }
    
    @Override
    protected void onDestroy() {
       if (anchorView != null) {
           anchorView.destroy();
       }   
       super.onDestroy();
    }
 
    private TWMAdViewListener adListener = new TWMAdViewListener() {
        @Override
        public void onReceiveAd(TWMAd twmAd) {
            // The callback is trigger when ad load successfully.
        }
        
        @Override
        public void onFailedToReceiveAd(TWMAd twmAd, TWMAdRequest.ErrorCode errorCode) {
            // The callback is trigger when ad load fail.
        }
        
        @Override
        public void onPresentScreen(TWMAd twmAd) {
            // The callback is triggered when user has clicked ad.
        }
        
        @Override
        public void onDismissScreen(TWMAd twmAd) {
            // The callback is triggered when user has returned to the app after clicking ad.
        }
 
        @Override
        public void onLeaveApplication(TWMAd twmAd) {
            // The callback would be trigeer when user has left the app.
        }
    };
 
 }

Step 2: 請求廣告

在您需要的地方呼叫loadAd以進行廣告請求

 // Request inread from TAMedia.
 if (anchorView!= null) {
    anchorView.loadAd(new TWMAdRequest());
 }

測試模式

若需要進行廣告投放的測試,可以透過測試模式來請求廣告, ※測試模式將不會紀錄任何的曝光以及點擊數據

以下以Anchor為範例, 假設您已完成 Anchor Step 1

請求廣告

TWMAdRequest request = new TWMAdRequest();
String deviceId = getDeviceId(getBaseContext());
request.addTestDevice(deviceId); // 加入測試的手機Id
anchorView.loadAd(request);

實作函式以取得Device Id

 private String getDeviceId(final Context context) {
     String deviceId = null;
     try {
             deviceId = android.provider.Settings.Secure.getString(
                             context.getContentResolver(), Secure.ANDROID_ID);
             if (deviceId!= null) {
                return convertToMD5ID(deviceId);
             }
     } catch (Exception e) {
             Log.e("getDeviceId", e.getMessage(), e);
     }
     return deviceId;
 }
 private String convertToMD5ID(final String string) {
     if (string == null) {
             return null;
     }
     try {
         MessageDigest md = MessageDigest.getInstance("MD5");
           md.update(string.getBytes());
           BigInteger number = new BigInteger(1, md.digest());
           String md5 = number.toString(16);
           while (md5.length() < 32)
         md5 = "0" + md5;
         return md5;
     } catch (NoSuchAlgorithmException e) {
         return null;
     }
 }