การขอโฆษณา
โฆษณาแบนเนอร์ x ถูกสร้างขึ้นบน /bannerx ตําแหน่งข้อมูล คำขอแบนเนอร์ x ทั้งหมดต้องมี contentStandardId และการ bannerSlotIds ที่คุณกำลังขอโฆษณาให้ นอกจากนี้ การเรียกแบนเนอร์ของคุณควรมี customerId,sessionId,placementและ catalogId.
เมื่อขอโฆษณาแบนเนอร์ x คุณสามารถระบุจำนวนแบนเนอร์สูงสุดที่คุณต้องการได้รับต่อช่องแบนเนอร์ คุณสามารถควบคุมสิ่งนี้ได้ด้วย maxNumberOfAds พารามิเตอร์
ตำแหน่งการค้นหา
ตำแหน่งการค้นหามักจะง่ายที่สุดที่จะขอ พวกเขาต้องการ searchTerm ระบุไว้ในคำขอ ดังตัวอย่างด้านล่าง:
POST $BASE_URL/v1/ads/bannerx HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
"customerId": "wertg5432a",
"sessionId": "ec9-4e07-881d-3e9",
"placement": "search",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"searchTerm": "chocolate",
"options": {
"filterMode": "AndOr"
},
"contentStandardId": "c61941e2-1435-460b-9d2b-5d838e3dba9c",
"bannerSlotIds": [
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 1
},
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 2
}
]
}
ตำแหน่งหมวดหมู่
ต้องระบุตําแหน่งประเภท productFilters ระบุไว้ในคำขอ ตัวอย่างด้านล่างแสดงตำแหน่งที่คุณจะส่งตัวกรองหมวดหมู่:
POST $BASE_URL/v1/ads/bannerx HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
"customerId": "wertg5432a",
"sessionId": "ec9-4e07-881d-3e9",
"placement": "category",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"productFilters": [
["category:Cupboard/Snacks"]
],
"options": {
"filterMode": "AndOr"
},
"contentStandardId": "fec2ab89-7a29-42b5-b58a-5675688b52d9",
"bannerSlotIds": [
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 1
},
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 2
}
}
เนื่องจากมีการอ่านหมวดหมู่เพิ่มเติม คุณควรอัปเดตการเรียก API ของคุณตามลำดับ
ตําแหน่งหมวดหมู่การขายพ่วง
ตำแหน่งหมวดหมู่ขายพ่วงมีคำขอที่คล้ายกันมากกับตำแหน่งหมวดหมู่ คุณจะต้องระบุหมวดหมู่ที่แน่นอนที่คุณต้องการขอโฆษณา โดยทั่วไปจะเป็นหน้าที่คุณกำลังดูอยู่ ระบุหมวดหมู่ใน productFilters ของคำขอ ตัวอย่างด้านล่างแสดงตำแหน่งที่คุณจะส่งตัวกรองหมวดหมู่:
POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
"customerId": "wertg5432a",
"sessionId": "ec9-4e07-881d-3e9",
"placement": "category-cross-sell",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"productFilters": [
["category:Cupboard/Snacks"]
],
"options": {
"filterMode": "AndOr"
},
"contentStandardId": "fec2ab89-7a29-42b5-b58a-5675688b52d9",
"bannerSlots": [
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 1
},
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 2
}
],
"maxNumberOfAds": 3
}
เนื่องจากมีการอ่านหมวดหมู่เพิ่มเติม คุณต้องอัปเดตการเรียก API ของคุณตามลำดับ
การรวมการกำหนดเป้าหมายตามหมวดหมู่ทั่วไปและการขายต่อเนื่องเข้าด้วยกันใช่หรือไม่
หากคุณต้องการรวมคำขอโฆษณาหมวดหมู่ทั่วไปและแบบขายพ่วงไว้ในตำแหน่งเดียว คุณจะต้องใช้ตรรกะการรวมและการจัดส่งกับลูกค้าของคุณ นี่เป็นความรับผิดชอบของผู้รวมระบบ แม้ว่า CitrusAd ยินดีที่จะให้คำปรึกษา
โดยทั่วไป เราขอแนะนำให้คุณแสดงโฆษณาหมวดหมู่ทั่วไป และโฆษณาขายพ่วงตำแหน่งและหมวดหมู่หลังจากตำแหน่งทั่วไป
ตําแหน่งการทํางานแบบกว้าง
ตำแหน่งกว้างๆ เช่น หน้าแรกหรือหน้าชำระเงิน ไม่จำเป็นต้องมี productFilters ระบุไว้ในคำขอ ตัวกรองใดๆ ที่ผู้ค้าปลีกต้องการระบุ (ตามข้อเสนอ ใหม่ ฯลฯ) สามารถระบุได้ใน productFilters เพื่อให้แน่ใจว่า CitrusAd แสดงเฉพาะโฆษณาภายในข้อกำหนด เช่นตัวอย่างด้านล่าง:
POST $BASE_URL/v1/ads/bannerx HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
"customerId": "wertg5432a",
"sessionId": "ec9-4e07-881d-3e9",
"placement": "home",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"productFilters": [
[]
],
"options": {
"filterMode": "AndOr"
},
"contentStandardId": "fec2ab89-7a29-42b5-b58a-5675688b52d9",
"bannerSlotIds": [
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 1
},
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 2
}
}
ขอการปรับปรุง
เราขอแนะนำให้คุณพิจารณาการปรับปรุงด้านล่างเพื่อปรับปรุงประสบการณ์ผู้ใช้ของคุณ
การค้นหาที่กรองแล้ว
หากลูกค้าของคุณกรองการค้นหา คุณสามารถขยายบริบทของคุณเพื่อระบุ productFiltersด้านล่างคือตัวอย่างที่ลูกค้ากรองตามหมวดหมู่ "ตู้" และข้อจำกัดด้านอาหาร "ปราศจากกลูเตน" หลักการเดียวกันนี้สามารถนำไปใช้กับหมวดหมู่หรือตำแหน่งการทำงานแบบกว้างใดก็ได้
POST $BASE_URL/v1/ads/bannerx HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
"customerId": "wertg5432a",
"sessionId": "ec9-4e07-881d-3e9",
"placement": "search",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"searchTerm": "chocolate",
"productFilters": [
["category:Cupboard"],["dietary:Gluten-free"]
],
"options": {
"filterMode": "AndOr"
},
"contentStandardId": "fec2ab89-7a29-42b5-b58a-5675688b52d9",
"bannerSlotIds": [
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 1
},
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 2
}
}
การกรองตามตําแหน่งที่ตั้ง
หากคุณกำลังซิงค์ตัวกรองตำแหน่งที่ตั้งในแค็ตตาล็อกของคุณ คุณสามารถขยายบริบทของคุณเพื่อระบุตำแหน่งที่ตั้งร้านค้าของลูกค้าใน productFiltersเช่นตัวอย่างด้านล่าง:
POST $BASE_URL/v1/ads/bannerx HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
"customerId": "wertg5432a",
"sessionId": "ec9-4e07-881d-3e9",
"placement": "search",
"catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
"searchTerm": "chocolate",
"productFilters": [
["category:Cupboard"],["dietary:Gluten-free"],["location:Westenbury"]
],
"options": {
"filterMode": "AndOr"
},
"contentStandardId": "fec2ab89-7a29-42b5-b58a-5675688b52d9",
"bannerSlotIds": [
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 1
},
{
"slotId": "<SLOT_ID>",
"maxNumberOfAds": 2
}
}
การตอบสนองแบนเนอร์ x
คำตอบทั้งหมดเป็นไปตามรูปแบบ JSON เดียวกัน เนื้อหาทั้งหมดที่จำเป็นในการแสดงแบนเนอร์มีให้ในการตอบกลับ หากแบนเนอร์ไม่มีการกำหนดค่าองค์ประกอบ (เช่น ไม่มีภาพฮีโร่รอง) CitrusAd จะไม่ให้บริการคุณสมบัติ
{
"ads": [
{
"contentStandardId": "c619d1e2-1435-460b-9d2b-5d838e3dba9c",
"slotId": "<SLOT_ID>",
"banners": [
{
"citrusAdId": "shotgun__vW5pOojxDfN7T9VwaXWQLF2wKw3NzE0MTA3",
"citrusCampaignName": "CitrusAd-Example-Category-Banner-X-Ad-52793b405f1347b22e72a38c5a08699b",
"citrusContentStandardId": "c619d1e2-1435-460b-9d2b-5d838e3dba9c",
"citrusSlotId": "<SLOT_ID>",
"citrusExpiry": "2021-05-17T02:47:52.849995214Z",
"headingText": "Banner Advertisement for Magnum Double Ice Cream with a product image and shop now button",
"bannerText": "<strong>Magnum Double Ice Cream</strong>",
"bannerTextColour": "6e6c6c",
"ctaFlag": true,
"ctaText": "Shop now",
"ctaTextAccessibility": "for Magnum products",
"ctaLink": "https://www.tesco.com/groceries/en-GB/search?query=magnums",
"backgroundColour": "e1d6ac",
"heroImage": "https://cdn.flavedo.io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3",
"heroImageAltText": "Magnums",
"tags": {},
"gtins": [
"7714107",
"7733636",
"7733657",
"7163379",
"7733628"
],
"position": 1
}
]
},
{
"contentStandardId": "c619d1e2-1435-460b-9d2b-5d838e3dba9c",
"slotId": "<SLOT_ID>",
"banners": [
{
"citrusAdId": "shotgun_kZp9yTCMm71vTo7iyQaK9I_YB09FUFYzNzBTQ0FO",
"citrusCampaignName": "milo-campaign-lakjsdf09kj",
"citrusContentStandardId": "21r372ba-dce6-46f2-bd16-1b923b9189f9",
"citrusSlotId": "<SLOT_ID>",
"citrusExpiry": "2021-05-17T02:47:52.849995214Z",
"headingText": "A banner for Milo with a product image and a shop now button",
"bannerText": "<strong>Try Milo Cereal</strong>",
"bannerTextColour": "48a94c",
"heroImage": "https://assets.imageurl.io/s/85d2d333-eed5-44d7-b131-8851d59f0574",
"heroImageAltText": "Milo product image",
"ctaFlag": true,
"ctaText": "Shop now",
"ctaTextAccessibility": "for Milo products",
"ctaLink": "retailer.com/everything/search/heritage%20mill?pageNumber=1",
"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",
"tags": {},
"gtins": [
"16309011",
"57312011",
"65250011"
],
"position": 1
}
]
}
]
}
AD_ID id ฟิลด์ id คือ ID โฆษณาของคุณที่ใช้ในรายงานการแสดงผลและการคลิก โปรดดูข้อมูลอ้างอิงสำหรับข้อมูลเพิ่มเติมเกี่ยวกับแต่ละสตริง
แท็กติดตามของบุคคลที่สาม
สำหรับโฆษณาแบนเนอร์ x CitrusAd รองรับการส่งต่อแท็กติดตามของบุคคลที่สามไปยังผู้ค้าปลีก ผู้โฆษณาใช้แท็กเหล่านี้เพื่อยืนยันประสิทธิภาพโดยบุคคลที่สามที่เชื่อถือได้
CitrusAd รองรับแท็กติดตามด้านล่าง:
- DoubleVerify (จาวาสคริปต์และรูปภาพ)
- DCM Click
- DCM Impression
- IAS
- การสร้างผล Adform
- คลิก Adform
หากแคมเปญมีการกำหนดค่าแท็กติดตาม แท็กจะแสดงเป็นฟิลด์ที่เกี่ยวข้องใน trackingTags วัตถุด้านล่าง โปรดทราบว่าหากแคมเปญไม่มีการกำหนดค่าแท็ก tagsและ trackingTags วัตถุจะยังคงว่างเปล่า
{
"ads": [
{
"contentStandardId": "c619d1e2-1435-460b-9d2b-5d838e3dba9c",
"slotId": "<SLOT_ID>",
"banners": [
{
"citrusAdId": "shotgun__vW5pOojxDfN7T9VwaXWQLF2wKw3NzE0MTA3",
"citrusCampaignName": "CitrusAd-Example-Category-Banner-X-Ad-52793b405f1347b22e72a38c5a08699b",
"citrusContentStandardId": "c619d1e2-1435-460b-9d2b-5d838e3dba9c",
"citrusSlotId": "<SLOT_ID>",
"citrusExpiry": "2021-05-17T02:47:52.849995214Z",
"headingText": "Banner Advertisement for Magnum Double Ice Cream with a product image and shop now button",
"bannerText": "<strong>Magnum Double Ice Cream</strong>",
"bannerTextColour": "6e6c6c",
"ctaFlag": true,
"ctaText": "Shop now",
"ctaTextAccessibility": "for Magnum products",
"ctaLink": "https://www.tesco.com/groceries/en-GB/search?query=magnums",
"backgroundColour": "e1d6ac",
"heroImage": "https://cdn.flavedo.io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3",
"heroImageAltText": "Magnums",
"tags": {},
"trackingTags": {
"ADFORM_CLICK": "https://track.adform.net...",
"ADFORM_IMPRESSION": "<img src=\"https://track.adform.net...",
"DCM_CLICK": "https://ad.doubleclick.net/ddm/trackclk/...",
"DCM_IMPRESSION": "<IMG SRC=\"https://ad.doubleclick.net/ddm/trackimp/...",
"DV": "<script src=\"https://cdn.doubleverify.com/dvtp_src.js?ctx=...",
"DV_IMAGE": "<img src=\"https://tps.doubleverify.com/visit.jpg?ctx=..."
},
"gtins": [
"7714107",
"7733636",
"7733657",
"7163379",
"7733628"
],
"position": 1
}
]
}
]
}
เนื่องจาก CitrusAd เป็นการผสานระหว่างเซิร์ฟเวอร์กับเซิร์ฟเวอร์ แท็กติดตามของบุคคลที่สามจึงต้องมีการพัฒนาเพิ่มเติมโดยผู้ค้าปลีก ติดต่อผู้จัดการบัญชีด้านเทคนิคของคุณ หากคุณต้องการใช้คุณลักษณะนี้
tagsวัตถุสำหรับแท็ก DoubleVerify (Javascript) และ DCM คุณอาจเห็น
tagsวัตถุที่ถูกสร้างเช่นกัน แนวทางปฏิบัติที่ดีที่สุดคือการใช้trackingTagsการตอบกลับ
รหัสผู้ขายในตลาด
หากเป็นผู้ขายในตลาด คุณอาจเห็นเพิ่มเติม sellerId ต่อโฆษณาในการตอบกลับ ซึ่งจะปรากฏขึ้นก็ต่อเมื่อทีมที่เป็นเจ้าของแคมเปญที่กำลังให้บริการมีรหัสผู้ขายที่กำหนดค่าไว้ใน UI ตัวอย่างด้านล่างแสดงโฆษณาหนึ่งรายการที่มี sellerId อีกรายการไม่มี
{
"ads": [
{
"contentStandardId": "c619d1e2-1435-460b-9d2b-5d838e3dba9c",
"slotId": "<SLOT_ID>",
"banners": [
{
"citrusAdId": "shotgun__vW5pOojxDfN7T9VwaXWQLF2wKw3NzE0MTA3",
"citrusCampaignName": "CitrusAd-Example-Category-Banner-X-Ad-52793b405f1347b22e72a38c5a08699b",
"citrusContentStandardId": "c619d1e2-1435-460b-9d2b-5d838e3dba9c",
"citrusSlotId": "<SLOT_ID>",
"citrusExpiry": "2021-05-17T02:47:52.849995214Z",
"headingText": "Banner Advertisement for Magnum Double Ice Cream with a product image and shop now button",
"bannerText": "<strong>Magnum Double Ice Cream</strong>",
"bannerTextColour": "6e6c6c",
"ctaFlag": true,
"ctaText": "Shop now",
"ctaTextAccessibility": "for Magnum products",
"ctaLink": "https://www.tesco.com/groceries/en-GB/search?query=magnums",
"backgroundColour": "e1d6ac",
"heroImage": "https://cdn.flavedo.io/s/9b93e7f9-d747-4c8b-bcba-2357b280a3b3",
"heroImageAltText": "Magnums",
"tags": {},
"gtins": [
"7714107",
"7733636",
"7733657",
"7163379",
"7733628"
],
"position": 1,
"sellerId": "1ben32-ss3d43-amea"
}
]
},
{
"contentStandardId": "c619d1e2-1435-460b-9d2b-5d838e3dba9c",
"slotId": "<SLOT_ID>",
"banners": [
{
"citrusAdId": "shotgun_kZp9yTCMm71vTo7iyQaK9I_YB09FUFYzNzBTQ0FO",
"citrusCampaignName": "milo-campaign-lakjsdf09kj",
"citrusContentStandardId": "21r372ba-dce6-46f2-bd16-1b923b9189f9",
"citrusSlotId": "<SLOT_ID>",
"citrusExpiry": "2021-05-17T02:47:52.849995214Z",
"headingText": "A banner for Milo with a product image and a shop now button",
"bannerText": "<strong>Try Milo Cereal</strong>",
"bannerTextColour": "48a94c",
"heroImage": "https://assets.imageurl.io/s/85d2d333-eed5-44d7-b131-8851d59f0574",
"heroImageAltText": "Milo product image",
"ctaFlag": true,
"ctaText": "Shop now",
"ctaTextAccessibility": "for Milo products",
"ctaLink": "retailer.com/everything/search/heritage%20mill?pageNumber=1",
"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",
"tags": {},
"gtins": [
"16309011",
"57312011",
"65250011"
],
"position": 1
}
]
}
]
}
แท็กติดตามของบุคคลที่สาม
จะมาในรุ่น 44
ความสามารถนี้ได้รับการวางแผนให้เผยแพร่ในรีลีส 44.0 เดอะ
tagsอาร์เรย์มีให้แล้วในการตอบสนอง
CitrusAd รองรับการส่งแท็กการติดตามของบุคคลที่สามไปยังผู้ค้าปลีก ผู้โฆษณาใช้แท็กเหล่านี้เพื่อยืนยันประสิทธิภาพโดยบุคคลที่สามที่เชื่อถือได้
CitrusAd รองรับแท็กติดตามด้านล่าง:
- DoubleVerify
- DCM Click
- DCM Impression
- IAS
หากแคมเปญมีการกำหนดค่าแท็กติดตาม แท็กจะแสดงเป็นฟิลด์ที่เกี่ยวข้องใน tags วัตถุด้านล่าง โปรดทราบว่าหากแคมเปญไม่มีการกำหนดค่าแท็ก tags วัตถุจะยังคงว่างเปล่า
{
"ads": [],
"banners": [
{
"id": "banner_XeemTeq59HapGSp4vccOYfBq_yvc3zMzNjM2",
"contentStandardId": "fec2ab89-7a29-42b5-b58a-5675688b52d9",
"slotId": "<SLOT_ID>",
"imageUrl": "https://cdn.flavedo.io/s/-oW-C3cEViSSO2krWkwOBUXOhvUdhHOySx-YQLGZ1lA=",
"linkUrl": "https://www.retailer.com/link",
"altText": "Your local ice cream",
"text": "",
"gtins": [
"7733628",
"7714107",
"7163379",
"7733636",
"7733657"
],
"expiry": "2021-05-17T01:49:17.75503253Z",
"tags": {
"dv": "<script src=\"https://cdn.doubleverify.com/dvtp_src.js?ctx=919421&cmp=1074060503&sid=1073907024&plc=1075810393&adsrv=115&btreg=&btadsrv=&crt=&tagtype=&dvtagver=6.1.src\" type=\"text/javascript\"></script>",
"dcmClick": "<script ..../>",
"dcmImpression": "<script.... />",
"ias": "<script.... />" }
}
],
"products": [],
"memoryToken":"85ykKVv-luDHMWLZx2d6xcPq6sF7CgkJCSJDb3VudGVyIjogIjIiLAoJCQkiQWRzIjogWwoJCQkJImRpc3BsYXlfV05VV0NwQkRKMUpKNm5wdVZSVExvOU40TUxzNE1UWTBOemt5TWc9PSIsCgkJCQkiZGlzcGxheV9MME5NUHRxNmdCcVFvREJOd3J0dE9UTGJoWk0xTVRFeU9UYzRPUT09IiwKCQkJCSJkaXNwbGF5XzlCcEpmdUpaWk9VXzgyaWpFM3VCczgxd3VVczRNekkwTnpVeE5nPT0iLAoJCQkJImRpc3BsYXlfcW1VU1p4TkpMQ0lqeWQwdTFJRDk0RmxVZ0pnNE16STBOelV4Tnc9PSIsCgkJCQkiZGlzcGxheV9oeHlFZktCUnRrNWlxMThMQzE1SDJHcEN3QjgxTVRFeU9UYzVNQT09IiwKCQkJCSJkaXNwbGF5X1NkcjFEcU5aUEFtcGh0Q1FIUndoYUxFT1B0RXhNamsxT1RJNE5BPT0iLAoJCQkJImRpc3BsYXlfeVlSai1qV2Ntc2ozNzhrel9PMm0yOVlwTjhJeE5EazNPRE00TXc9PSIsCgkJCQkiZGlzcGxheV9Xbm9NZGZuLTRTVmhxcF9xQzVvLWxoT0paNm8xTkRJeE1UUTROdz09IgoJCQldLAoJCQkiVFRMIjogMTYyODk4NTYwMAoJCX0="
}
เนื่องจาก CitrusAd เป็นการผสานระหว่างเซิร์ฟเวอร์กับเซิร์ฟเวอร์ แท็กติดตามของบุคคลที่สามจึงต้องมีการพัฒนาเพิ่มเติมโดยผู้ค้าปลีก