Phần dưới đây nêu rõ các thuộc tính có thể có trong một yêu cầu tiêu chuẩn như được nêu trong Yêu cầu quảng cáo. Bạn phải thực hiện ba lệnh API. Một cho quảng cáo sản phẩm, một cho quảng cáo biểu ngữ x của bạn và cuối cùng là cho nội dung tĩnh.

Mục được yêu cầu trên quảng cáo sản phẩm

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.	Không bắt buộc.
`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à 15.	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. Chẳng hạn như một vị trí. Ngoài ra, phải bao gồm bộ lọc trang thương hiệu của bạn gồm `brandpage:<VALUE>` Giá trị này là hậu tố URL duy nhất của trang thương hiệu. Nếu có một trang thương hiệu được cấu hình cho hậu tố này, CitrusAd sẽ gửi nội dung trong phần tải trọng.	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

Mục được trả lại trên quảng cáo sản phẩm

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
`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

Mục được yêu cầu trên biểu ngữ x

Chuỗi	Mô tả	Bắt buộc/không bắt buộc
`bannerSlotIds`	Một mảng json của slotId biểu ngữ được yêu cầu.	Bắt buộc
`catalogId`	Mã nhận dạng danh mục cho trang web của bạn.	Bắt buộc
`contentStandardId`	Mã nhận dạng tiêu chuẩn nội dung 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.	Không bắt buộc.
`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 tối đa của mỗi vùng biểu ngữ mà bạn muốn trả lại.	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. Chẳng hạn như một vị trí. Ngoài ra, phải bao gồm bộ lọc trang thương hiệu của bạn gồm `brandpage:<VALUE>` Giá trị này là hậu tố URL duy nhất của trang thương hiệu. Nếu có một trang thương hiệu được cấu hình cho hậu tố này, CitrusAd sẽ gửi nội dung trong phần tải trọng.	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
`slotId`	Nó 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ục được trả lại trên biểu ngữ x

Chuỗi	Mô tả	Ví dụ về giá trị
`backgroundColour`	Màu nền của biểu ngữ - chỉ hỗ trợ giá trị HEX.	`6e6c6c`
`backgroundImage`	Liê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`
`backgroundImagePosition`	Chứ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`
`bannerText`	Vă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>`
`bannerTextColour`	Màu văn bản biểu ngữ - chỉ các giá trị HEX. Citrus không gửi `#`.	`1dc711`
`citrusAdId`	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.	`shotgun_wIpZraEXcIu0daC5YMQewPil2S83NzE0MTA3`
`citrusCampaignName`	Tên chiến dịch của quảng cáo.	`CitrusAd-Example-Category-Banner-X-Ad-ae536b0d5c3ded28ea624ab4285facd6`
`citrusContentStandardId`	Id tiêu chuẩn nội dung liên quan đến vùng biểu ngữ.	`8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c`
`citrusExpiry`	Thờ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 CitrusAd	`2021-06-01T23:48:16.573967987Z`
`citrusSlotId`	Id của vị trí cụ thể cho biểu ngữ bạn đã yêu cầu.	`Category_Top`
`contentStandardId`	Id tiêu chuẩn nội dung liên quan đến vùng biểu ngữ. Bản sao của `citrusContentStandardId`	`8jsuwnfwe-1435-460b-9d2b-5d838e3dba9c`
`ctaFlag`	Mã này xác định xem CTA có được hiển thị hay không.	`true` `false`
`ctaLink`	Url đượ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`
`ctaText`	Văn bản trong CTA.	`Shop now`
`ctaTextAccessibility	Vă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`
`gtins`	Mộ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).	`"gtins": [ "7714107", "7163379", "7733636", "7733657", "7733628" ],`
`headingText`	Tiê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`
`heroImageAltText`	Vă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`
`heroImage`	Liê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`
`position`	Vị 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
`secondaryBackgroundImage`	Liên kết hình ảnh của hình nền phụ.	`https://cdn.[server].io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3`
`secondaryBackgroundImagePosition`	Nó xác định loại vị trí của hình nền phụ.	`leftaligned` `rightaligned`
`secondaryHeroImageAltText`	Vă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`
`secondaryHeroImage`	Liê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`
`secondaryHeroMode`	Chứ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`
`slotId`	ID 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`
`tags`	Trườ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.	`{}`

Các mục được yêu cầu của trang thương hiệ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
`placement`	Vị trí duy nhất mà bạn đang yêu cầu quảng cáo.	Bắt buộc
`brandPageId`	ID duy nhất của trang thương hiệu. Giá trị này là hậu tố URL duy nhất của trang thương hiệu.	Bắt buộc.

Mục được trả lại trên quảng cáo sản phẩm

Chuỗi	Mô tả	Ví dụ về giá trị
`pageContentText`	Nội dung trang do nhà quảng cáo nhập. Nói chung là một hoặc hai đoạn tiếp thị nội dung của trang thương hiệu.	Milk Choc Chunk sẽ làm hài lòng các tín đồ yêu thích bánh quy, với những thanh bánh quy xốp giòn rụm bọc sô cô la trắng, bên trên là những mẩu bánh quy lẫn trong sô cô la sữa. Hiện được bày bán dưới dạng khối 170g và thanh 45g.
`pageHeaderText`	Tiêu đề của trang thương hiệu	Bánh quy sô cô la mới

📘
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 .