เอนพอยต์แบรนด์เพจ

แพลตฟอร์มแบรนด์เพจใช้ URL แบบสแตนด์อโลนและพาธไปยังเอนพอยต์การสร้างโฆษณา ผู้จัดการบัญชีด้านเทคนิคของคุณจะจัดเตรียม URL พื้นฐานของคุณสำหรับสภาพแวดล้อมแซนด์บ็อกซ์และการใช้งานจริง

การอนุญาต

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

คุณจะต้องส่งโทเค็นในส่วนหัวเป็น header 'Authorization: Bearer ${apiKey}

ขอร้อง

หากต้องการขอแบรนด์เพจ คุณต้องส่งคำขอ GET ไปที่เอนพอยต์ของ CitrusAd brand-pageด้วย URL ที่คุณกำลังร้องขอ

curl --location --request GET '${URL}/api/v1/brand-page:static?url=${url}&retailer=${retailer}' \
--header 'Authorization: Bearer ${apiKey}

🚧

ฆ่าเชื้อพารามิเตอร์การสืบค้น URL

เมื่อร้องขอโฆษณา คุณจะต้องลบพารามิเตอร์การสืบค้นใด ๆ ที่เกี่ยวข้องกับเว็บไซต์ของคุณออกจากพารามิเตอร์ที่ส่งไปยัง CitrusAd

ภายในแพลตฟอร์ม CitrusAd เราใช้ URL นี้เพื่อดึง URL ของเพจที่ร้องขอ เราจะจับคู่ https\:www.retailer.com/brand/lollipops-brandแต่ไม่ใช่หากมีการระบุพารามิเตอร์การสืบค้นเพิ่มเติม

การตอบสนอง

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

หากคุณต้องการตรวจสอบความสามารถในการกำหนดเอง ให้ตรวจสอบหน้า โครงสร้างระดับสูง

คอมโพเนนต์การตอบสนอง

คอนเทนเนอร์

คอนเทนเนอร์แสดงข้อมูลสำหรับการตอบสนองแบรนด์เพจทั้งหมด และยังมีอาร์เรย์ข้อมูลของออบเจกต์ ซึ่งมีการเก็บการตอบสนองของเซ็กเมนต์ไว้

{
  "id": "string",
  "brandPageId": "string",
  "brandPageTemplateId": "string",
  "data": [
  ]
}

AD_ID data อาร์เรย์จะถูกเติมด้วยเซ็กเมนต์ต่าง ๆ ขึ้นอยู่กับการกำหนดค่าของแบรนด์เพจ รูปแบบเซ็กเมนต์มีรายละเอียดด้านล่าง

เซ็กเมนต์

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

เซ็กเมนต์แบนเนอร์

ภายใน data อาร์เรย์ แต่ละเซ็กเมนต์เป็นออบเจกต์ ดังตัวอย่างด้านล่าง:

📘

แอตทริบิวต์เฉพาะของแบนเนอร์ x ในการตอบกลับเป็นเพียงตัวอย่างเท่านั้น ค่าในการตอบกลับได้รับการกำหนดค่าตามเทมเพลตและสามารถปรับแต่งได้ เช่น backgroundImage, brandLogoหรือตามที่คุณต้องการ

 {
        "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"
}

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับความเป็นไปได้ของเซ็กเมนต์แบนเนอร์ โปรดดู โครงสร้างระดับสูง

เซ็กเมนต์คอนเทนต์

ภายใน data อาร์เรย์ แต่ละเซ็กเมนต์เป็นออบเจกต์ ดังตัวอย่างด้านล่าง:

📘

heroText,heroTextColourและ heroSubText เป็นตัวอย่างสำหรับผู้ค้าปลีกตัวอย่างของเรา แต่ละฟิลด์สามารถตั้งชื่อตามประเภทฟิลด์ที่เกี่ยวข้องของคุณ เช่น 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>",
}

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับสิ่งที่เป็นไปได้กับเซ็กเมนต์คอนเทนต์ โปรดดู โครงสร้างระดับสูง

เซ็กเมนต์ผลิตภัณฑ์

ภายใน data อาร์เรย์ แต่ละเซ็กเมนต์เป็นออบเจกต์ ดังตัวอย่างด้านล่าง:

📘

รูปแบบการตอบกลับนี้ได้รับการแก้ไขแล้วและไม่ต้องปรับแต่ง

 {
      "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"
        }
      ]
    }

📘

ข้อมูลผลิตภัณฑ์

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

แม้ว่านี่จะเป็นความพยายามในการผสานรวมเพิ่มเติม แต่ก็มั่นใจได้ว่าจะไม่มีการพึ่งพา Citrus เมื่ออัปเดตและเปลี่ยนแปลงข้อมูลราคา รวมถึงกราฟิกอัตโนมัติใด ๆ เช่นพิเศษ ลด 20% หรือคอนเทนต์ที่คล้ายกันขึ้นอยู่กับ CitrusAd

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับสิ่งที่เป็นไปได้กับเซ็กเมนต์ผลิตภัณฑ์ โปรดดู โครงสร้างระดับสูง

การตีความการตอบสนอง

ในการตอบสนองแต่ละเซ็กเมนต์มี id และ nameสิ่งเหล่านี้จะไม่ซ้ำกับเซ็กเมนต์ภายในเทมเพลต คุณสามารถใช้สิ่งเหล่านี้เพื่อระบุส่วนประกอบประเภทต่าง ๆ เช่น ประเภทแบนเนอร์ หรือประเภทคอนเทนต์ และจัดตำแหน่งให้ตรงกับตำแหน่งที่คุณฉีดเข้าไป

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

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

📘

CUSTOM_ID_N เป็นตัวอย่างสำหรับ ID ที่ผู้ค้าปลีกกำหนด เช่น paragraphText.

การตอบสนอง

{
  "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",
    }
  ]
}

สนใจดูเทมเพลตและตัวอย่างอื่น ๆ ใช่ไหม ดู ตัวอย่างเทมเพลตแบรนด์เพจ