API ของคู่ค้า
คู่มือ

ขั้นตอนที่ 1: สร้างแค็ตตาล็อกผลิตภัณฑ์

ขั้นตอนแรกคือการสร้างแค็ตตาล็อกผลิตภัณฑ์ แค็ตตาล็อกมีรายละเอียดผลิตภัณฑ์ของคุณ ซึ่งจำเป็นในการแสดงโฆษณาสำหรับผลิตภัณฑ์ของคุณ

  • คุณสามารถสร้างแค็ตตาล็อกเดียวหรือหลายแค็ตตาล็อกในคำขอเดียว หากคุณกำลังสร้างแค็ตตาล็อกหลายรายการ คุณสามารถจัดลำดับได้สูงสุด 100 รายการต่อคำขอ
  • เมื่อสร้างแค็ตตาล็อก catalogId ถูกส่งกลับ สิ่งนี้ catalogId จำเป็นเมื่อเพิ่มรายละเอียดสินค้าของคุณลงในแคตตาล็อกของคุณ ซึ่งทำหน้าที่เป็นตัวระบุที่ไม่ซ้ำกันสำหรับแคตตาล็อก
  • หากคุณไม่สามารถสร้างแค็ตตาล็อกโดยใช้ API ที่ระบุในเอกสารนี้ได้ โปรดติดต่อวิศวกรบูรณาการลูกค้า (CIE) ของคุณ ซึ่งสามารถสร้างแค็ตตาล็อกในนามคุณได้
  • เมื่อสร้างแค็ตตาล็อกแล้ว แค็ตตาล็อกจะถูกซ่อนไว้ตามค่าเริ่มต้น ดังนั้นคุณต้องติดต่อ CIE เพื่อทำให้แค็ตตาล็อกมองเห็นได้ในเนมสเปซของคุณ

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

คุณต้องมีคีย์ 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 ฐานกับผู้จัดการบัญชีทางเทคนิคของคุณ

สร้างแค็ตตาล็อกเดียว

เอนพอยต์ API นี้ช่วยให้คุณสามารถสร้างแค็ตตาล็อกใหม่ แต่ละแค็ตตาล็อกถูกระบุอย่างเฉพาะเจาะจงด้วย id ที่คุณจะต้องใช้การดำเนินการเพิ่มเติม เช่น เมื่อเพิ่มรายละเอียดผลิตภัณฑ์ลงในแค็ตตาล็อก

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

วัตถุประเภทคำอธิบาย
แคตตาล็อกอาร์เรย์ จำเป็นอาร์เรย์อ็อบเจ็กต์แค็ตตาล็อกที่จะสร้าง
ชื่อสตริง, จำเป็นชื่อแค็ตตาล็อก ขอแนะนำให้ใช้ชื่อที่มีความหมาย ซึ่งสามารถระบุและเชื่อมโยงกับผู้ค้าปลีกได้ง่าย

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

POST $BASE_URL/v1/catalogs HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "catalogs": [
        {
            "name": "Retailer A"
        }
    ]
}

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

การตอบสนองเป็นไปตามรูปแบบ JSON มาตรฐานและส่งคืนรายละเอียดต่อไปนี้ในอาร์เรย์

  • teamId: ID ของทีมที่เชื่อมโยงกับแค็ตตาล็อก
  • name: ชื่อของแค็ตตาล็อก
  • id: ตัวระบุที่ไม่ซ้ำกันสำหรับแค็ตตาล็อก ID นี้จำเป็นสำหรับการดำเนินการเพิ่มเติม เช่น เมื่อเพิ่มรายละเอียดผลิตภัณฑ์ของคุณลงในแค็ตตาล็อก
{
    "catalogs": [
        {
            "teamId": "9f48572c-0a5b-4997-9a0e-ed74f4d32dc6",
            "name": "Retailer A",
            "id": "216af452-d219-4807-b8ca-578bba446541"
        }
    ]
}

📘

เมื่อส่งคืนอ็อบเจ็กต์สำเร็จแล้ว คุณจะได้รับ ID สำหรับแค็ตตาล็อกใหม่ของคุณ หากคุณส่งคำขอเดิมอีกครั้ง คุณจะได้รับ ID ใหม่ ซึ่งจะสร้างแค็ตตาล็อกสองรายการ

การสร้างหลายแค็ตตาล็อก

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

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

POST $BASE_URL/v1/catalogs HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "catalogs": [
        {
            "name": "Retailer A"
        },
        {
            "name": "Retailer B"
        }
    ]
}

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

การตอบสนองเป็นไปตามรูปแบบ JSON มาตรฐานและส่งคืนรายละเอียดต่อไปนี้ในอาร์เรย์ แต่ละแค็ตตาล็อกจะมีข้อมูลตัวเอง ได้แก่ teamid, nameและ id:

  • teamId: ID ของทีมที่เชื่อมโยงกับแค็ตตาล็อก
  • name: ชื่อของแค็ตตาล็อก
  • id: ตัวระบุที่ไม่ซ้ำกันสำหรับแค็ตตาล็อก ID นี้จำเป็นสำหรับการดำเนินการเพิ่มเติม เช่น เมื่อเพิ่มรายละเอียดผลิตภัณฑ์ของคุณลงในแค็ตตาล็อก
{
    "catalogs": [
        {
            "teamId": "9f48572c-0a5b-4997-9a0e-ed74f4d32dc6",
            "name": "Retailer A",
            "id": "216af452-d219-4807-b8ca-578bba446541"
        },
        {
            "teamId": "9f48572c-0a5b-4997-9a0e-ed74f4d32dc6",
            "name": "Retailer B",
            "id": "75047339-65f5-41b8-8f2c-e76b04716cd4"
        }
    ]
}

สร้างหลายแค็ตตาล็อกต่อผู้ค้าปลีก

วิธีจัดการหลายแค็ตตาล็อก

  • สร้างทีมผู้ค้าปลีก 'ย่อย' แยกกันสำหรับแต่ละแค็ตตาล็อก และทีมผู้ค้าปลีก 'หลัก' ทีมเดียว
  • ตั้งค่าความสัมพันธ์แม่/ลูกระหว่างทีมแม่กับทีมลูกแต่ละทีม โดยตรวจดูให้แน่ใจว่าทีมแม่เชื่อมโยงกับทีมลูกทั้งหมดอย่างถูกต้อง
  • หลังจากตั้งค่าทีมแม่แล้ว ให้อัปเดตมาตรฐานเนื้อหาสำหรับทีมลูกทั้งหมดเพื่อเชื่อมโยงกับทีมแม่ ติดต่อวิศวกรบูรณาการลูกค้า (CIE) ของคุณเพื่อดำเนินการนี้

เมื่อสร้างหลายแค็ตตาล็อกสำหรับผู้ค้าปลีก โปรดพิจารณาประเด็นต่อไปนี้:

  • ความสัมพันธ์แบบตัวต่อตัว: การตั้งค่าที่ปลอดภัยที่สุดคือการมีความสัมพันธ์แบบตัวต่อตัวระหว่างแค็ตตาล็อกและทีมผู้ค้าปลีก แม้ว่าจะไม่จำเป็นอย่างเข้มงวด แต่ก็ช่วยหลีกเลี่ยงปัญหาสับสนได้

  • โครงสร้างตัวอย่าง: ในแผนภาพต่อไปนี้ ทีมแม่จะซ้อนอยู่ภายในเนมสเปซของผู้ค้าปลีก แต่ละทีมลูก (A, B, C) มีแค็ตตาล็อกที่เกี่ยวข้องของตัวเอง (A, B, C) โครงสร้างนี้ช่วยให้แน่ใจว่าการซื้อได้รับการระบุแหล่งที่มาอย่างถูกต้องไปยังแค็ตตาล็อกที่เกี่ยวข้องตามคีย์ API ของทีมที่ใช้ในการยืนยันการสั่งซื้อ

  • หลายแค็ตตาล็อกภายใต้ทีมเดียว: คุณสามารถสร้างหลายแค็ตตาล็อกภายใต้ทีมผู้ค้าปลีกเดียวกัน อย่างไรก็ตาม โปรดตรวจสอบให้แน่ใจว่า SKU และ SessionID ไม่ได้ถูกแชร์กันในแค็ตตาล็อกเหล่านี้ เพื่อรักษาการระบุแหล่งที่มาที่ถูกต้อง รวมถึง catalogId ในการเรียก API การสั่งช่วยในการแยกแยะแค็ตตาล็อกและป้องกันข้อผิดพลาดการระบุแหล่งที่มา สำหรับข้อมูลเพิ่มเติม โปรดดูการซิงค์ข้อมูลการสั่งซื้อผ่าน API

  • ปัญหาการระบุแหล่งที่มา: การแบ่งปัน SKU และ session IDs ข้ามแค็ตตาล็อกอาจทำให้เกิดปัญหาการระบุแหล่งที่มา ตัวอย่างเช่น หากคุณมีเว็บไซต์ที่ใช้ภาษา 2 ภาษา (เช่น ES และ FR) โดยมีทีมผู้ค้าปลีก 1 ทีมที่เชื่อมโยงกับแค็ตตาล็อก 2 รายการ (รายการละ 1 ภาษา) และ SKU ที่ใช้ร่วมกัน ผู้ใช้ที่ระบุตัวตนด้วยภาษาเดียวกัน sessionID ในทั้งสองเวอร์ชันอาจส่งผลให้การซื้อในเว็บไซต์ ES นั้นมาจากไซต์ FR และในทางกลับกัน รวมถึง catalogId ในคำสั่งซื้อ การเรียก API จะช่วยแก้ไขปัญหานี้ โดยทำให้แน่ใจว่าการระบุแหล่งที่มาได้รับการกำหนดอย่างถูกต้องให้กับแค็ตตาล็อกที่เกี่ยวข้อง สำหรับข้อมูลเพิ่มเติม โปรดดูการซิงค์ข้อมูลการสั่งซื้อผ่าน API

ที่อัปเดต 4 เดือนที่แล้ว