Dưới đây là các thuộc tính có thể có trong một yêu cầu tiêu chuẩn và phản hồi nếu bạn nhận được quảng cáo.
Mục được yêu cầu
| Chuỗi | Mô tả | Bắt buộc/không bắt buộc |
|---|---|---|
catalogId | Mã nhận dạng danh mục cho trang web của bạn. | Bắt buộc |
customerId | Mã nhận dạng duy nhất cho khách hàng được phân phát quảng cáo. | Tùy chọn |
filterMode | Cách xác định cấu trúc yêu cầu của bạn (không bắt buộc). Xem phần Lọc tạo quảng cáo để biết thêm thông tin. | Không bắt buộc, ưu tiên |
maxNumberOfAds | Số lượng quảng cáo bạn muốn trả lại tối đa là 10. | Bắt buộc |
options | Cách xác định cấu trúc yêu cầu của bạn (không bắt buộc). Xem phần Lọc tạo quảng cáo để biết thêm thông tin. | Không bắt buộc, ưu tiên |
placement | Vị trí duy nhất mà bạn đang yêu cầu quảng cáo. | Bắt buộc |
productFilters | Bất kỳ bộ lọc sản phẩm nào có liên quan đến yêu cầu của bạn. Như danh mục, vị trí hoặc kích cỡ. | Bắt buộc |
sessionId | Mã nhận dạng duy nhất cho phiên của khách hàng. Dùng để phân bổ trong các tùy chọn tích hợp tiêu chuẩn. Đọc kỳ phần Các tùy chọn quy trình tích hợp để biết thêm thông tin. | Bắt buộc trong quy trình tích hợp tiêu chuẩn |
memoryToken | Dùng để phân trang. Sử dụng mã token được cung cấp trong yêu cầu quảng cáo trước đó để đảm bảo CitrusAd chỉ cấp phát các quảng cáo mới cho khách hàng của bạn. Nếu có mã này, CitrusAd sẽ loại trừ các quảng cáo đã được cấp phát trước đó trong phần phản hồi quảng cáo. Xem lại Phân trang để tìm hiểu thêm. | Tùy chọn |
dtmCookieId | Cookie được tạo và lưu trữ bởi trang web, được sử dụng để theo dõi hành vi của người dùng trên cùng một tên miền. | Tùy chọn |
Mặt hàng bị trả lại
| Chuỗi | Mô tả | Ví dụ về giá trị |
|---|---|---|
customPayload | Tải trọng tùy chỉnh này sẽ được chuyển từ tệp danh mục sang quá trình tạo quảng cáo. Trường này phải chứa một đối tượng JSON hợp lệ được xếp tuần tự thành một mảng byte và được mã hóa Base64. Đối tượng JSON phải tuân theo một lược đồ. | Tùy chỉnh mỗi lần tích hợp |
sellerId | Id không trùng lặp của người bán. Sẽ chỉ được tạo nếu sellerID được cài đặt trong nhóm. sellerID thường được sử dụng khi hỗ trợ người bán trên thị trường trong những bước đầu tiên. | 73nns-32sxr-32ss Tùy chỉnh mỗi lần tích hợp |
id | ID duy nhất của quảng cáo. Đây là mã duy nhất cho mỗi yêu cầu được gửi đến CitrusAd và sẽ không lưu được vào bộ nhớ đệm. | display_yCaCIy_kKaJnRnzrenBkVSytwr8yNTgxMzM4 |
gtin | Mã sản phẩm của quảng cáo. Đây sẽ là mã sản phẩm được đồng bộ hóa trong danh mục sản phẩm của bạn. | 25813383 |
discount | Phiên bản cũ, có thể bỏ qua. | { "amount": 0, "minPrice": 0, "maxPerCustomer": 0 } |
position | Vị trí của quảng cáo trong phản hồi CitrusAd. Bạn nên chú ý đến vị trí này nếu sử dụng chiến dịch thuê cố định. | 1 |
memoryToken | Dùng để phân trang và xâu chuỗi các yêu cầu quảng cáo. Nếu yêu cầu quảng cáo tiếp theo của bạn trong cùng bối cảnh sử dụng mã này thì CitrusAd sẽ loại trừ các quảng cáo đã cấp phát trước đó trong phần phản hồi quảng cáo. Xem lại Phân trang để tìm hiểu thêm. |