1단계: 제품 카탈로그 생성

첫 번째 단계는 제품 카탈로그를 만드는 것입니다. 카탈로그에는 제품 광고를 실행하는 데 필요한 제품 세부 정보가 포함되어 있습니다.

  • 한 번의 요청으로 하나 또는 여러 개의 카탈로그를 만들 수 있습니다. 여러 카탈로그를 생성하는 경우 요청당 최대 100개의 카탈로그를 순서대로 배열할 수 있습니다.
  • 카탈로그 생성 시 catalogId 가 반환됩니다. 이 catalogId 는 카탈로그에 제품의 세부 정보 추가 시 필요하며 카탈로그의 고유 식별자 역할을 합니다.
  • 이 문서에 설명된 대로 API를 사용하여 카탈로그를 만들 수 없는 경우 고객 통합 엔지니어(CIE)에게 문의하시면 귀하를 대신하여 카탈로그를 생성해 드립니다.
  • 생성된 카탈로그는 기본적으로 숨겨져 있으므로 네임스페이스에 표시되도록 하려면 CIE에 문의해야 합니다.

사전 필수 조건

카탈로그 생성을 요청하려면 API 키 및 기본 URL이 있어야 합니다.

  1. 유효한 API 키가 있어야 합니다. 다음에 따라 API 키를 가져올 수 있습니다.

    1. Epsilon Retail Media 팀 계정에 로그인합니다.

    2. 페이지 오른쪽 상단으로 이동하여 드롭다운 메뉴를 클릭합니다.

    3. 드롭다운 메뉴에서 통합 설정을 선택합니다.

    4. API 키 탭을 클릭합니다. 초기 상태에는 비밀 API 키가 숨겨져 있습니다. 표시 버튼을 클릭하면 확인할 수 있습니다. 클릭 후 비밀 API 키를 복사합니다. API 호출 시 이 키를 사용합니다.

  2. API 엔드포인트의 기본 URL이 있어야 합니다. (예: 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)에게 문의하세요.

소매업체에 대한 여러 개의 카탈로그를 생성할 시에는 다음 사항을 고려해야 합니다.

  • 일대일 관계: 가장 안전한 설정은 카탈로그와 소매업체 팀 간에 1:1 관계를 맺는 것입니다. 반드시 필요한 것은 아니지만 오류를 방지하는 데 도움이 됩니다.

  • 구조 예: 다음 다이어그램에서 상위 팀은 소매업체의 네임스페이스 내에 중첩되어 있고 각 하위 팀(A, B, C)은 자체 카탈로그(A, B, C)를 갖습니다. 이 구조는 주문 확인에 사용된 팀의 API 키를 기반으로 구매가 각 카탈로그에 올바르게 어트리뷰션되도록 합니다.

  • 한 팀 내 여러 카탈로그 생성: 동일한 소매업체 팀에서 여러 카탈로그를 생성할 수 있습니다. 그러나 올바른 어트리뷰션을 유지하기 위해 해당 카탈로그에서 SKU와 SessionID가 공유되지 않도록 해야 합니다 . catalogId 를 API 호출에 포함하면 카탈로그를 구분하는 데 도움이 되며 어트리뷰션 오류를 방지할 수 있습니다. 자세한 내용은 API를 통한 주문 데이터 동기화를 참조하세요.

  • 어트리뷰션 문제: SKU와 session IDs 를 공유하게 되면 어트리뷰션 문제가 발생할 수 있습니다. 예를 들어 두 개의 언어(ES 및 FR 등)로 된 웹사이트가 있고 한 소매업체 팀의 두 개의 카탈로그(언어당 하나씩)가 SKU를 공유하는 경우 두 버전 모두에서 동일한 sessionID 로 사용자가 식별되어 ES 사이트에서의 구매가 FR 사이트에 어트리뷰션되거나 그 반대의 경우가 발생할 수 있습니다. API 호출에 catalogId 를 포함하면 각 카탈로그에 올바르게 어트리뷰션이 할당되도록 하여 이 문제를 해결할 수 있습니다. 자세한 내용은 API를 통한 주문 데이터 동기화를 참조하세요.