목차
리셀러를 위한 Criteo REST API
아래는 셀러 레벨에서 캠페인 입찰과 예산을 관리할 수 있도록 해주는 Criteo 리셀러 프로그램 REST API의 핵심적인 컨셉에 대한 설명입니다.
API 인증Criteo는 JWT를 사용하여 REST API에 토큰 기반의 인증 시스템을 제공합니다. API로 호출을 보내려면 이러한 호출 중 하나에 토큰을 전달해 주어야 합니다.
토큰을 받으려면 client_id와 client secret을 파라미터로 사용하여 /oauth2/token 엔드포인트로 POST 호출을 보내야 합니다. (시작하기 섹션 참조)
AdvertiserID 조회AdvertiserID는 /portfolio/ 엔드포인트로 GET 호출을 보내어 조회합니다.
CampaignID는 /sellers/endpoint로 GET 호출을 보내어 조회합니다.
새로운 셀러를 추가하려면, 이전에 Criteo에 보내 주셨던 제품 Feed 카탈로그에 해당 셀러가 올바른 플래그로 표시되어 있어야 합니다.
해당 셀러의 플래그 표시가 올바른지 확인하려면, Feed에 나와 있는 셀러의 각 제품별로 셀러 이름 열을 셀러의 고유 ID로 설정해야 합니다.
위의 단계를 마치고 나면, 앞서 설명한 다음의 셀러 엔드포인트를 이용하여 해당 셀러의 예산을 Criteo에 보낼 수 있게 됩니다.
- 셀러의 CPC를 보내려면 /v1/sellers/bids PUT 호출
- 셀러의 예산을 보내려면 /v1/sellers/budgets POST 호출
Criteo 리셀러 프로그램에서 셀러 데이터 삭제
Criteo 리셀러 프로그램에서 셀러를 제거하려면, 해당 셀러를 캠페인에서 중단시키기만 하면 됩니다. ("셀러를 중지시키는 방법" 섹션 참고)
또는 제품 Feed에서 셀러의 제품들을 삭제할 수도 있습니다. 그러나 이 경우는 Criteo가 Feed & 카테고리를 접수한 후에만 발효됩니다. 뿐만 아니라, 새로운 피드와 카테고리 접수도 필요하기 때문에 다시 추가하려면 시간이 더 걸릴 수 있습니다. 마지막으로, Feed에서 셀러를 제거하면, 해당 셀러에 대한 통계 정보는 더 이상 제공되지 않습니다.
캠페인 시작하기Criteo 리셀러 프로그램 캠페인을 시작하려면, 이 프로그램에 포함된 모든 셀러의 제품이 들어 있는 전용 제품 Feed를 보내 주셔야 합니다. 참고: 각 제품은 셀러 필드에 해당 셀러의 고유 ID가 나와 있어야 합니다.
피드가 접수되는 즉시 캠페인이 자동으로 생성됩니다.
실제로 집행을 하려면, 예산과 CPC가 이미 설정되어 있는 셀러가 하나 이상 있어야 합니다. /v1/sellers/bids 엔드포인트로의 PUT 호출과 /v1/sellers /budgets 엔드포인트로의 POST 호출을 통해 보낼 수 있습니다.
캠페인에 포함된 1명 이상의 셀러를 중단하려면, 해당 셀러의 예산을 "비활성(Inactive)"으로 설정해야 합니다. 셀러의 예산이 비활성으로 설정되면, 시스템은 이 셀러의 제품 광고를 더 이상 표시하지 않습니다.
예산을 비활성으로 설정하려면 아래와 같이 /sellers/budgets 엔드포인트로 PUT 호출을 보내야 합니다.
- PUT /sellers/budgets with status = Inactive
아무런 조치를 취하지 않아도 됩니다. Criteo는 모든 셀러의 예산 고갈을 예측했다가, 예산이 다 떨어지는 경우 캠페인을 중단합니다.
예산 및 CPC 설정특정 셀러의 예산 및 CPC를 설정하려면, 다음 엔드포인트를 사용해야 합니다.
- 입찰: 초기화 및 업데이트: /sellers/bids 엔드포인트로 PUT 호출 발행
- 예산:
- 초기화: /v1/sellers/budgets 엔드포인트로 POST 호출 발행
- 예산 업데이터: /v1/sellers/budgets 엔드포인트로 PUT 호출 발행
특정 셀러의 예산과 CPC를 늘리려면, /v1/sellers/budgets와 /v1/sellers/bids 엔드포인트로 PUT 호출을 보내야 합니다.
CPC 삭감셀러가 CPC 삭감을 원하는 경우, /v1/sellers/bids 엔드포인트로 POST 호출을 보내야 합니다.
예산 삭감셀러가 예산 삭감을 원하는 경우, 현재 상태를 비활성(Inactive)으로 설정해야 합니다. 그러면, 설정한 날(D)부터 현재 예산이 표시되지 않습니다. 이후, 삭감된 금액으로 새로운 예산을 설정할 수 있습니다. ("새로운 예산 생성하는 방법" 섹션 참조) 이는 설정 다음날(D+1)부터 시작됩니다. (UTC 시간)
예:
제0일에 셀러 A가 Criteo 리셀러 프로그램 캠페인에 대한 예산 금액 1,000달러를 처음으로 설정했습니다.
제2일에 셀러 A는 예산 800달러가 있지만, 가용 예산을 500달러로 줄이기로 합니다.
그렇다면 다음과 같이 호출해야 합니다.
- /sellers/budgets/ 엔드포인트로 PUT 호출
- status 를 Inactive로 설정
- ( status 가 우선하므로 여기에 예산 금액을 정확히 입력할 필요는 없음)
- /sellers/budgets 엔드포인트로 POST 호출
- amount 를 500으로 설정
- ( status 를 입력할 필요 없음. 값을 비워 두면, Active로 간주됨)
다음 두가지 사례 중 하나에 해당되는 경우 새로운 예산을 생성할 수 있습니다.
- 당일 예산이 없음
- 당일에 비활성 상태의 예산이 있음
셀러의 새로운 예산을 생성하려면 다음이 필요합니다.
- /sellers/budgets 엔드포인트로 POST 호출
새로운 예산은 다음과 같이 발효됩니다.
- 당일 예산이 없는 경우 - 즉시
- 당일에 비활성 상태의 예산이 있는 경우 - 다음날
먼저 해당 셀러가 업데이트된 예산을 알려 주어야 합니다
그런 다음 세 가지 주요 시나리오에 따라 다른 조치를 취할 수 있습니다.
- 이미 새 예산이 있고, 그 예산이 설정된 초기 예산보다 작은 경우:
- 예산/CPC 삭감 방법 섹션에서 설명한 조치를 취합니다.
- 이미 새 예산이 있고, 그 예산이 설정된 초기 예산보다 큰 경우:
- "예산/CPC 증액 방법" 섹션에서 설명된 조치를 취합니다.
- 새 예산/적절한 예산이 없는 경우:
- 셀러 제거 방법 섹션에서 설명된 조치를 취합니다.
먼저 해당 셀러가 업데이트된 CPC를 알려 주어야 합니다. 그러면 sellers/bids/ 엔드포인트로 PUT 호출을 보내어 업데이트된 CPC를 설정합니다.
Criteo API는 기본적으로 sellerName을 사용하여 입찰 및 예산을 관리하기 때문에, 셀러 이름에 변경 사항이 있으면 Criteo 시스템에 이전의 셀러 이름과 별개의 새 항목이 자동으로 생성됩니다.
간단히 말해, 플랫폼에서 셀러의 이름이 바뀌면 다음을 수행해야 합니다.
- 새 sellerName으로 제품 Feed
- PUT /merchants/partners/bids 및 POST /merchants/partners/budgets 명령을 보내어 해당 셀러의 CPC 및 예산 초기화
Criteo 리셀러 프로그램 캠페인에서 담당 셀러가 지출한 예산을 확인하려면 /v1/sellers 엔드포인트로 GET 호출을 보냅니다. 이 정보는 spentAmount로 표시됩니다.
셀러의 예산 잔액 분석Criteo 리셀러 프로그램 캠페인에서 담당 셀러가 지출한 예산을 확인하려면 /v1/sellers 엔드포인트로 GET 호출을 보냅니다. 이 정보는 remainingAmount로 표시됩니다.
보고/v1/sellers/stats 엔드포인트로 POST 호출을 보내면 됩니다. 노출, 클릭 수 및 비용을 셀러 레벨에서 액세스하는 것만 가능하며, 정보는 일일 단위로 제공됩니다.
최대 3가지 지수를 사용할 수 있으며 셀러 지수가 포함되어야 합니다. 사용 가능한 지수: -> 최대 3가지 디멘션을 사용할 수 있으며 셀러 디멘션이 포함되어야 합니다.
사용 가능한 디멘션:
- AdvertiserID
- campaignID
- 셀러 – 필수
- 년
- 주
- 일
사용 가능한 측정치:
- 디스플레이 수
- 클릭 수
- AdvertiserCost