Tài liệu tham khảo về Unity Ads iOS SDK API

Sử dụng thư viện UnityAds.h để triển khai nội dung quảng cáo cơ bản, chẳng hạn như video quảng cáo có thưởng hoặc không có thưởng, quảng cáo xen kẽ hoặc banner quảng cáo.

#import "UnityAds.h"

Bài viết này bao gồm những tài liệu sau đây về API:

Lớp

• UnityAds
• UADSLoadOptions
• UADSBannerView

Kiểu liệt kê

• UnityAdsBannerPosition
• UnityAdsInitializationError
• UnityAdsLoadError
• UnityAdsShowError
• UnityAdsError

Lệnh ủy quyền

• UnityAdsInitializationDelegate
• UnityAdsLoadDelegate
• UnityAdsShowDelegate
• UADSBannerDelegate
• UADSBannerAdRefreshViewDelegate

Lớp

Lớp

UnityAds

UnityAds

#import <UnityAds/UnityAds.h>

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 banner quảng cáo.

initialize

initialize

+ (void) initialize: (NSString *)gameId
  testMode: (BOOL)testMode
  initializationDelegate: (nullable id<UnityAdsInitializationDelegate>)initializationDelegate;
}

Khởi chạy 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à lệnh ủy quyền khởi chạy.

load

load

+ (void)load: (NSString *)placementId options: (UADSLoadOptions *)options loadDelegate: (nullable id<UnityAdsLoadDelegate>)loadDelegate {
  [UADSLoadModule.sharedInstance loadForPlacementID: placementId
                                            options: options
                                       loadDelegate: loadDelegate];
}

Tải nội dung quảng cáo cho một Đơn vị Quảng cáo được chỉ định. Bạn phải đặt lệnh gọi load trước khi đặt lệnh gọi show.

isReady

isReady

+ (BOOL)isReady: (NSString *)adUnitId {
  return [UnityServices isSupported] && [UnityServices isInitialized] && [UADSPlacement isReady: adUnitId];
}

Trả về YES nếu quảng cáo đã sẵn sàng hiển thị trong Đơn vị Quảng cáo được chỉ định. Nếu bạn khởi chạy SDK khi enablePerPlacementLoad đang được bật, bạn phải đặt lệnh gọi load trước khi đặt lệnh gọi show.

.

show

show

+ (void)show: (UIViewController *)viewController placementId: (NSString *)placementId showDelegate: (nullable id<UnityAdsShowDelegate>)showDelegate {
  [self show: viewController
    adUnitId: placementId
     options: [UADSShowOptions new]
showDelegate: showDelegate];
}

Hiển thị nội dung quảng cáo đã tải trong Đơn vị Quảng cáo được chỉ định.

addDelegate

addDelegate

+ (void)addDelegate: (__nullable id<UnityAdsDelegate>)delegate {
  [UADSProperties addDelegate: delegate];
}

Thêm lệnh ủy quyền hàm lắng nghe sự kiện sẽ nhận được lệnh gọi lại Unity Ads. Trong phiên bản 3.1.0 trở lên, bạn có thể đăng ký nhiều hàm lắng nghe sự kiện. Điều này đặc biệt hữu ích đối với các khách hàng hệ thống phân phối quảng cáo.

removeDelegate

removeDelegate

+ (void)removeDelegate: (id<UnityAdsDelegate>)delegate {
  [UADSProperties removeDelegate: delegate];
}

Xóa hàm lắng nghe sự kiện UnityAdsDelegate đang hoạt động.

setDebugMode

setDebugMode

+ (BOOL)getDebugMode {
  return [UnityServices getDebugMode];
}

Kiểm soát số lượng đầu ra bản ghi được xuất từ SDK. Đặt thành YES để tạo bản ghi mạnh hơn.

getDebugMode

getDebugMode

+ (void)getDebugMode: (BOOL)enableDebugMode {
  [UnityServices setDebugMode: enableDebugMode];
}

Trả về YES nếu SDK đang ở chế độ gỡ lỗi và NO nếu SDK không ở chế độ gỡ lỗi.

getVersion

getVersion

+ (NSString *)getVersion {
  return [UnityServices getVersion];
}

Trả về phiên bản SDK Unity Ads hiện tại.

isInitialized

isInitialized

+ (BOOL)isInitialized {
  return [USRVSdkProperties isInitialized];
}

Trả về YES nếu SDK được khởi chạy thành công và NO nếu SDK không được khởi chạy thành công.

UADSLoadOptions

UADSLoadOptions

#import <UnityAds/UADSBaseOptions.h>

@interface UADSLoadOptions : UADSBaseOptions

@property (nonatomic, readwrite) NSString *adMarkup;

@end

Lớp này chứa siêu dữ liệu tùy chọn để đưa vào bằng phương thức load. Khách hàng sử dụng tính năng đặt giá thầu theo tiêu đề trong hệ thống phân phối quảng cáo bên thứ ba nên sử dụng tính năng này trong trường hợp người đặt giá thầu từ mạng Unity thắng phiên đấu giá quảng cáo.

setAdMarkup

setAdMarkup

- (void)setAdMarkup: (NSString *)adMarkup

Phương thức này lấy chênh lệch giá quảng cáo được trả về từ dịch vụ cho đơn vị đặt giá. Khi đơn vị đặt giá từ mạng quảng cáo của Unity thắng phiên đấu giá thầu theo tiêu đề, SDK Unity Ads sẽ nhận được chênh lệch giá quảng cáo từ sàn giao dịch trung gian. Chuỗi chênh lệch giá quảng cáo chứa thông tin cần thiết để Unity tải và hiển thị quảng cáo.

UADSBannerView

UADSBannerView

@interface UADSBannerView : UIView

Sử dụng lớp này để triển khai banner quảng cáo. Unity Ads phiên bản 3.3 trở lên hỗ trợ nhiều phiên bản banner thông qua một Đơn vị Quảng cáo.

initWithPlacementId

initWithPlacementId

-(instancetype)initWithPlacementId:(NSString *)placementId size:(CGSize)size;

Triển khai khung nhìn banner bằng cách sử dụng ID Đơn vị Quảng cáo và kích thước banner. Đặt lệnh gọi initWithPlacementId để khởi chạy đối tượng, sau đó load để tải nội dung quảng cáo. Lưu ý rằng đối tượng banner truy cập các sự kiện vòng đời thông qua hàm lắng nghe sự kiện UADSBannerViewDelegate của chúng.

load

load

- (void)load;

Phương thức cơ bản để yêu cầu quảng cáo cho banner.

Kiểu liệt kê

Kiểu liệt kê

UnityAdsPlacementState

UnityAdsPlacementState

typedef NS_ENUM(NSInteger, UnityAdsPlacementState)

Các trạng thái được liệt kê của Đơn vị Quảng cáo.

UnityAdsFinishState

UnityAdsFinishState

typedef NS_ENUM(NSInteger, UnityAdsFinishState)

Các trạng thái tương tác của người dùng 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 unityAdsDidFinish sau khi quảng cáo hoàn tất.

UnityAdsInitializationError

UnityAdsInitializationError

typedef NS_ENUM (NSInteger, UnityAdsInitializationError)

Các lý do liệt kê cho việc không khởi chạy được SDK.

UnityAdsLoadError

UnityAdsLoadError

typedef NS_ENUM (NSInteger, UnityAdsLoadError)

Các lý do được liệt kê cho Đơn vị Quảng cáo không tải được.

UnityAdsShowCompletionState

UnityAdsShowCompletionState

typedef NS_ENUM (NSInteger, UnityAdsShowCompletionState)

Các lý do liệt kê cho quảng cáo đã kết thúc.

UnityAdsShowError

UnityAdsShowError

typedef NS_ENUM (NSInteger, UnityAdsShowError)

Các lý do được liệt kê cho Đơn vị Quảng cáo không hiển thị được.

UnityAdsError

UnityAdsError

typedef NS_ENUM (NSInteger, UnityAdsError)

Các lý do được liệt kê của lỗi Unity Ads phát sinh thông qua lệnh gọi lại unityAdsDidError.

UnityAdsBannerPosition

UnityAdsBannerPosition

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.

Lệnh ủy quyền

Lệnh ủy quyền

UnityAdsInitializationDelegate

UnityAdsInitializationDelegate

@protocol UnityAdsInitializationDelegate <NSObject>
- (void)initializationComplete;
- (void)initializationFailed: (UnityAdsInitializationError)error withMessage: (NSString *)message;
@end

Triển khai lệnh ủy quyền này để xử lý kết quả initialize.

initializationComplete

initializationComplete

Phương thức gọi lại này xử lý logic cho SDK khởi chạy thành công.

initializationFailed

initializationFailed

Phương thức gọi lại này xử lý logic cho SDK không khởi chạy được.

UnityAdsLoadDelegate

UnityAdsLoadDelegate

@protocol UnityAdsLoadDelegate <NSObject>
- (void)unityAdsAdLoaded: (NSString *)placementId;
- (void)unityAdsAdFailedToLoad: (NSString *)placementId
                     withError: (UnityAdsLoadError)error
                   withMessage: (NSString *)message;
@end

Triển khai lệnh ủy quyền này để xử lý kết quả load.

unityAdsAdLoaded

unityAdsAdLoaded

Phương thức gọi lại này xử lý logic cho Đơn vị Quảng cáo tải thành công.

unityAdsAdFailedToLoad

unityAdsAdFailedToLoad

Phương thức gọi lại này xử lý logic cho Đơn vị Quảng cáo không tải được.

UnityAdsShowDelegate

UnityAdsShowDelegate

@protocol UnityAdsShowDelegate <NSObject>
- (void)unityAdsShowComplete: (NSString *)adUnitId withFinishState: (UnityAdsShowCompletionState)state;
- (void)unityAdsShowFailed: (NSString *)adUnitId withError: (UnityAdsShowError)error withMessage: (NSString *)message;
- (void)unityAdsShowStart: (NSString *)adUnitId;
- (void)unityAdsShowClick: (NSString *)adUnitId;
@end

Triển khai lệnh ủy quyền này để xử lý kết quả show.

unityAdsShowComplete

unityAdsShowComplete

Phương thức gọi lại này xử lý logic cho quảng cáo kết thúc.

unityAdsShowStart

unityAdsShowStart

Phương thức gọi lại này xử lý logic cho quảng cáo bắt đầu phát.

unityAdsShowClick

unityAdsShowClick

Phương thức gọi lại này xử lý logic cho người dùng nhấp vào quảng cáo.

unityAdsShowFailed

unityAdsShowFailed

Phương thức gọi lại này xử lý logic cho Đơn vị Quảng cáo không hiển thị được nội dung.

UnityAdsDelegate

UnityAdsDelegate

@protocol UnityAdsDelegate <NSObject>
- (void)unityAdsReady: (NSString *)placementId;
- (void)unityAdsDidError: (UnityAdsError)error withMessage: (NSString *)message;
- (void)unityAdsDidStart: (NSString *)placementId;
- (void)unityAdsDidFinish: (NSString *)placementId
          withFinishState: (UnityAdsFinishState)state;
@end

Triển khai lệnh ủy quyền này để xử lý các trạng thái quảng cáo khác nhau. Triển khai lệnh ủy quyền này trong tập lệnh của bạn để xác định logic cho quảng cáo có thưởng.

unityAdsReady

unityAdsReady

Xác định logic cho nội dung quảng cáo sẵn sàng hiển thị thông qua một Đơn vị Quảng cáo được chỉ định.

unityAdsDidError

unityAdsDidError

Xác định logic cho nội dung quảng cáo không hiển thị được do lỗi.

unityAdsDidStart

unityAdsDidStart

Xác định logic cho người chơi kích hoạt quảng cáo để hiển thị.

unityAdsDidFinish

unityAdsDidFinish

Xác định logic cho người chơi xem toàn bộ quảng cáo.

UADSBannerDelegate

UADSBannerDelegate

@protocol UADSBannerViewDelegate <NSObject>

@optional
- (void)bannerViewDidLoad: (UADSBannerView *)bannerView;
- (void)bannerViewDidClick: (UADSBannerView *)bannerView;
- (void)bannerViewDidLeaveApplication: (UADSBannerView *)bannerView;
- (void)bannerViewDidError: (UADSBannerView *)bannerView error: (UADSBannerError *)error;
@end

Lệnh ủy quyền này cung cấp lệnh gọi lại từ các sự kiện banner của Unity Ads.

bannerViewDidLoad

bannerViewDidLoad

Lệnh gọi lại này kích hoạt khi banner đã tải thành công nội dung quảng cáo.

bannerViewDidClick

bannerViewDidClick

Lệnh gọi lại này kích hoạt khi người dùng nhấp vào banner quảng cáo.

bannerViewDidLeaveApplication

bannerViewDidLeaveApplication

Lệnh gọi lại này kích hoạt khi banner bị đóng do người dùng thoát khỏi ứng dụng.

bannerViewDidError

bannerViewDidError

Lệnh gọi lại này kích hoạt khi UnityAdsBanner gặp lỗi.

UADSBannerAdRefreshViewDelegate

UADSBannerAdRefreshViewDelegate

@protocol UADSBannerAdRefreshViewDelegate <NSObject>

@optional
- (void)unityAdsRefreshBannerDidLoad: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidNoFill: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidShow: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidHide: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidClick: (UADSBannerAdRefreshView *)bannerAdRefreshView;
- (void)unityAdsRefreshBannerDidError: (UADSBannerAdRefreshView *)bannerAdRefreshView message: (NSString *)message;
@end

Lệnh ủy quyền này cung cấp lệnh gọi lại từ các sự kiện banner làm mới của Unity Ads.

unityAdsRefreshBannerDidLoad

unityAdsRefreshBannerDidLoad

Được gọi khi đã tải banner và sẵn sàng được đặt trong phân cấp khung nhìn.

unityAdsRefreshBannerDidNoFill

unityAdsRefreshBannerDidNoFill

Được gọi khi không có nội dung quảng cáo nào cho banner.

unityAdsRefreshBannerDidShow

unityAdsRefreshBannerDidShow

Được gọi khi banner hiển thị với người dùng.

unityAdsRefreshBannerDidHide

unityAdsRefreshBannerDidHide

Được gọi khi banner ẩn với người dùng.

unityAdsRefreshBannerDidClick

unityAdsRefreshBannerDidClick

Được gọi khi người dùng nhấp vào banner quảng cáo.

unityAdsRefreshBannerDidError

unityAdsRefreshBannerDidError

Được gọi khi UnityAdsBanner gặp lỗi.