API OneLink

Cao cấp

Khái quát: OneLink API giúp bạn thu hút người dùng cuối và tận dụng truyền thông sở hữu bằng cách tạo các liên kết được cá nhân hóa trong các chiến dịch quy mô lớn, qua SMS, v.v. Yêu cầu cả nhà quảng cáo và nhà phát triển triển khai.

API OneLink

API OneLink được sử dụng để:

  • Tự động tạolấycập nhật và xóa URL rút gọn của OneLink bằng các thông số tùy chỉnh.
    Các thông số có thể là:
    • Các thông số liên quan đến phân bổ, được sử dụng để đo lường và theo dõi các nỗ lực tiếp thị, như nguồn truyền thông, chiến dịch và bộ quảng cáo. Lưu ý: Thông số nguồn truyền thông (pid) là bắt buộc. 
    • Các thông số được cá nhân hóa cho phép bạn cấu hình trải nghiệm người dùng tùy chỉnh khi mở ứng dụng từ liên kết có liên quan. Những thông số này cho phép bạn đưa người dùng đến nội dung trong ứng dụng được tùy chỉnh, ví dụ như một trang sản phẩm cụ thể, mã phiếu giảm giá hoặc khuyến mại.
  • Cho phép chia sẻ nội dung trang web và ứng dụng trực tiếp đến người dùng thiết bị di động (do đó tăng mức độ thu hút và cài đặt trên thiết bị di động).
  • Tạo tức thời một số lượng lớn các đường dẫn phân bổ tùy chỉnh OneLink.
    Lưu ý: Đối với các liên kết giới thiệu, hãy xem bài viết Phân bổ lời mời người dùng.

 Ví dụ

Feed Me, một dịch vụ giao hàng tạp hóa, muốn gửi một liên kết được cá nhân hóa qua SMS tới những khách hàng hiện tại để khuyến khích họ tải xuống ứng dụng Feed Me và mua chuối. Dựa trên quốc gia của khách hàng, Feed Me sử dụng API REST OneLink để tạo URL OneLink tùy chỉnh có chứa các chi tiết cụ thể đối với quốc gia, danh tính người dùng và ưu đãi đặc biệt cho các loại chuối đang được giảm giá.

Số lượng truy vấn API OneLink bạn có thể thực hiện bị giới hạn tùy thuộc vào loại tài khoản của bạn. Bạn có thể xem số lượng truy vấn bạn đã thực hiện và số lượng truy vấn còn lại trong bảng điều khiển API OneLink. 

Bạn có thể liên hệ với CSM của mình để tăng giới hạn truy vấn API.  

Thiết lập

Để thiết lập API OneLink:

  1. Tạo mẫu OneLink.
  2. Ghi nhận ID OneLink. 

  3. Ghi nhận mã khóa API OneLink. Người dùng quản trị cần truy xuất khóa API; người dùng tài khoản không có quyền truy cập. 
    • Trong bảng điều khiển AppsFlyer, đi tới Experiences & Deep Linking > OneLink API > View OneLink API key
    • Nếu mã khóa API OneLink không có trong đó cho người dùng quản trị, thì điều đó có nghĩa là bạn không có gói cần thiết và bạn cần liên hệ với CSM của mình.
  4. Cung cấp ID OneLink và mã khóa API OneLink cho nhà phát triển.
  5. Yêu cầu nhà phát triển làm theo hướng dẫn trong trung tâm nhà phát triển.

Bảng điều khiển

Bảng điều khiển API OneLink hiển thị:

  • Mức sử dụng API hàng ngày, hàng tháng và ba tháng của bạn. 
  • Mã khóa API OneLink.

Để xem bảng điều khiển API OneLink

Trong AppsFlyer, đi tới Experiences & Deep Linking > OneLink API.

Đặc điểm và hạn chế

Đặc điểm

Lưu ý

Giới hạn hạn mức API

  • Giới hạn sử dụng API OneLink để tạo, chỉnh sửa hoặc xóa đường liên kết OneLink là 7,5 triệu mỗi tháng (múi giờ UTC), mỗi tài khoản.
  • Tất cả các yêu cầu được thực hiện sau khi vượt quá hạn mức này sẽ không được phân phối và các đường liên kết không được tạo; lệnh gọi API nhận được mã trạng thái lỗi 429 với thông báo "Đã vượt quá hạn mức hàng tháng".
  • Thông tin về hạn mức tỷ lệ đã sử dụng/còn lại được hiển thị trong bảng điều khiển API OneLink. 

Giới hạn tốc độ

  • Giới hạn tốc độ API cho mỗi tài khoản là 500 yêu cầu mỗi giây (30000 mỗi phút).
  • Tất cả các yêu cầu được thực hiện vượt quá 500 yêu cầu mỗi giây (30000 yêu cầu mỗi phút) đều không được phân phối và đường liên kết sẽ không được tạo; lệnh gọi API nhận được mã trạng thái lỗi 429 với thông báo "Đã vượt quá giới hạn tốc độ".

Khả năng hiển thị liên kết

  • Các liên kết được tạo qua API không xuất hiện trong danh sách các liên kết tùy chỉnh OneLink trong bảng điều khiển của AppsFlyer.
  • Phương pháp hay nhất: Lưu các liên kết do API tạo vào một bảng cục bộ để bạn có thể truy cập các liên kết cho bất kỳ mục đích nào sau này. 

TTL 

  • Thời gian tồn tại mặc định (TTL) cho các URL rút gọn OneLink được tạo qua API OneLink là 31 ngày. Thời gian này được kéo dài thêm 31 ngày mỗi khi liên kết nhận được lượt nhấp. Việc nhấp vào liên kết như vậy khi TTL hết hạn vẫn được mặc định dẫn đến hoạt động được xác định trong cấu hình cơ sở OneLink, nhưng tính năng phân bổ sẽ không hoạt động.
    • Có thể mất tối đa 48 giờ để xóa một URL rút gọn OneLink sau khi TTL hết hạn.
  • TTL tối đa là 31 ngày. Bất kỳ giá trị TTL nào lớn hơn 31 đều bị ghi đè bằng TTL mặc định là 31.
  • Bạn có thể thay đổi TTL mặc định bằng cách thêm thông số ttl={value} và chỉ định số ngày, giờ hoặc phút. Ví dụ ttl=7d, ttl=12hhoặc ttl=10m.
  • Bạn có thể gửi yêu cầu cập nhật để chỉ định TTL. Mọi yêu cầu cập nhật đều đặt lại TTL (đối với các liên kết hiện có) thành một yêu cầu được chỉ định trong nội dung yêu cầu.
    • Điều này có nghĩa là TTL sẽ được thay thế. Ví dụ, nếu bạn gọi lệnh cập nhật với TTL 2 ngày cho một liên kết hiện có TTL 29 ngày, thì sẽ được thay đổi thành TTL=2d (không phải 31 ngày).
    • Lệnh gọi cập nhật có khả năng kéo dài thời gian tồn tại của đường dẫn phân bổ. Ví dụ, nếu bạn thực hiện lệnh gọi cập nhật với TTL 31 ngày cho một liên kết hiện có TTL 20 ngày nhưng đã qua 5 ngày, thì TTL sẽ là 31 ngày kể từ thời điểm cập nhật.
  • Nếu bạn không muốn các TTL của liên kết tự động kéo dài thời gian, hãy thêm thông số renew_ttl=false vào các đường liên kết của bạn. Giá trị cho thông số này là boolean, true (mặc định) hoặc false.
  • Thông số renew_ttl không hiển thị trên URL thực tế.

Ký tự đặc biệt

Các ký tự sau phải được mã hóa nếu được sử dụng cho các đường liên kết do API tạo: ;, *, !, @, #, ?, $, ^, :, &, ~, `, =, +, ', >, <, /
Nếu bạn không mã hóa các ký tự này, chúng sẽ được thay thế bằng khoảng trắng và đường liên kết cũng như chức năng của đường liên kết có thể bị lỗi.

Tải trọng

Chuỗi truy vấn từ tải trọng không được vượt quá 2.048 ký tự.

ID URL

Có thể chính sửa ID URL (hoặc ID liên kết rút gọn) để làm nổi bật dịch vụ cung cấp của chiến dịch. Ví dụ: https://myapp.onelink.me/abc123/apples. ID URL không được vượt quá 50 ký tự và có thể là sự kết hợp giữa các chữ cái và số. Theo mặc định, ID này gồm 8 ký tự.

Lưu ý:

  • Bạn chỉ có thể chỉnh sửa ID URL nếu ID hiện tại chưa được sử dụng.
  • Nếu ID URL đã được sử dụng, việc tạo đường liên kết sẽ không thành công và trả về phản hồi lỗi (400). Bạn và nhà phát triển của bạn cần quyết định và định cấu hình hoạt động sẽ xảy ra trong một sự kiện như vậy.
  • Lệnh gọi không thành công vẫn được tính vào hạn mức API hàng tháng của bạn.