Danh sách tham chiếu cho biểu ngữ x

Phần dưới đây mô tả các thuộc tính có thể có trong một yêu cầu tiêu chuẩn như đã nêu trong mục Yêu cầu quảng cáo để bản gửi yêu cầu, và phản hồi nếu bạn nhận được quảng cáo.

Mục được yêu cầu

ChuỗiMô tảBắt buộc/không bắt buộc
BannerSlotIdsMột mảng json của slotId biểu ngữ được yêu cầu.Bắt buộc
catalogIdMã nhận dạng danh mục cho trang web của bạn.Bắt buộc
contentStandardIdMã nhận dạng tiêu chuẩn nội dung cho trang web của bạn.Bắt buộc
customerIdMã 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
filterModeCá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
maxNumberOfAdsSố lượng tối đa của mỗi vùng biểu ngữ mà bạn muốn trả lại.Bắt buộc
optionsCá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
placementVị trí duy nhất mà bạn đang yêu cầu quảng cáo.Bắt buộc
productFiltersBất kỳ bộ lọc sản phẩm nào có liên quan đến yêu cầu của bạn. Chẳng hạn như bộ lọc danh mục, vị trí hoặc kích thước.Bắt buộc đối với vị trí danh mục
searchTermCụm từ tìm kiếm mà khách hàng nhập vào trang web của bạn.Bắt buộc đối với vị trí tìm kiếm
sessionIdMã 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
slotIdNó chứa SlotId được yêu cầu trong ngữ cảnh. Có thể có một hoặc nhiều.Bắt buộc

Mặt hàng bị trả lại

ChuỗiMô tảVí dụ về giá trị
backgroundColourMàu nền của biểu ngữ - chỉ hỗ trợ giá trị HEX.6e6c6c
backgroundImageLiên kết hình ảnh của hình nền biểu ngữ.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
backgroundImagePositionChức năng này xác định loại vị trí của hình nền. Nếu không có giá trị, bạn sẽ cần đặt mặc định thành leftaligned .leftaligned
rightaligned
fill
repeating
bannerTextVăn bản hiển thị trong biểu ngữ. Có thể bao gồm các thẻ HTML<strong>Double Fudge Ice Cream</strong>
bannerTextColourMàu văn bản biểu ngữ - chỉ các giá trị HEX. Citrus không gửi #.1dc711
citrusAdIdID 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.
shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3
citrusCampaignNameTên chiến dịch của quảng cáo.CitrusAd-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6
citrusContentStandardIdId tiêu chuẩn nội dung liên quan đến vùng biểu ngữ.8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
citrusExpiryThời hạn của quảng cáo. Đây là thời điểm gần nhất mà một lượt nhấp được báo cáo cho CitrusAd2021-06-01T23:48:16.573967987Z
citrusSlotIdId của vị trí cụ thể cho biểu ngữ bạn đã yêu cầu.Category_Top
contentStandardIdId tiêu chuẩn nội dung liên quan đến vùng biểu ngữ. Bản sao của citrusContentStandardId8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c
ctaFlagMã này xác định xem CTA có được hiển thị hay không.true
false
ctaLinkUrl được chuyển tiếp từ CTA (giống như linkUrl cho biểu ngữ). Chỉ được cấp phát nếu ctaFlag là true<https://www.retailer.com/groceries/en-GB/search?query=double-fudge>
ctaTextVăn bản trong CTA.Shop now
ctaTextAccessibilityVăn bản trợ năng của CTA dành cho người dùng sử dụng trình đọc màn hình.for Double Fudge Ice Cream
gtinsMột mảng gồm tối đa 20 mã sản phẩm được chọn từ các sản phẩm được quảng cáo trong chiến dịch.

Các nhà bán lẻ có thể sử dụng danh sách này để tự động hóa các trang danh sách khi biểu ngữ được nhấp vào hoặc tự động hóa một số chức năng hiển thị nhất định (roundels, giá cả, kiểm tra mức tồn kho thứ cấp).
[ "7714107", "7163379", "7733636", "7733657", "7733628" ],
headingTextTiêu đề văn bản dành cho người dùng sử dụng trình đọc màn hình.Banner Advertisement for Fudge Double Ice Cream with a product image and shop now button
heroImageAltTextVăn bản thay thế cho hình ảnh trung tâm nếu hình ảnh này không hiển thị (hiếm khi xảy ra).Image of double fudge iced cream
heroImageLiên kết hình ảnh của hình ảnh trung tâm của biểu ngữ.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
positionVị trí của biểu ngữ 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
secondaryBackgroundImageLiên kết hình ảnh của hình nền phụ.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
secondaryBackgroundImagePositionNó xác định loại vị trí của hình nền phụ.leftaligned
rightaligned
secondaryHeroImageAltTextVăn bản thay thế cho hình ảnh trung tâm phụ nếu hình ảnh này không hiển thị (hiếm khi xảy ra).Image of [brand] logo
secondaryHeroImageLiên kết hình ảnh của hình ảnh trung tâm phụ.[<https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3>](https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`)
secondaryHeroModeChức năng này xác định chế độ hiển thị của hình ảnh trung tâm phụ. Nếu không có giá trị, bạn sẽ cần đặt mặc định thành block .block
landscape
slotIdID vùng của biểu ngữ mà bạn yêu cầu. Khi yêu cầu nhiều biểu ngữ, loại dữ liệu này có thể được dùng để tham chiếu các ID được yêu cầu.Category_Top
tagsTrường này trả về thẻ bên thứ ba bất kỳ được nhà quảng cáo nhập vào trong chiến dịch. Đây hiện không phải là thứ được biểu ngữ x hỗ trợ, mặc dù phản hồi API đã được định dạng.{}
sellerIdId 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

📘

Nếu có một trường không được cấu hình theo chiến dịch quảng cáo thì trường đó sẽ không được cấp phát. Tức là nếu nhà quảng cáo chưa cấu hình heroImagethì CitrusAd sẽ không cấp phát thuộc tính heroImage .