Reporting API

Reporting API를 사용하면 판매자가 판매자 센터 쿼리 언어를 통해 프로그래매틱 방식으로 실적 데이터와 상호작용할 수 있습니다. 이는 판매자 센터에서 직접 맞춤 보고서를 만드는 기능과 유사합니다. Reporting API에는 다음과 같은 이점이 있습니다.

• 대규모 판매자가 제품 등록정보의 실적 데이터를 내부 또는 서드 파티 보고 시스템으로 가져올 수 있습니다.
• 판매자 센터 계정을 관리하는 사용자, 서드 파티 파트너, 애그리게이터가 보고서에 액세스할 수 있도록 지원합니다.

API 사용자는 검색 호출 응답에서 검색할 실적 데이터를 지정할 수 있습니다. 예를 들면 다음과 같습니다.

• 반환할 측정항목 (예: 클릭수, 노출수)
• 데이터를 분류할 측정기준 (예: OfferId, Date)
• 충족해야 하는 조건 (예: 클릭수 > 100)

Reporting API 쿼리 언어는 Reports 서비스에서 Search 메서드를 사용하여 다양한 측정기준 (프로그램, 날짜와 같은 보고된 이벤트 속성, 브랜드, 카테고리와 같은 제품 속성)으로 분류될 수 있는 Content API for Shopping의 실적 측정항목 (클릭수, 노출수)을 쿼리할 수 있습니다.

Reports 서비스에 대한 쿼리의 결과는 ReportRow 인스턴스 목록이며, 각 ReportRow는 쿼리에서 지정한 세그먼트에 대한 요청된 측정항목의 값을 나타냅니다. 세그먼트를 지정하지 않으면 모든 세그먼트에서 집계된 측정항목이 포함된 단일 행이 반환됩니다. 그렇지 않고 측정항목과 함께 세그먼트가 요청되면 응답에 고유한 세그먼트 튜플마다 하나의 행이 표시됩니다. 단일 쿼리에서 여러 세그먼트와 여러 측정항목을 선택할 수 있습니다.

측정항목 쿼리

반환할 측정항목 (클릭수, 노출수, CTR 등)을 쿼리할 수 있습니다. 보고서 서비스를 쿼리하려면 기간에 필터를 추가해야 합니다. 아래 샘플 쿼리는 날짜 범위의 추가된 조건 내 클릭수의 집계 금액인 단일 행을 반환합니다.

SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';

샘플 응답

아래 샘플 JSON 코드 응답은 이 판매자가 2020년 12월 1일부터 2020년 12월 21일까지 모든 대상의 모든 제품에서 총 4,440회의 클릭을 기록했음을 보여줍니다.

{"results": [
    {
      "metrics": {
        "clicks": "4,440"
      }
    }
]}

세그먼트 쿼리

측정항목과 함께 세그먼트를 쿼리할 수도 있습니다. 세그먼트는 제품의 속성 (offer_id, brand, category 등) 또는 보고된 이벤트의 속성 (date, program)일 수 있습니다. 보고된 이벤트는 제품의 노출 또는 클릭입니다.

세그먼트는 SQL의 GROUP BY와 유사하게 작동합니다. 세그먼트는 선택한 측정항목을 분할하여 SELECT 절의 각 세그먼트별로 그룹화합니다. 아래 샘플 쿼리는 기간이라는 추가 조건 내에서 클릭수 내림차순으로 정렬된 일별 클릭수를 반환합니다. 요청된 측정항목 중 하나 이상이 0이 아닌 행만 반환됩니다.

SELECT
  segments.date,
  metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;

샘플 응답

아래 샘플 JSON 코드 응답은 이 판매자가 2020년 12월 1일에 모든 대상 유형의 모든 제품에서 1,546회의 클릭을 기록했고 2020년 12월 2일에 모든 대상 유형의 모든 제품에서 829회의 클릭을 기록했음을 보여줍니다. 판매자가 2020년 12월 3일에 클릭이 없었으므로 해당 날짜에 대한 객체는 반환되지 않습니다.

{
  "results": [
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        }
      },
      "metrics": {
        "clicks": "1546"
      }
    },
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        }
      },
      "metrics": {
        "clicks": "829"
      }
    }
]}