本指南將說明如何使用原生廣告外掛程式在 Unity 應用程式中導入原生廣告,以及過程中需要考量的一些重要事項。
原生廣告的格式和功能可融入所在位置的使用者體驗。外觀設計也與所在應用程式的視覺設計相符。Ad Manager 的原生廣告格式可讓發布商顯示與內容完美融合的廣告。您可以使用這項技術實作高度自訂的算繪作業,充分利用 Unity 應用程式中的原生程式碼。
原生廣告會使用您建構應用程式的相同 GameObjects
類型顯示,並可根據其實際使用者體驗的視覺設計調整格式。原生廣告載入時,應用程式會收到包含素材資源和 Unity 應用程式的原生物件,而非 SDK,並顯示這些內容。
必要條件
載入原生廣告格式
系統會透過 AdLoader
類別載入原生廣告,該類別有專屬的 AdLoader.Builder
類別,可在建立時自訂。ForNativeAd()
方法會設定 AdLoader 處理原生廣告。
private void RequestNativeAd() {
AdLoader adLoader = new AdLoader.Builder(INSERT_AD_UNIT_HERE)
.ForNativeAd()
.Build();
}
註冊 AdLoader 廣告事件
如要在原生廣告成功載入或無法載入時收到通知,請針對下列事件將委派項目新增至 AdLoader
類別。
OnNativeAdLoaded
在成功載入原生廣告時叫用。必須為這個事件設定委派,才能存取載入的廣告。
OnAdFailedToLoad
在原生廣告無法載入時叫用。
載入廣告
完成 AdLoader
建構後,請呼叫其 LoadAd()
方法來請求廣告:
adLoader.LoadAd(new AdRequest.Builder().Build());
結合廣告請求
下列程式碼片段示範如何建構設為請求原生廣告的 AdLoader
、設定成功和失敗廣告的委派代表,以及發出廣告請求。
private void RequestNativeAd() {
AdLoader adLoader = new AdLoader.Builder(INSERT_AD_UNIT_HERE)
.ForNativeAd()
.Build();
adLoader.OnNativeAdLoaded += this.HandleNativeAdLoaded;
adLoader.OnAdFailedToLoad += this.HandleAdFailedToLoad;
adLoader.LoadAd(new AdRequest.Builder().Build());
}
處理失敗的廣告載入
OnAdFailedToLoad
事件的類型為 EventHandle<AdFailedToLoadEventArgs>
。以下顯示剖析此事件中廣告載入失敗的原因。
private void RequestNativeAd() {
...
adLoader.OnAdFailedToLoad += this.HandleNativeAdFailedToLoad;
}
private void HandleNativeAdFailedToLoad(object sender, AdFailedToLoadEventArgs args) {
Debug.Log("Native ad failed to load: " + args.Message);
}
顯示原生廣告
載入原生廣告時,系統會叫用對應廣告格式的廣告事件。接著,您的應用程式會負責顯示廣告,但不需要立即顯示廣告。
處理廣告載入
OnNativeAdLoaded
事件的類型為 EventHandler<NativeAdEventArgs>
。您可以從 NativeAdEventArgs
擷取 NativeAd
物件中封裝的廣告,如下所示:
private NativeAd nativeAd;
...
private void HandleNativeAdLoaded(object sender, NativeAdEventArgs args) {
Debug.Log("Native ad loaded.");
this.nativeAd = args.nativeAd;
}
擷取原生廣告素材資源
廣告載入完成後,您就可以存取廣告的素材資源,如下所示。圖形資源會以 Texture2D
物件的形式傳回,文字資產則以 string
物件的形式傳回。
private bool nativeAdLoaded;
private NativeAd nativeAd;
void Update() {
...
if (this.nativeAdLoaded) {
this.nativeAdLoaded = false;
// Get Texture2D for the icon asset of native ad.
Texture2D iconTexture = this.nativeAd.GetIconTexture();
// Get string for headline asset of native ad.
string headline = this.nativeAd.GetHeadlineText();
}
}
private void HandleNativeAdLoaded(object sender, NativeAdEventArgs args) {
Debug.Log("Native ad loaded.");
this.nativeAd = args.nativeAd;
this.nativeAdLoaded = true;
}
請注意,廣告素材資源只能在主執行緒上存取,例如透過 Unity 指令碼的 Update()
方法存取。另請注意,系統不一定會顯示下列素材資源,並且在顯示前需先檢查:
GetStarRating()
GetStore()
GetPrice()
GetAdvertiser()
GetIconTexture()
AdChoices 素材資源
原生廣告必須包含 AdChoices 廣告素材資源。 此外,請務必選擇讓 AdChoices 廣告素材資源一目瞭然,因此請務必選擇合適的背景顏色和圖片。
註冊遊戲物件的 GameObjects
您必須註冊 GameObject
,才能在 Unity 應用程式中顯示廣告素材資源。如果註冊成功,用來註冊 GameObject
的方法會傳回 bool
。如果是 List<GameObject>
,這個方法會傳回 int
,指出已成功註冊的 GameObject
計數。
如果廣告素材資源註冊失敗,系統將無法辨識對應原生廣告的曝光和點擊次數。
if (!this.nativeAd.RegisterIconImageGameObject(icon))
{
// Handle failure to register the icon ad asset.
}
註冊廣告素材資源的 GameObject
必須包含可代表 GameObject
大小和形狀的凸面平衡器元件。如果註冊廣告素材資源的 GameObject
物件缺少 Collider
元件,或設定錯誤,原生廣告將無法正常運作。
在下方的程式碼片段中,系統會將 BoxCollider
新增至 GameObject
,並使用 TextMesh
顯示原生廣告的標題廣告素材資源。將 BoxCollider
附加至 GameObject
後,系統會自動縮放以配合 TextMesh
元件的文字。
// Create GameObject that will display the headline ad asset.
GameObject headline = new GameObject();
headline.AddComponent<TextMesh>();
headline.GetComponent<TextMesh>().characterSize = 0.5 f;
headline.GetComponent<TextMesh>().anchor = TextAnchor.MiddleCenter;
headline.GetComponent<TextMesh>().color = Color.black;
// Get string of the headline asset.
string headlineText = this.nativeAd.GetHeadlineText();
headline.GetComponent<TextMesh>().text = headlineText;
// Add box collider to the GameObject which will automatically scale.
headline.AddComponent<BoxCollider>();
操作示範
以下程式碼示範如何擷取成功載入的原生廣告圖示素材資源、設定 Quad
的紋理以顯示圖示廣告素材資源,並註冊 GameObject
以顯示素材資源。此程序會擷取廣告素材資源,並以原生廣告類別註冊,因此在應用程式顯示的每個素材資源中,應重複執行此程序。
private GameObject icon;
private bool nativeAdLoaded;
private NativeAd nativeAd;
...
void Update() {
...
if (this.nativeAdLoaded) {
this.nativeAdLoaded = false;
// Get Texture2D for icon asset of native ad.
Texture2D iconTexture = this.nativeAd.GetIconTexture();
icon = GameObject.CreatePrimitive(PrimitiveType.Quad);
icon.transform.position = new Vector3(1, 1, 1);
icon.transform.localScale = new Vector3(1, 1, 1);
icon.GetComponent<Renderer>().material.mainTexture = iconTexture;
// Register GameObject that will display icon asset of native ad.
if (!this.nativeAd.RegisterIconImageGameObject(icon))
{
// Handle failure to register ad asset.
}
}
}
...
private void HandleNativeAdLoaded(object sender, NativeAdEventArgs args) {
Debug.Log("Native ad loaded.");
this.nativeAd = args.nativeAd;
this.nativeAdLoaded = true;
}