API đối tác

Lưu vào bộ nhớ đệm quảng cáo

Các quảng cáo trả về từ những điểm cuối tạo quảng cáo sẽ không thể lưu vào bộ nhớ đệm trừ khi thực sự cần thiết, bất kể chúng thuộc loại quảng cáo nào. Mỗi khi có trang được tải lên trang web của nhà bán lẻ, một yêu cầu tạo quảng cáo mới phải được gửi đến CitrusAd với ngữ cảnh chính xác để tạo bộ quảng cáo mới.

Trong trường hợp nhà bán lẻ không thể hỗ trợ điều này, CitrusAd cung cấp khả năng lưu vào bộ nhớ đệm theo đó nhà bán lẻ có thể cấp phát quảng cáo cho nhiều khách hàng theo nhiều lần lặp lại.

🚧

Bất kỳ lần hiển thị và nhấp chuột nào đáp ứng các tiêu chí của CitrusAd cho một lần nhấp chuột hợp lệ sẽ đều được tính phí tương ứng. Vì vậy, CitruSad khuyên bạn nên giảm thiểu khung thời gian bộ nhớ đệm xuống còn vài phút hợp lý để giảm khả năng chi quá mức.

Yêu cầu về tích hợp

sessionId không còn bắt buộc trong yêu cầu quảng cáo, vì quảng cáo có thể được phân phát cho nhiều phiên.

Bất kỳ nhà bán lẻ nào muốn lưu quảng cáo vào bộ nhớ tạm đều phải:

  • Gửi thông số mới trong yêu cầu quảng cáo đến CitrusAd của “cached”: true trong mục các tùy chọn.
POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customerId": "wertg5432a",
    "placement": "search",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "searchTerm": "chocolate",
    "options": {
                         "filterMode": "AndOr",
                         "cached": true
                             },
    "maxNumberOfAds": 3    
}
  • Được tích hợp với phương pháp phân bổ sessionId khi báo cáo đơn hàng.
  • Gửi sessionId được mã hóa trong báo cáo số lần hiển thị và nhấp chuột.
  • Gửi dấu thời gian sự kiện trong các báo cáo số lần hiển thị và nhấp chuột. Múi giờ giữa các sự kiện phải nhất quán, nhưng sử dụng múi giờ nào tùy thuộc vào nhà bán lẻ. Được định dạng theo định dạng ISO-8601.
https://integration.<ENV>.citrusad.com/v1/resource/second-c/<AD_ID>?sessionId=<SESSION_ID>&event_ts=20220127152500

Sau khi hoạt động, quá trình xử lý liên quan từ phía CitrusAd sẽ diễn ra. Không có cấu hình bổ sung nào được yêu cầu bởi CitrusAd.

Cách lưu bộ nhớ đệm

Đối với quảng cáo được lưu trong bộ nhớ đệm, có một thuộc tính có thể cấu hình được gọi là "cửa sổ". Cửa sổ này áp dụng cho tất cả các loại quảng cáo. Ngoài ra, có thuộc tính "hết hạn" đã được thông qua trong phản hồi của CitrusAd
Chúng tôi sử dụng các thuộc tính này để xác định cách thức chúng tôi xử lý số lần hiển thị và số nhấp chuột. Trong một số trường hợp nhất định, CitrusAd tạo AdId mới và xử lý một lần hiển thị / lần nhấp cho phù hợp.
Đây là cách CitrusAd đảm bảo chức năng phân bổ hoạt động đầy đủ trong nhiều phiên của khách hàng.

Tình huống 1

Đối với quảng cáo bất kỳ dành cho cùng một sessionId trong “cửa sổ”, chúng sẽ được coi là cùng một adId.

2640

Tình huống 2

Đối với bất kỳ quảng cáo nào có các sessionId khác nhau, chúng tôi sẽ tạo một AdId mới và xử lý nó dưới dạng một lần hiển thị/nhấp mới

2606

Tình huống 3

Bất kỳ lần hiển thị/nhấp chuột nào ngoài thời hạn quảng cáo sẽ được ghi lại nhưng không bị tính phí hoặc báo cáo.

2612

Tình huống 4

Bất kỳ lần nhấp chuột nào xảy ra trong một cửa sổ mà không có lần hiển thị nào được báo cáo, CitruSad suy ra đó là một lần nhấp chuột, đó là hành vi rộng trên hệ thống hiện tại.

Điều này có thể được giảm bằng cách gia tăng cửa sổ và nhà bán lẻ giảm bộ nhớ đệm của họ.

2650

Mỗi tình huống có thể xảy ra độc lập trong quá trình sản xuất nếu quảng cáo được cấp phát cho nhiều khách hàng.

2670

🚧

Rủi ro bội chi

Tính năng này cho phép nhà bán lẻ cấp phát quảng cáo cho nhiều khách hàng, nhiều lần mà không cần yêu cầu quảng cáo từ CitruSad.

Tính năng này chưa thực hiện bất kỳ thay đổi nào đối với cách thay đổi chiến dịch/ví. Quảng cáo được lưu trong bộ nhớ đệm càng lâu, thì cơ hội cấp phát quảng cáo cho một chiến dịch hoặc ví hiện đã hết tiền là càng lớn.

CitruSad vẫn sẽ xử lý và tính phí một lần hiển thị/nhấp chuột cho chiến dịch/ví hết tiền đối với quảng cáo đã được cấp phát khi ví có tiền trở lại.

Có ba cách để giảm thiểu bội chi trong các tình huống này.

  • Giảm lưu vào bộ nhớ đệm theo khung thời gian tối thiểu có thể (ưu tiên)
    Quảng cáo có thể được cấp phát càng lâu, thì rủi ro cấp phát quảng cáo từ chiến dịch/ví đã hết tiền càng lớn.

  • CitrusAd giảm "thời hạn" của tất cả các quảng cáo
    CitrusAd có thể giảm khung thời gian theo đó quảng cáo được coi là "hợp lệ" sau khi cấp phát. Bất kỳ lần hiển thị/nhấp chuột nào sau khi hết hạn đều bị vô hiệu.

  • CitrusAd mở rộng "cửa sổ" của tất cả các quảng cáo
    Cửa sổ lớn hơn sẽ làm giảm khối lượng hiển thị/nhấp chuột mới. Tuy nhiên, điều này làm giảm số lần hiển thị/nhấp chuột được báo cáo