Điểm cuối trang thương hiệu
Nền tảng trang thương hiệu sử dụng URL độc lập và đường dẫn đến điểm cuối tạo quảng cáo. Người quản lý tài khoản kỹ thuật của bạn sẽ cung cấp URL cơ sở cho sandbox và môi trường sản xuất.
Uỷ quyền
Ủy quyền cho công cụ trang thương hiệu là xác thực bearer. Người quản lý tài khoản kỹ thuật của bạn sẽ có thể cung cấp bearer token cho sandbox và môi trường sản xuất.
Bạn sẽ cần gửi mã thông báo trong tiêu đề dưới dạng header 'Authorization: Bearer ${apiKey}
Yêu cầu
Để yêu cầu một trang thương hiệu, bạn sẽ gửi yêu cầu NHẬN tới điểm cuối của CitrusAd brand-pagevới URL bạn đang yêu cầu cho
curl --location --request GET '${URL}/api/v1/brand-page:static?url=${url}&retailer=${retailer}' \
--header 'Authorization: Bearer ${apiKey}
Xóa tham số truy vấn URL
Khi yêu cầu quảng cáo, bạn sẽ cần xóa mọi tham số truy vấn có liên quan đến trang web của mình khỏi các tham số được gửi đến CitrusAd.
Bên trong nền tảng CitrusAd, chúng tôi sử dụng URL này để tìm nạp URL trang chính xác được yêu cầu. Chúng tôi sẽ đối sánh
https\:www.retailer.com/brand/lollipops-brand, nhưng sẽ không đối sánh nếu tham số truy vấn bổ sung được chỉ định.
Phản hồi
Tùy thuộc vào cấu hình trang thương hiệu của bạn, phản hồi phân đoạn sẽ khác nhau do cả phân đoạn được tích hợp và mẫu của trang thương hiệu.
Nếu bạn muốn xem lại các khả năng tùy chỉnh, hãy xem lại trang Cấu trúc cấp cao.
Thành phần phản hồi
Vùng chứa
Vùng chứa phục vụ thông tin cho toàn bộ phản hồi trang thương hiệu, nó cũng có một mảng dữ liệu của các đối tượng, trong đó các phản hồi phân đoạn được lưu giữ.
{
"id": "string",
"brandPageId": "string",
"brandPageTemplateId": "string",
"data": [
]
}
Mã data mảng sẽ được điền bằng các phân đoạn, tùy thuộc vào cấu hình của trang thương hiệu, định dạng của các phân đoạn được trình bày chi tiết bên dưới.
Phân đoạn
Do khả năng tùy chỉnh trong sản phẩm trang thương hiệu, phản hồi chính xác bạn nhận được sẽ còn tùy vào cấu hình của bạn. Mỗi phân đoạn sẽ có một id và một name, ngoài các thuộc tính cụ thể của phân đoạn.
Phân đoạn biểu ngữ
Bên trong mảng data mảng, mỗi phân đoạn là một đối tượng, như bên dưới:
Các thuộc tính cụ thể của biểu ngữ x trong phản hồi chỉ là ví dụ. Các giá trị trong phản hồi được định cấu hình cho mỗi mẫu và có thể được tùy chỉnh, chẳng hạn như
backgroundImage,brandLogo, hoặc theo yêu cầu của bạn.
{
"id": "26f6117c-147b-4447-86aa-992e9ddb0daa",
"name": "primary-content",
"headingText": "Banner For MasterFoods Beef Stroganoff with Shop Now button",
"bannerText": "<strong>The Perfect Mid-Week Dinner</strong>",
"bannerTextColour": "#fff",
"heroImage": "https://storage.googleapis.com/assets-images/coke/2853856c8644",
"heroImageAltText": "<i>Picture of the Dolmio Pasta Sauce</i>",
"secondaryHeroImage": "https://assets.imageurl.io/s/85d2d333-eed5-44d7-b131-8m435c34r",
"secondaryHeroImageAltText": "Milo Logo",
"secondaryHeroMode": "landscape",
"backgroundColour": "895b5b",
"backgroundImage": "https://assets.flavedo.io/s/9c6fa248-c5ff-4341-9833-7e2b08464ada",
"backgroundImagePosition": "FILL",
"secondaryBackgroundImage": "https://assets.flavedo.io/s/9c6fa248-c5ff-4341-9833-7e2b08464ada"
}
Để biết thêm thông tin về những gì có thể thực hiện được với các phân đoạn biểu ngữ, hãy xem Cấu trúc cấp cao.
Phân đoạn nội dung
Bên trong mảng data mảng, mỗi phân đoạn là một đối tượng, như bên dưới:
heroText,heroTextColourvàheroSubTextlà những ví dụ cho nhà bán lẻ mẫu. Mỗi trường có thể được đặt tên theo loại trường có liên quan của bạn, ví dụ nhưparagraphText.
{
"id": "26f6117c-147b-4447-86aa-992e9ddb0daa",
"name": "primary-content",
"heroText": "<i>What a way to start your week</i>",
"heroTextColour": "#000000",
"heroSubText": "<i>What a way to start your week</i>",
}
Để biết thêm thông tin về những điều có thể thực hiện được với phân đoạn nội dung, hãy xem Cấu trúc cấp cao.
Phân đoạn sản phẩm
Bên trong mảng data mảng, mỗi phân đoạn là một đối tượng, như bên dưới:
Định dạng phản hồi này là cố định và không tùy chỉnh
{
"id": "988dc393-a37a-421c-9b08-25f0f9e575f8",
"name": "my-products",
"productSelection": [
{
"catalogId": "1b5a2521-9e79-4b95-99b0-4deffc586d81",
"position": 3,
"productCode": "f069585b-a364-4795-9eb3-6a978c513ba4",
"sellerId": "123"
},
{
"catalogId": "1b5a2521-9e79-4b95-99b0-4deffc586d81",
"position": 2,
"productCode": "f069585b-a364-4795-9eb3-6a978c513ba4",
"sellerId": "123"
},
{
"catalogId": "1b5a2521-9e79-4b95-99b0-4deffc586d81",
"position": 1,
"productCode": "f069585b-a364-4795-9eb3-6a978c513ba4",
"sellerId": "123"
}
]
}
Thông tin sản phẩm
Giống như tích hợp quảng cáo sản phẩm tiêu chuẩn, CitrusAd không cấp phát các thuộc tính sản phẩm như tên, giá cả và hình ảnh. Thuộc tính này sẽ cần được tìm nạp từ máy chủ thông tin sản phẩm nội bộ (hoặc tương tự) trên cơ sở hạ tầng của nhà bán lẻ.
Mặc dù đây là nỗ lực tích hợp bổ sung, nhưng điều này đảm bảo không có phần phụ thuộc vào Citrus khi cập nhật và thay đổi thông tin về giá, cũng như bất kỳ đồ họa tự động nào, chẳng hạn như nội dung đặc biệt, giảm giá 20% hoặc nội dung tương tự phụ thuộc vào CitrusAd.
Để biết thêm thông tin về những điều có thể thực hiện được với các phân đoạn sản phẩm, hãy xem Cấu trúc cấp cao.
Diễn giải phản hồi
Trong phản hồi, mỗi phân đoạn có một id và một name. Những thành phần này sẽ là duy nhất cho phân đoạn trong một mẫu. Bạn có thể sử dụng chúng để xác định các loại thành phần khác nhau, chẳng hạn như loại biểu ngữ hoặc loại nội dung và căn chỉnh nó vào vị trí bạn đưa vào.
Ví dụ về phản hồi
Dưới đây là ví dụ về phản hồi trang thương hiệu cho mẫu có một biểu ngữ, một nội dung và một phân đoạn sản phẩm sẽ xuất hiện như thế nào.
CUSTOM_ID_Nlà ví dụ về ID do nhà bán lẻ xác định, chẳng hạn nhưparagraphText.
Phản hồi
{
"id": "string",
"brandPageId": "string",
"brandPageTemplateId": "string",
"data": [
{
"id": "string",
"name": "string",
"CUSTOM_ID_1": "string",
"CUSTOM_ID_2": "string",
"CUSTOM_ID_3": "string"
},
{
"id": "string",
"name": "string",
"productSelection": [
{
"catalogId": "string",
"position": integer,
"productCode": "string",
"sellerId": "string"
},
{
"catalogId": "string",
"position": integer,
"productCode": "string",
"sellerId": "string"
},
{
"catalogId": "string",
"position": integer,
"productCode": "string",
"sellerId": "string"
}
]
},
{
"id": "string",
"name": "string",
"CUSTOM_TEXT_FIELD_ID_1": "VALUE",
"CUSTOM_COLOUR_FIELD_ID_1": "VALUE",
"CUSTOM_TEXT_FIELD_ID_2": "VALUE",
}
]
}
Bạn muốn xem các mẫu và ví dụ khác? Xem Ví dụ về các mẫu trang thương hiệu.