loadAd

Cập nhật lần cuối: 23/5/2025

Bắt đầu hỗ trợ ở phiên bản:

• SDK: 2.37.0

import { loadAd } from "zmp-sdk/apis";

API dùng để tải quảng cáo. Có các loại quảng cáo sau đây:

ID	Size
ZMA_Masthead	480x270
ZMA_Middle	300x250
ZMA_Fullscreen	Toàn màn hình
ZMA_Reward	Toàn màn hình
ZMA_Bottom	Tùy chỉnh

Mặc định quảng cáo sẽ được hiển thị sau khi tải xong. Quảng cáo sẽ được hiển thị tại vị trí của phần tử mang ID tương ứng. Ví dụ:

<div id="ZMA_Masthead"></div>

Ví dụ

Tải quảng cáo ZMA_Middle:

import React, { useEffect } from "react";
import { loadAd } from "zmp-sdk/apis";

function HomePage() {
  useEffect(() => {
    loadAd({ ids: ["ZMA_Middle"] });
  }, []);

  return (
    <>
      ...
      <div id="ZMA_Middle"></div>
    </>
  );
}

export default HomePage;

Xem hướng dẫn xử lý lỗi và bảng mô tả chi tiết mã lỗi tại đây.

Tham số

Truyền tham số vào API dưới dạng object chứa các thuộc tính:

Name	Type	Default	Description
ids	string | string[]		ID của loại quảng cáo cần tải trong trang.
config	AdConfig		Cấu hình thêm.

AdConfig

Name	Type	Default	Description
attrs	Object		Cấu hình thêm cho quảng cáo, liên hệ Adtima để cài đặt phù hợp cho vị trí quảng cáo.
display	boolean	true	Nhận các giá trị sau:<ul><li> true: Hiển thị quảng cáo sau khi tải</li><li>false: Không hiển thị quảng cáo sau khi tải</li></ul>
plugins	string[]		Danh sách plugins hỗ trợ dể tối ưu hiển thị QC: <ul><li> swiper: tối ưu QC khi hiển thị trong slider sử dụng thư viện swiper </li></ul>
rewardConfig	RewardConfig		Cấu hình hiển thị cho Ads Reward
singleRequest	boolean	false	Các vị trí quảng cáo được bật true sẽ được gộp chung 1 yêu cầu quảng cáo để chống trùng
size	[number, number]		Kích thước quảng cáo [width, height]
type	string		Định dạng quảng cáo đặc biệt, bao gồm các định dạng: 'masthead', 'reward', 'fullscreen'
zoneId	string		ID của quảng cáo do Adtima cung cấp
onClose	function		Sau khi ZMA_Reward đóng sẽ gọi hàm này và trả về reward token của quảng cáo. Xem thêm Hướng dẫn verify reward token
onLoad	function		Trả về trạng thái có quảng cáo hay không: true/false
onShow	function		Trả về trạng thái có quảng cáo hiển thị thành công hay không: true/false

RewardConfig

Name	Type	Default	Description
displayType	string	"popup"	Kiểu hiển thị. Có 2 giá trị: "inline" hoặc "popup"
screenMode	string	"portrait"	Hiển thị kiểu ngang hay dọc, chỉ hoạt động khi displayType: "popup". Có 2 giá trị "portrait" hoặc "landscape"

Verify reward token

API được dùng để verify token được trả về trong hàm onClose khi mở quảng cáo loại ZMA_Reward

Request

• URL: https://h5.zalo.me/openapi/ads/verify-token

• Method: GET

• Parameters

  Name	Type	Required	Description
  token	string	yes	Reward token
  appId	string	yes	Mini App ID

Response

• Status: 200 OK

• Body: JSON

  {
    "msg": "Success",
    "err": 0,
    "data": {
      "result": true
    }
  }

  • Field "data":

    Name	Type	Description
    result	boolean	Kết quả kiểm tra