파트너 API

브랜드 페이지 요청

브랜드 페이지 엔드포인트

브랜드 페이지 플랫폼은 독립형 URL 및 광고 생성 엔드포인트 경로를 사용합니다. 기술 계정 관리자가 샌드박스 및 프로덕션 환경에 대한 기본 URL을 제공합니다.

인증

브랜드 페이지 도구 인증은 전달자 인증을 사용합니다. 기술 계정 관리자가 샌드박스 및 프로덕션 환경에 대한 전달자 토큰을 제공할 수 있습니다.

헤더에 다음과 같이 토큰을 보내야 합니다: header 'Authorization: Bearer ${apiKey}

요청

브랜드 페이지를 요청하려면 요청하는 URL과 함께 CitrusAd의 brand-page엔드포인트로 GET 요청을 전송합니다.

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

🚧

URL 쿼리 매개 변수 삭제

광고 요청 시 CitrusAD에 전송된 매개 변수에서 사이트와 관련된 모든 쿼리 매개 변수를 삭제해야 합니다.

CitrusAd는 CitrusAd 플랫폼 내에서 이 URL을 사용하여 요청된 정확한 페이지 URL을 가져옵니다 . https\:www.retailer.com/brand/lollipops-brand와 일치하지만 추가 쿼리 매개 변수가 지정된 경우에는 일치하지 않습니다.

응답

브랜드 페이지 구성에 따라 세그먼트 응답은 통합된 세그먼트와 브랜드 페이지의 템플릿으로 인해 달라집니다.

사용자 지정 기능을 검토하려면 고급 구조 페이지를 참조하십시오.

응답 구성 요소

컨테이너

컨테이너는 전체 브랜드 페이지 응답에 대한 정보를 제공하며, 또한 세그먼트 응답이 유지되는 개체의 데이터 배열을 포함합니다.

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

다음 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는 이름, 가격 및 이미지 등 제품 속성을 제공하지 않습니다. 이 정보는 소매업체 인프라의 내부 제품 정보 서버(또는 이와 유사한 서버)에서 가져와야 합니다.

이는 추가적인 통합 작업이지만 가격 정보를 업데이트하거나 변경 시 특별 프로모션, 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",
    }
  ]
}

다른 템플릿과 예시를 보고 싶으신가요? 브랜드 페이지 템플릿 예시 보기