สร้างโฆษณาผลิตภัณฑ์โดยใช้ตำแหน่งการค้นหา

เอกสารนี้ให้คำแนะนำที่ครอบคลุมเกี่ยวกับวิธีการสร้างโฆษณาผลิตภัณฑ์ตามเกณฑ์การค้นหาที่ระบุ คำขอ API แต่ละรายการจะต้องมีรายละเอียดเกี่ยวกับบริบทเช่น:

  • ตำแหน่ง
  • ID แคตตาล็อก
  • customerId
  • sessionId
  • คำค้นหา
  • จำนวนโฆษณาสูงสุดที่จะแสดง

ข้อกําหนดเบื้องต้น

คุณต้องทำตามขั้นตอนต่อไปนี้ก่อนที่จะเริ่มขอโฆษณาผลิตภัณฑ์สำหรับตำแหน่งการค้นหา

เพิ่มแค็ตตาล็อกสินค้า

ตรวจสอบให้แน่ใจว่าได้เพิ่มผลิตภัณฑ์ของคุณลงในแค็ตตาล็อกและซิงค์กับ Epsilon Retail Media Platform แล้ว

สร้างแคมเปญและกำหนดค่าคำค้นหา

ตรวจสอบให้แน่ใจว่าคุณได้สร้างแคมเปญและกำหนดคำค้นหาแล้ว สำหรับรายละเอียดเพิ่มเติม โปรดดูขั้นตอนที่ 4b: กำหนดค่าคำค้นหา

กำหนดคำค้นหาที่คุณต้องการกำหนดเป้าหมาย (รวมและยกเว้น) สำหรับโฆษณาผลิตภัณฑ์ของคุณ คุณสามารถระบุการค้นหาแบบตรงกันทุกคำ แบบตรงวลีที่ค้นหา และแบบคำค้นหาเชิงลบสำหรับโฆษณาของคุณได้

  • คู่ที่เหมาะสม:
    • กำหนดเป้าหมายข้อความค้นหาที่ตรงกับคำหลักของคุณทุกประการ
    • ตัวอย่าง: หากคำหลักของคุณคือ "รองเท้าวิ่งสีน้ำเงิน" โฆษณาของคุณจะปรากฏเฉพาะกับผู้ใช้ที่พิมพ์ "รองเท้าวิ่งสีน้ำเงิน" ตามลำดับที่แน่นอนโดยไม่มีคำอื่นใด
  • การจับคู่วลี:
    • กำหนดเป้าหมายข้อความค้นหาที่ตรงกับคำหลักของคุณทุกประการ
    • โฆษณาของคุณสามารถปรากฏสำหรับการค้นหาที่มีคำเพิ่มเติมก่อนหรือหลังวลี
    • ตัวอย่าง: หากคำหลักของคุณคือ "รองเท้าวิ่งสีน้ำเงิน" โฆษณาของคุณจะปรากฏเฉพาะกับผู้ใช้ที่พิมพ์ "รองเท้าวิ่งสีน้ำเงิน" ตามลำดับที่แน่นอนโดยไม่มีคำอื่นใด
    • สำหรับข้อมูลเพิ่มเติม โปรดดู ข้อความค้นหาที่ทำงานแบบวลี
  • คำค้นหาเชิงลบ
    • ยกเว้นคำหรือวลีเฉพาะจากแคมเปญของคุณ
    • ป้องกันไม่ให้โฆษณาของคุณปรากฏในการค้นหาที่ไม่เกี่ยวข้อง
    • ตัวอย่าง: การเพิ่ม "มือสอง" เป็นคำเชิงลบสำหรับโฆษณารถยนต์ใหม่จะช่วยหลีกเลี่ยงการแสดงโฆษณากับผู้ที่กำลังมองหารถยนต์มือสอง

ดึงคีย์ API และ URL ฐาน

  1. คุณต้องมีคีย์ API ที่ถูกต้อง หากต้องการดึงข้อมูลคีย์ API ให้ทำดังต่อไปนี้:

    1. ลงชื่อเข้าใช้บัญชีทีม Retail Media ของ Epsilon

    2. ไปที่มุมขวาบนของหน้าแล้วคลิกเมนูแบบเลื่อนลง

    3. เลือก การตั้งค่าการรวม จากเมนูแบบเลื่อนลง

    4. คลิกที่แท็บคีย์ API รหัส API ลับของคุณถูกซ่อนไว้ในตอนแรก หากต้องการดู ให้คลิกที่ปุ่มแสดง เมื่อมองเห็นได้ ให้คัดลอกคีย์ API ลับของคุณ ใช้คีย์นี้เพื่อเรียก API

  2. คุณต้องมี URL ฐานสำหรับเอนพอยต์ API ตัวอย่างเช่น https://staging-test.citrusad.com/v1/ads/generate HTTP/1.1 ตรวจสอบ URL ฐานกับผู้จัดการบัญชีทางเทคนิคของคุณ

สร้างโฆษณา

ทำตามขั้นตอนต่อไปนี้เพื่อสร้างโฆษณาผลิตภัณฑ์

คำขอ HTTP

เอนพอยต์: /v1/ads/generate

วิธีการ: POST

ส่วนหัว:

  • ยอมรับ: application/json
  • ประเภทเนื้อหา: application/json
  • การอนุญาต: พื้นฐาน <API_KEY>

ขอพารามิเตอร์

เนื้อหาของคำขอควรเป็นออบเจ็กต์ JSON ที่มีฟิลด์ต่อไปนี้:

วัตถุประเภทคำอธิบาย
customerIdสตริง, จำเป็นตัวระบุที่ไม่ซ้ำกันสำหรับลูกค้า ข้อมูลนี้จัดทำโดยผู้ค้าปลีกของคุณ
sessionIdสตริง, จำเป็นตัวระบุเฉพาะสําหรับเซสชัน ข้อมูลนี้จำเป็นสำหรับการระบุแหล่งที่มาและจัดเตรียมโดยผู้ค้าปลีก
ตำแหน่งสตริง, จำเป็นบริบทที่โฆษณาแสดง (เช่น "การค้นหา")
ID แคตตาล็อกสตริง, จำเป็นตัวระบุที่ไม่ซ้ำกันสำหรับแค็ตตาล็อกผลิตภัณฑ์ที่มีการกรองผลิตภัณฑ์ คุณสามารถรับ CatalogID ได้จาก Retail Media UI ของ Epsilon หรือจากผู้ค้าปลีก
maxNumberOfAdsจํานวนเต็ม จําเป็นจำนวนโฆษณาสูงสุดที่จะแสดง
คำค้นหาสตริง จำเป็นสำหรับตำแหน่งการค้นหาคําที่จะค้นหาภายในแค็ตตาล็อก
ตัวเลือกวัตถุ ไม่บังคับตัวเลือกเพิ่มเติม เช่น โหมดการกรอง AndOrหากระบุ ระบบจะใช้ทั้งเงื่อนไข "AND" และ "OR" เพื่อจำกัดผลการค้นหาให้แคบลง

ตัวอย่างคำขอ

คำขอนี้ใช้เพื่อสร้างโฆษณาสูงสุด 3 โฆษณาที่เกี่ยวข้องกับคำค้นหา chocolateโฆษณาเหล่านี้จะอยู่ในผลการค้นหาสำหรับลูกค้าเฉพาะราย (รหัสลูกค้า: "wertg5432a") และเซสชัน (รหัสเซสชัน: "ec9-4e07-881d-3e9") โฆษณาจะถูกสร้างขึ้นจากแค็ตตาล็อกที่ระบุโดย CatalogId: "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b" พร้อมระบุตัวเลือกการกรองเพิ่มเติม (filterMode: "AndOr")

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",
    "dtmCookieId": "AAAF8xLBTA968AB6TOthAAAAAAE",
    "placement": "search",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "searchTerm": "chocolate",
    "options": {
   						 "filterMode": "AndOr"
 							 },
    "maxNumberOfAds": 3    
}

ตัวอย่างการตอบสนอง

📘

เมื่อคุณได้รับคําตอบจากโฆษณาผลิตภัณฑ์ โดยทั่วไปแล้วการตอบกลับจะมีรหัสผลิตภัณฑ์ เช่น GTIN ในตัวอย่างนี้ ผู้ค้าปลีกจําเป็นต้องใช้รหัสผลิตภัณฑ์ที่ให้ไว้ในการตอบกลับของโฆษณาเพื่อค้นหาเมทาดาตาที่จําเป็นสําหรับการแสดงผลิตภัณฑ์

ในตัวอย่างนี้ "gtin": "024100191345" คือรหัสผลิตภัณฑ์ ผู้ค้าปลีกจะใช้ GTIN นี้เพื่อระบุและแสดงผลิตภัณฑ์ที่ได้รับการสนับสนุนโดยเฉพาะ

{
    "ads": [
        {
            "id": "display_QqHaKRrKlFm1Wxr9c_DXJN4HSE3NzMzNjM2",
            "gtin": "7733636",
            "discount": {
                "amount": 0,
                "minPrice": 0,
                "maxPerCustomer": 0
            },
            "expiry": "2021-05-12T04:17:50.400902957Z",
            "position": 1
        },
        {
            "id": "display_NzsHqP0_iQedlo9VnrO2vqkwi_k3NzMzNjI4",
            "gtin": "7733628",
            "discount": {
                "amount": 0,
                "minPrice": 0,
                "maxPerCustomer": 0
            },
            "expiry": "2021-05-12T04:17:50.400908257Z",
            "position": 2
        },
        {
            "id": "display_xNeShqidaMuEqiJ0zNdt-Gzygjs3NzE0MTA3",
            "gtin": "7714107",
            "discount": {
                "amount": 0,
                "minPrice": 0,
                "maxPerCustomer": 0
            },
            "expiry": "2021-05-12T04:17:50.400912929Z",
            "position": 3
        },
        {
            "id": "display_3rGiryPskhQusmsf43nghbQwnqo3NzMzNjU3",
            "gtin": "7733657",
            "discount": {
                "amount": 0,
                "minPrice": 0,
                "maxPerCustomer": 0
            },
            "expiry": "2021-05-12T04:17:50.400917769Z",
            "position": 4
        }
    ],
    "banners": [],
    "products": [],
}

ขั้นตอนถัดไป