Skip to content

api unity

Jump to bottom
Yasuyuki Kamata edited this page Apr 9, 2021 · 1 revision

/*
Tiêu đề: Tài liệu tham khảo về API Unity Mô tả: Phân loại: 5 */

Tổng quan

Bài viết này ghi lại API cho các vùng chứa tên sau:

Advertisements

Sử dụng vùng chứa tên này để triển khai nội dung quảng cáo cơ bản, chẳng hạn như quảng cáo video có tặng thưởng hoặc không tặng thưởng, quảng cáo xen kẽ hoặc quảng cáo banner.

using UnityEngine.Advertisements;

Initialize

Khởi tạo dịch vụ quảng cáo, với ID Trò chơi được chỉ định, trạng thái chế độ thử nghiệm và thiết lập tải Vị trí.

public static void Initialize(string gameId, bool testMode, bool enablePerPlacementLoad)
Tham số Mô tả
gameId Mã định danh trò chơi Unity theo nền tảng cụ thể cho Dự án của bạn, được tìm thấy trong bảng điều khiển nhà phát triển.
testMode Chế độ thử nghiệm cho phép bạn kiểm tra sự tích hợp của mình mà không cần truyền tải quảng cáo trực tiếp. Sử dụng giá trị true để khởi tạo trong chế độ thử nghiệm.
enablePerPlacementLoad Bật vòng đời [API Load](#load)

Load

Tải nội dung quảng cáo cho Vị trí được chỉ định. Nếu bạn khởi tạo SDK khi enablePerPlacementLoadđang được bật, bạn cần gọi Load trước khi gọi Show[](#show).

public static void Load (string placementId)

Lưu ý: API Load đang trong giai đoạn beta kín và chỉ khả dụng khi được mời. Nếu bạn muốn được xem xét chuyển sang bản beta, vui lòng liên hệ bộ phận hỗ trợ Unity Ads.

IsReady

Trả về giá trị cho biết quảng cáo sẵn sàng hiển thị tại Vị trí được chỉ định hay chưa.

static bool IsReady (string placementId)

PlacementState

Các trạng thái Vị trí của Unity Ads được liệt kê.

enum UnityEngine.Advertisements.PlacementState
Giá trị Mô tả
Ready Vị trí đã sẵn sàng để hiển thị quảng cáo.
NotAvailable Vị trí không khả dụng.
Disabled Vị trí đã bị tắt.
Waiting Vị trí đang ở trạng thái chờ.
NoFill Vị trí không có quảng cáo để hiển thị.

Truy xuất giá trị PlacementState bằng hàm sau:

static PlacementState GetPlacementState (string PlacementId)

Show

Hiển thị nội dung tại Vị trí được chỉ định nếu nội dung đó đã sẵn sàng.

static void Show (string placementId)

IUnityAdsListener

Một giao diện để xử lý các trạng thái khác nhau của một quảng cáo. Triển khai trình nghe này trong tập lệnh của bạn để xác định logic cho quảng cáo có tặng thưởng. Giao diện gồm có các phương thức sau:

public interface IUnityAdsListener {
    void OnUnityAdsReady (string placementId);
    void OnUnityAdsDidError (string message);
    void OnUnityAdsDidStart (string placementId);
    void OnUnityAdsDidFinish (string placementId, ShowResult showResult);
}

Lưu ý: Unity đề xuất triển khai tất cả các phương thức này trong mã lệnh của bạn, ngay cả khi bạn không sử dụng hết.

OnUnityAdsready

Phương thức IUnityAdsListener đóng vai trò xử lý logic khi nội dung quảng cáo sẵn sàng hiển thị qua một Vị trí được chỉ định. Ví dụ:

void OnUnityAdsReady (string placementId) {
    Advertisement.Show (placementId);
}

OnUnityAdsDidError

Phương thức IUnityAdsListenerđóng vai trò xử lý logic khi nội dung quảng cáo không hiển thị do lỗi. Ví dụ:

void OnUnityAdsDidError (string errorMessage) {
    Debug.LogWarning (errorMessage);
}

OnUnityAdsDidsStart

Phương thức IUnityAdsListener đóng vai trò xử lý logic khi người chơi kích hoạt để phát một quảng cáo. Ví dụ:

void OnUnityAdsDidStart (string placementId) {
    Debug.Log (“The ad started playing.”);
}

OnUnityAdsDidfinished

Phương thức IUnityAdsListener đóng vai trò xử lý logic khi kết thúc một quảng cáo. Xác định hành vi có điều kiện cho từng trạng thái kết thúc khác nhau bằng cách truy cập kết quả ShowResult từ trình nghe (được ghi lại dưới đây). Ví dụ:

void OnUnityAdsDidFinish (string placementId, ShowResult showResult) {
    If (showResult == ShowResult.Finished) {
        // Reward the user for watching the ad to completion.
    } else if (showResult == ShowResult.Skipped) {
        // Do not reward the user for skipping the ad.
    } else if (showResult == ShowResult.Failed) {
        Debug.LogWarning (“The ad did not finish due to an error.);
    }
}

ShowResult

Các trạng thái tương tác của người dùng cuối với quảng cáo được liệt kê. SDK sẽ chuyển giá trị này đến phương thức gọi lại OnUnityAdsDidFinish sau khi quảng cáo hoàn tất.

enum UnityEngine.Advertisements.ShowResult
Giá trị Mô tả
Failed Cho biết quảng cáo không thể hoàn thành do lỗi của dịch vụ Unity.
Skipped Cho biết người dùng đã bỏ qua quảng cáo.
Finished Cho biết người dùng đã xem hết quảng cáo.

AddListener

SDK phiên bản 3.1+ cho phép bạn đăng ký nhiều trình nghe cùng lúc. Điều này đặc biệt hữu ích đối với khách hàng có sử dụng Hệ thống phân phối quảng cáo.

public static void AddListener (IUnityAdsListener listener)

RemoveListener

Cho phép bạn xóa một trình nghe đang hoạt động.

public static void RemoveListener (IUnityAdsListener listener)

Banner

Lớp tĩnh dành cho việc triển khai quảng cáo banner.

SetPosition

Đặt vị trí cho quảng cáo banner, sử dụng kiểu liệt kê BannerPosition.

public void SetPosition (BannerPosition bannerPosition)

BannerPosition

Các vị trí được liệt kê mà bạn có thể đặt làm điểm neo cho quảng cáo banner.

public enum BannerPosition {
    TOP_LEFT,
    TOP_CENTER,
    TOP_RIGHT,
    BOTTOM_LEFT,
    BOTTOM_CENTER,
    BOTTOM_RIGHT,
    CENTER
}

Load

Phương thức cơ bản để tải banner có nội dung quảng cáo. Bạn có thể điều chỉnh hàm này bằng cách thay đổi một vài tham số sao cho phù hợp với nhu cầu của mình.

Phương thức Mô tả
public static void Load () Tải quảng cáo banner với ID Vị trí mặc định và không sử dụng lệnh gọi lại.
public static void Load (BannerLoadOptions options) Tải quảng cáo banner với ID Vị trí mặc định nhưng kích hoạt lệnh gọi lại loadCallback khi tải thành công và lệnh gọi lạierrorCallback khi tải không thành công.
public static void Load (string placementID) Tải quảng cáo banner với ID Vị trí cụ thể và không sử dụng lệnh gọi lại.
public static void Load (string placementID, BannerLoadOptions options) Tải quảng cáo banner với ID Vị trí cụ thể nhưng kích hoạt lệnh gọi lạiloadCallback khi tải thành công và lệnh gọi lại errorCallback khi tải không thành công.

Sử dụng phương thức sau để kiểm tra xem nội dung đã tải thành công và sẵn sàng hiển thị chưa:

public static bool isLoaded ()

Show

Phương thức cơ bản để hiển thị nội dung quảng cáo banner. Bạn có thể điều chỉnh hàm này bằng cách thay đổi một vài tham số sao cho phù hợp với nhu cầu của mình.

Phương thức Mô tả
public static void Show () Hiển thị quảng cáo banner với ID Vị trí mặc định và không sử dụng lệnh gọi lại.
public static void Show (BannerOptions options) Hiển thị quảng cáo banner với ID Vị trí mặc định nhưng kích hoạt lệnh gọi lại showCallback khi nội dung có thể nhìn thấy và lệnh gọi lại hideCallback khi nội dung bị ẩn.
public static void Show (string placementID) Hiển thị quảng cáo banner với ID Vị trí cụ thể và không sử dụng lệnh gọi lại.
public static void Show (string placementID, BannerLoadOptions options) Hiển thị quảng cáo banner với ID Vị trí cụ thể nhưng kích hoạt lệnh gọi lại showCallback khi nội dung có thể nhìn thấy và lệnh gọi lại hideCallback khi nội dung bị ẩn.

BannerOptions

Chuyển các tùy chọn này về lại SDK để thông báo cho bộ công cụ này về các sự kiện trong phạm vi banner.

Lệnh gọi lại Mô tả
public BannerCallback showCallback { get; set; } Lệnh gọi lại này kích hoạt khi người chơi có thể nhìn thấy quảng cáo banner.
public BannerCallback hideCallback { get; set; } Lệnh gọi lại này kích hoạt khi quảng cáo banner bị ẩn khỏi người chơi.

BannerLoadOptions

Chuyển các tùy chọn này về lại SDK để thông báo cho bộ công cụ này về các sự kiện khi tải banner.

Lệnh gọi lại Mô tả
public LoadCallback loadCallback [get, set] Kích hoạt khi quảng cáo banner được tải xong và sẵn sàng hiển thị.
public ErrorCallback errorCallback [get, set] Lệnh gọi lại này kích hoạt khi xảy ra lỗi trong quá trình tải quảng cáo banner. Nếu lệnh gọi lại này được triệu gọi ra, hãy xem như banner không được tải. Bạn có thể thử gọi Load thêm một lần nữa .

Hide

Hàm này cho phép bạn ẩn quảng cáo banner, thay vì phá hủy hoàn toàn quảng cáo này.

public static void Hide (bool destroy = false);

Thuộc tính dịch vụ

isInitialized

Trả về giá trị cho biết hệ thống quảng cáo có được khởi tạo thành công hay không.

static bool isInitialized [get, set]

isSupported

Trả về giá trị cho biết nền tảng hiện tại có được SDK hỗ trợ hay không.

static bool isSupported [get]

debugMode

Kiểm soát số lượng đầu ra bản ghi được xuất từ SDK.

static bool debugMode [get, set]

version

Trả về phiên bản SDK Unity Ads đang hoạt động.

static string version [get]

isShowing

Trả về giá trị cho biết quảng cáo hiện có đang hiển thị hay không.

static bool isShowing [get, set]

Trở lại đầu trang

Monetization

Sử dụng vùng chứa tên Monetization để triển khai Vị trí Cá nhân hóa.

using UnityEngine.Monetization;

Initialize

Khởi tạo SDK cho Dự án của bạn.

public static void Initialize (string gameID, bool testMode)

Tham số gameId là ID Trò chơi của Dự án và bạn có thể tìm thấy trên Bảng điều khiển Nhà phát triển. Tham số testMode cho biết trò chơi có đang ở chế độ thử nghiệm hay không. Khi testMode làtrue , bạn sẽ chỉ nhìn thấy quảng cáo thử nghiệm. Khi testMode làfalse , bạn sẽ nhìn thấy quảng cáo trực tiếp. Sử dụng chế độ thử nghiệm trước khi khởi chạy trò chơi của bạn là điều quan trọng cần nhớ để tránh bị gắn cờ gian lận.

IsReady

Kiểm tra xem PlacementContent đã sẵn sàng cho Vị trí xác định chưa.

public static boolean IsReady (string placementId);

Tham số placementIdlà ID Vị trí như được cấu hình trong Bảng điều khiển Nhà phát triển. Hàm này trả về truenếu PlacementContent đã sẵn sàng, hoặcfalse nếu chưa sẵn sàng.

GetPlacementContent

Trả về đối tượng PlacementContentcho Vị trí xác định.

public static PlacementContent GetPlacementContent (string placementId);

Tham số placementIdlà ID Vị trí như được cấu hình trong Bảng điều khiển Nhà phát triển. Hàm này trả về đối tượng PlacementContentnếu đối tượng đó khả dụng, hoặc trả về null nếu không khả dụng.

Lưu ý: Khi đặt PlacementContentlàm một biến, bạn phải ép kiểu đối tượng này thành kiểu dữ liệu chính xác ([ShowAdPlacementContent](#showadplacementcontent) hoặc [PromoAdPlacementContent](#proplacepentcontent)). Để biết thêm thông tin, hãy tham khảo tài liệu về các loại nội dung.

IMonetizationListener

Giao diện mà bạn triển khai và chuyển tới SDK.

public interface IMonetizationListener {   
    void OnPlacementContentReady (string placementId, PlacementContent placementContent);   
    void OnPlacementContentStateChange (string placementId, PlacementContent placementContent, Monetization.PlacementContentState previousState, Monetization.PlacementContentState newState);
}

OnPlacementContentReady

Nhận một ID Vị trí và đối tượng PlacementContent, và quy định cách SDK xử lý nội dung đã sẵn sàng hiển thị.

OnPlacementContentStateChange

Quy định cách SDK xử lý một thay đổi trạng thái trong PlacementContentđược chuyển tới.

SetListener

Đặt trình nghe cho các sự kiện PlacementContent. Tham số trình nghe chính là trình nghe cho các lệnh gọi lại sự kiện.

public static void SetListener (IMonetizationListener listener);

GetListener

Trả về trình nghe Monetization hiện tại. Đối tượng trình nghe chính là trình nghe cho các lệnh gọi lại sự kiện.

public static IMonetizationListener GetListener ();

PlacementContent

Đối tượng đại diện cho nội dung kiếm tiền mà Vị trí của bạn có thể hiển thị.

RewardablePlacementContent

Mở rộng lớp PlacementContent, cung cấp tiện ích mở rộng cho nội dung có tặng thưởng.

ShowAdPlacementContent

Mở rộng lớp RewardablePlacementContent, cung cấp chức năng cho nội dung quảng cáo video.

Show

Khi PlacementContentđược ép kiểu thành ShowAdPlacementContent, hiển thị đối tượng này bằng cách sử dụng hàm Show. Bạn có thể chuyển một [phương thức gọi lại] (#showadcallbacks)cho biết liệu quảng cáo đã được xem hết, bị bỏ qua hay hiển thị không thành công, để xử lý phần thưởng trong trò chơi.

public void Show (ShowAdCallbacks showAdCallbacks)

public void Show (ShowAdFinishCallback finishCallback)

Với PlacementContentcó tặng thưởng, sử dụng trình nghe để kiểm tra xem nội dung đã hoàn thành chưa và xử lý hành vi mong muốn.

ShowAdCallbacks

Kiểu liệt kêShowResult được chuyển tới [[ShowOptions.resultCallback]]sau khi quảng cáo chạy.

Giá trị Mô tả
Finished Cho biết người chơi đã xem hết quảng cáo.
Skipped Cho biết người chơi không cho phép quảng cáo chạy xong.
Failed Cho biết quảng cáo hiển thị không thành công. 
public delegate void ShowAdFinishCallback (ShowResult finishState);

public delegate void ShowAdStartCallback ();

public struct ShowAdCallbacks {
    public ShowAdFinishCallback finishCallback;
    public ShowAdStartCallback startCallback;
}

PromoAdPlacementContent

Mở rộng lớp ShowAdPlacementContent, cung cấp chức năng cho nội dung Khuyến mãi Mua hàng Trong Ứng dụng. Để biết thêm thông tin, hãy tham khảo tài liệu về Khuyến mãi Bản địa.

gamerSid

Mã định danh máy chủ duy nhất được sử dụng trong lệnh gọi lại đổi từ máy chủ sang máy chủ.

public string gamerSid

Trở lại đầu trang

Clone this wiki locally