Chuyển tới nội dung chính

loadAd

import { loadAd } from "zmp-sdk";

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

IDSize
ZMA_Masthead480x270
ZMA_Middle300x250
ZMA_FullscreenToàn màn hình
ZMA_RewardToàn màn hình
ZMA_BottomTù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">

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">
</>
);
}

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:

PropertyTypeRequiredDescription
idsstring | string[]YesID của loại quảng cáo cần tải trong trang.
configAdConfigNoCấu hình thêm.

AdConfig

PropertyTypeRequiredDescription
zoneIdstringYesID của quảng cáo do Adtima cung cấp
typestringNoĐịnh dạng quảng cáo đặc biệt, bao gồm các định dạng: 'masthead', 'reward', 'fullscreen'
size[number, number]YesKích thước quảng cáo [width, height]
attrsObjectNoCấ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.
singleRequestbooleanNoCá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 (default: false)
pluginsstring[]NoDanh sách plugins hỗ trợ dể tối ưu hiển thị QC:
  • swiper: tối ưu QC khi hiển thị trong slider sử dụng thư viện swiper
displaybooleanNoNhận các giá trị sau:
  • true: Hiển thị quảng cáo sau khi tải
  • false: Không hiển thị quảng cáo sau khi tải
(default: true)
onLoadfunctionNoTrả về trạng thái có quảng cáo hay không: true/false
onShowfunctionNoTrả về trạng thái có quảng cáo hiển thị thành công hay không: true/false
onClosefunctionNoSau 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
rewardConfigRewardConfigNoCấu hình hiển thị cho Ads Reward

RewardConfig

PropertyTypeRequiredDescription
displayTypestringNoKiểu hiển thị. Có 2 giá trị: "inline" hoặc "popup" (default: "popup")
screenModestringNoHiển thị kiểu ngang hay dọc, chỉ hoạt động khi displayType: "popup". Có 2 giá trị "portrait" hoặc "landscape" (default: "portrait")

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

    NameTypeRequiredDescription
    tokenstringyesReward token
    appIdstringyesMini App ID

Response

  • Status: 200 OK

  • Body: JSON

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

      NameTypeDescription
      resultbooleanKết quả kiểm tra