Các bài viết trong mục này

Tích hợp web SDK

Avatar
ADBRIX
  • Đã cập nhật
Theo dõi

 

Sử dụng đồng thời app SDK và web SDK của adbrix giúp marketer có để dễ dàng thống nhất thông tin về người dùng cả trên app và web để có được bức tranh tổng thể về người dùng hoặc phân tích chi tiết các chỉ số trên từng platform iOS, Android và web.

[[인용:정보:작게]] Web analytics là một premium add-on của adbrix. Vui lòng liên hệ với account manager của bạn để đăng kí sử dụng tính năng này hoặc đặt câu hỏi tại link.

Sau đây là hướng dẫn các bước để tiến hành tích hợp web SDK.

 

1. Khai báo cơ bản

Trước tiên, marketer cần tiến hành khai báo thông tin về web trong menu Setting & SDK -> Applications trên console của adbrix. Sau khi khai báo xong, giá trị Web secret key sẽ được tạo ra để sử dụng trong quá trình tiến hành tích hợp SDK.

3d619e85-4664-423f-900e-64b96dce2dd4.png

 

 

2. Tích hợp SDK

Sau đây là hướng dẫn các bước tiến hành cài đặt SDK vào Web project cơ bản.

 

a) Các browser hỗ trợ

Web SDK của adbrix có thể được sử dụng trên mọi browser hỗ trợ Javascript ES5 

IE

Chrome

Firefox

Safari

IE 9 trở lên

OK

OK

OK

 

b) Cài đặt SDK

Thêm vào đoạn script sau đây vào web để cài đặt SDK

Để đảm bảo không gây ảnh hướng tới các resource khác, chúng tôi khuyến nghị nên cài đặt vào ngay trên tag </body> phía dưới cùng của trang.

<body>
   .
   .
   <script>!function(e,r){if(void 0!==e&&!e.adbrix){var t={queue:[]},n=navigator.userAgent.toLowerCase(),o=r.createElement("script"),i="Netscape"===navigator.appName&&-1!==navigator.userAgent.search("Trident")||-1!==n.indexOf("msie")?"abx-web-sdk.ie.min.js":"abx-web-sdk.min.js";o.type="text/javascript",o.async=!0,o.src="https://static.adbrix.io/web-sdk/latest/"+i,o.onload=function(){e.adbrix.runQueuedFunctions?e.adbrix.runQueuedFunctions():console.log("[adbrix] Error: could not load SDK")};var a=r.getElementsByTagName("script")[0];a.parentNode.insertBefore(o,a);["init","onInitialized","login","getUserId","logout","userProperty.get","userProperty.getAll","userProperty.addOrUpdate","userProperty.remove","userProperty.removes","common.signUp","common.invite","common.useCredit","event.send","debug.traceListener"].forEach(function(e){var r=e.split("."),n=r.pop();r.reduce(function(e,r){return e[r]=e[r]||{}},t)[n]=function(){t.queue.push([e,arguments])}}),e.adbrix=t}}(window,document);</script>
</body>

[[인용:안내:보통]] Series mới nhất - 16/2/2021
Khi update SDK version mới thì method trong script có thể phải thay đổi hoặc bổ sung thêm. Bạn nên thường xuyên kiểm tra để đảm bảo luôn sử dụng version mới nhất.

 

c) Khởi tạo Web SDK

Khởi tạo web SDK ngay bên dưới <head> của trang đầu tiên.

<head>
  <script>
  .
  .
    window.adbrix.init({
        appkey: 'your_appkey',
        webSecretkey: 'your_webSecretKey',
    });
  </script>
  .
  .
</head>

Giá trị các hạng mục cài đặt hỗ trợ được liệt kê trong bản dưới đây:

Attributes

Type

Required

Default value

Description

appkey

string

O

X

App key

webSecretkey

string

O

X

Web secret key

userHash

string

X

X

userID đã được mã hóa

isOptOut

boolean

X

false

Tùy chọn người dùng cho đồng ý tracking

isExecPageViewEvent

boolean

X

true

Khi người dùng mở một trang nào đó, thì lập tức page_view event sẽ được ghi nhận.

isIncludeReferrer

boolean

X

true

Track referrer

isIncludeUtm

boolean

X

true

Track utm

isincludeGclid

boolean

X

true

Track gclid

isIncludeNaver

boolean

X

true

Track naver ads

supportUrlQueryKeys

string[]

X

[]

Giá trị key sẽ được tự động thu thập từ queryString của địa chỉ URL

traceLevel

number

X

1

0 : Disable

1 : Error

2 : Warning

3 : Information

 

 

d) Kiểm tra kết quả cài đặt SDK

Để kiểm tra xem SDK đã được gọi một cách chính xác hay chưa, bạn có thể kiểm tra bằng cách nhập window.adbrix trên browser console và nhận về kết quả như dưới đây.

4ccabdfd-1d5f-4931-b637-21a7152a7fcc.png

Ngoài ra, trên console.adbrix.io, vào menu Analytics > LiveBrix >  bạn có thể kiểm tra được các event track được trong thời gian thực.

c55bccab-98da-46f8-bbb1-9de9a445f542.png

 

[[인용:경고:보통]] Kết quả trong Livebrix có thể chậm hơn thực tế 15 phút nên sau khi test, bạn vui lòng chờ để nhận kết quả hiển thị trên báo cáo.

 

e) User API

Là API để phân tích các hành vi của người dùng như log-in, log-out và các thông tin khác về người dùng.

[[인용:위험:작게]] Các API được đề cập từ phần này được áp dụng sau khi được init bởi adbrix SDK

Login / Logout

Sử dụng hàm adbrix.login để SDK ghi nhận sự kiện login. Tham số trong trong hàm là UserID

adbrix.login('user_id');

Để có thể truy vấn được UserID của người dùng đã login thì cần gọi getUserID method như sau:

adbrix.onInitialized(() => {
  adbrix.getUserId();
});

Sử dụng hàm adbrix.logout để SDK ghi nhận sự kiện logout. Khi hàm logout được gọi, UserProperty và UserID được lưu trên browser cache sẽ được xóa.

adbrix.logout();

UserProperty

Các hàm trong adbrix.userProperty dùng để phân tích thông tin người dùng (số point, số lần mua hàng, giới tính, tuổi ...)

Sử dụng adbrix.userProperty.addOrUpdate để thêm hoặc update thông tin người dùng.

adbrix.userProperty.addOrUpdate('email', 'abx@igaworks.com');

UserProperty tuân theo các tiêu chuẩn như sau:

Key

  • Chỉ có thể sử dụng String
  • Hạn chế dưới 256 kí tự.
  • Chỉ chứa kí tự tiếng Anh (viết thường), chữ số, và kí tự đặc biệt (underbar) "_"

Value

  • Có thể là String, Number hoặc Boolean type
  • Hạn chế dưới 1024 byte

Để tra cứu UserProperty, có thể sử dụng method adbrix.userProperty.getAll hoặc adbrix.userProperty.get

adbrix.onInitialized(() => {
  adbrix.userProperty.getAll();         // Get All UserProperty
  adbrix.userProperty.get('email');     // Get Certian UserProperty
});

Để xoá UserProperty chỉ cần gọi adbrix.userProperty.remove

adbrix.onInitialized(() => {
  adbrix.userProperty.remove('email');              // Remove Single UserProperty
  adbrix.userProperty.removes(['email','age']);     // Remove more then two UserProperties
});

[[인용:위험:작게]] UserProperty sẽ được reset khi event adbrix.logout  được gọi.

 

f) Common API

Là API để ghi nhận về các event thông dụng được sử dụng trên web

sign-up

Sử dụng adbrix.common.signUp để gọi event sign-up.

adbrix.common.signUp('signChannel');

SignChannel gồm: (các giá trị được định nghĩa trước được liệt kê dưới đây)

  • Kakao
  • Naver
  • Line
  • Google
  • Facebook
  • Twitter
  • whatsApp
  • QQ
  • WeChat
  • UserId
  • ETC
  • SkTid
  • AppleId

 User invite (mời người dùng khác)

Dùng adbrix.common.invite để ghi nhận sự kiện mời người dùng khác sử dụng dịch vụ

adbrix.common.invite('inviteChannel', 'userId');

InviteChannel gồm: (các giá trị được định nghĩa trước được liệt kê dưới đây)

  • Kakao
  • Naver
  • Line
  • Google
  • Facebook
  • Twitter
  • whatsApp
  • QQ
  • WeChat
  • UserId
  • ETC
  • SkTid
  • AppleId

 

Use credit

Sử dụng adbrix.common.useCredit để ghi nhận sự kiện use credit

adbrix.common.useCredit(10000);

 

g) Custom Event

Sử dụng khi gọi các custom event (ngoài các pre-defined event do adbrix định nghĩa sẵn)

Sử dụng key / value để ghi nhận các thông tin khác ngoài tên event.

adbrix.event.send('your_event_name', {'key': 'value'})

 

Key / value của custom event phải tuân theo các tiêu chuẩn sau:

 

Key

  • Chỉ chấp nhận String
  • Hạn chế dưới 256 kí tự
  • Chấp nhận chữ cái tiếng Anh viết thường, chữ số và dấu "_" (underbar)

Value

  • Có thể là String, Number hoặc Boolean type
  • Hạn chế dưới 1024 byte

 

h) Q&A

Các thắc mắc hoặc đề nghị hỗ trợ liên quan tới tích hợp sdk cho tính năng web analytics xin gửi về email adbrix-web-sdk-support@adbrixsupport.zendesk.com

 

 

Bài viết liên quan

Bình luận

0 bình luận

Bài viết bị đóng bình luận.

INDEX