Singular 보고 API 시작하기

문서

내부 BI 시스템이나 마케팅 성과 대시보드에 수집할 수 있는 마케팅 캠페인에 대한 집계된 통계를 제공하는 Singular의 리포팅 API에 오신 것을 환영합니다.

이 가이드에서는 Singular 보고 API에 대해 설명하고, 사용 사례를 이해하는 방법과 쿼리 실행을 시작하는 방법을 설명합니다.

이 가이드를 먼저 읽은 다음, 기술적 세부 사항은리포팅API 참조를검토하세요.

다른 API를 찾고 계신가요?

아니면 다른 기능이 필요하신가요?

  • Singular는 데이터를 데이터베이스나 BI 플랫폼으로 정기적으로 내보낼 수 있는 간편한 방법을 제공하는 프리미엄 서비스인 Singular 데이터 대상(ETL)도 제공합니다.
  • 보고 API는 집계된 데이터만 제공합니다. Singular 어트리뷰션 서비스에서 사용자 레벨 데이터를 내보내려면 로그 및 사용자 레벨 데이터 내보내기 FAQ를 참조하세요.

시작하기: 사용 사례 이해하기

Singular는 다양한 출처에서 데이터를 수집하고 종합합니다(자세한 내용은 Singular 리포팅 데이터 이해를 읽어보시기 바랍니다).

리포팅 API를 사용할 때 표시할 데이터를 선택할 수 있습니다:

  • 캠페인 비용과 같은 파트너 광고 네트워크 및 대행사의 집계 데이터;
  • 어트리뷰션 트래커/MMP의 집계 데이터(필요에 따라 BI 시스템으로 수집하고 네트워크 데이터에 조인할 수 있음);
  • 또는 네트워크와 트래커 데이터를 Singular가 스마트하게 조인한 결과물인 결합 데이터를 통해 가능한 가장 세분화된 단위로 ROI를 분석할 수 있습니다.

모든 쿼리는 동일한 엔드포인트(비동기 보고서 만들기)를 통해 실행되지만, 쿼리에 포함하는 필드는 다릅니다.

시작하려면 API에서 얻고자 하는 것이 무엇인지 파악하세요:

사용 사례를 파악하세요:

를 참조하세요:

  • Singular를 사용하여 모든 광고 네트워크와 에이전시로부터 캠페인 데이터를 수집합니다.
  • 비용과 실행률에 대한 데이터를 얻고자 합니다.

네트워크 데이터 쿼리하기

  • Singular 어트리뷰션 서비스를 사용하거나 타사 어트리뷰션 트래커를 위한 데이터 커넥터를 설정한 경우.
  • 전환 및 매출과 같은 트래커 데이터를 가져와서 BI 플랫폼이나 분석을 위해 수집하려고 합니다.
  • 트래커 데이터를 애드 네트워크 데이터(예: 캠페인 비용)에 조인하여 ROAS를 계산하려는 경우, 자체 도구를 사용하여 이를 수행할 계획입니다.

트래커 데이터와 네트워크 데이터를 개별적으로 쿼리하기

  • Singular 어트리뷰션 서비스를 사용하거나 타사 어트리뷰션 트래커를 위한 데이터 커넥터를 설정한 경우.
  • 네트워크 데이터와 트래커 데이터를 최대한 세분화하여 결합하기 위해 Singular의 기성 로직을 활용하고자합니다 .

결합된 데이터 쿼리하기

리포팅 API를 통해 사용할 수 있는 데이터 유형

네트워크 데이터 쿼리

네트워크 데이터에는 Singular에서 설정한 모든 광고 네트워크에서 수집한 캠페인 통계가 포함됩니다. 어트리뷰션 트래커의 데이터는 포함되지 않습니다(Singular에서 설정한 경우).

예를 들어, 쿼리를 실행하여 특정 날짜 범위의 각 캠페인(adn_campaign_id)에 대한 비용(adn_cost)을 확인할 수 있습니다.

Screen_Shot_2020-07-01_at_0.14.09.png

네트워크 데이터에 사용 가능한 필드

각 필드에 대한 설명은 지표 및 측정기준 페이지를 참조하세요.

네트워크 기준

기본 기준(모든 네트워크에서 사용할 수 있어야 함):

  • source
  • adn_campaign_id
  • adn_campaign_name
  • adn_campaign_url
  • 데이터_커넥터_ID
  • 데이터_커넥터_소스_이름
  • 데이터_커넥터_사용자명
  • 데이터_커넥터_타임스탬프_유티씨

선택적 추가 기준(지원 여부는 네트워크에 따라 다름):

  • os
  • 플랫폼
  • 국가_필드
  • 지역_필드
  • city_field
  • dma_id_field
  • dma_이름_필드
  • adn_sub_adnetwork_name
  • adn_account_id
  • adn_account_name
  • ADN_SUB_CAMPAIGN_ID
  • adn_sub_캠페인_이름

키워드 및/또는 퍼블리셔 분류(네트워크에 따라 지원 여부가 다르며, 크리에이티브 분류와 동일한 쿼리로 가져올 수 없음):

  • keyword_id
  • 키워드
  • publisher_id
  • 퍼블리셔_사이트_ID
  • 퍼블리셔_사이트_이름

크리에이티브 분류(네트워크에 따라 지원 여부가 다르며, 일반적으로 키워드/퍼블리셔와 동일한 쿼리로 가져올 수 없음):

  • 크리에이티브_유형
  • adn_creative_id
  • adn_크리에이티브_이름
  • creative_url
  • 크리에이티브_이미지
  • 크리에이티브_텍스트
  • creative_width
  • creative_height
  • creative_is_video
  • asset_id
  • asset_name

캠페인 속성(자세히 알아보기):

  • 입찰 유형
  • 입찰_전략
  • bid_amount
  • 캠페인_목적
  • 표준화된_입찰 유형
  • 표준화_입찰_전략
  • original_bid_amount
  • 캠페인_상태
  • min_roas
  • original_metadata_currency

사용자 지정 기준:

이러한 기본 네트워크 기준을 기반으로 사용자 지정 기준을 정의한 경우, 해당 ID를 사용하여 해당 기준을 가져올 수 있습니다. 사용자 지정 측정기준 엔드포인트를 사용하여 계정에 정의된 모든 사용자 지정 측정기준과 해당 ID를 가져올 수 있습니다.

네트워크 메트릭
  • adn_cost
  • adn_original_cost
  • adn_original_currency
  • adn_impressions
  • adn_clicks
  • adn_installs

참고:

  • Singular는 가능한 가장 높은 수준의 세분성을 제공하려고 노력하지만 모든 네트워크가 모든 기준을 제공하는 것은 아닙니다. Singular가 각 소스에서 가져오는 데이터에 대한 자세한 내용은 데이터 커넥터 상세 정보를 참조하세요.
  • 광고 네트워크에서 보고하는 노출, 클릭, 인스톨 등의 통계는 어트리뷰션 트래커에서 보고하는 통계와 일치하지 않을 수 있습니다.

트래커 데이터와 네트워크 데이터를 개별적으로 쿼리하기

API를 사용하여 Singular의 어트리뷰션 서비스 또는 Singular에서 설정한 타사 어트리뷰션 트래커(예: 앱스플라이어 또는 구글 애널리틱스)의 통계 등 트래커 데이터를 가져올 수 있습니다.

예를 들어, 쿼리를 실행하여 특정 날짜 범위의 각 캠페인(tracker_campaign_id)에 대한 클릭 수(tracker_clicks) 및 인스톨 수(tracker_installs)를 확인할 수 있습니다. 트래커 통계에는 인스톨 후 이벤트와 구매도 포함됩니다.

Screen_Shot_2020-07-01_at_0.15.21.png

트래커 데이터에 대한 쿼리를 실행한 후 이를 네트워크 데이터에 결합하여 캠페인 CPI 또는 ROI를 계산할 수 있습니다.

그러나 일반적으로 결합된 보고서를 실행하는 것이 동일한 결과를 얻는 더 쉬운 방법입니다.

트래커 데이터에 사용 가능한 필드

각 필드에 대한 설명은 지표 및 측정기준 페이지를 참조하세요.

트래커 기준

기본 기준(모든 네트워크에서 사용할 수 있어야 함):

  • source
  • 트래커_캠페인_ID

선택적 추가 기준(트래커에 따라 지원 여부가 달라짐):

  • 트래커_캠페인_이름
  • os
  • 플랫폼
  • 국가_필드

사용자 지정 기준:

이러한 기본 트래커 기준을 기반으로 사용자 지정 기준을 정의한 경우, 해당 ID를 사용하여 해당 기준을 가져올 수 있습니다. 사용자 지정 기준 엔드포인트를 사용하여 계정에 정의된 모든 사용자 지정 기준과 해당 ID를 가져올 수 있습니다.

트래커 메트릭

기본 지표:

  • 트래커_임프레션
  • tracker_clicks
  • tracker_installs
  • tracker_conversions
  • tracker_reengagements
  • daily_active_users

코호트 지표:

  • revenue
  • original_revenue

사용할 수 있는 코호트 지표의 전체 목록은 코호트 지표 엔드포인트를 참조하세요. 자세한 내용은 코호트 지표란 무엇인가요?

코호트 지표에는 CPE 및 CPI와 같은 비율 기반 계산이 포함된다는 점에 유의하세요. API 보고서에서는 이러한 지표를 사용하지 않는 것이 좋습니다(자세히 알아보기).

이벤트:

정의한 모든 이벤트에 대한 통계를 가져올 수 있습니다. 단, Singular 앱에 정의된 이벤트 이름을 사용하는 대신 코호트 지표 엔드포인트에서 얻을 수 있는 이벤트의 자동 생성 ID를 사용해야 한다는 점에 유의하세요.

결합된 데이터 쿼리하기

API를 사용하여 캠페인 비용과 구매 또는 기타 캠페인 성과 KPI를 모두 표시하는 결합된 네트워크 및 트래커 쿼리를 실행할 수 있습니다.

이러한 유형의 쿼리는 트래커 및 네트워크 데이터를 기반으로 하지만 아래에 자세히 설명된 것처럼 백그라운드에서 추가 로직을 포함하는 특수 기준 및 지표를 사용합니다.

Screen_Shot_2020-07-01_at_0.16.14.png

결합 쿼리의 기능은 무엇인가요?

  1. 동일한 쿼리에 네트워크 통계(예: 비용)와 트래커 통계(예: 설치 수 및 매출)를 모두 포함합니다.
  2. 스마트 기준은 가능한 경우 네트워크 데이터와 트래커 데이터를 동일한 행에 결합하는 데 도움이 됩니다.

    Singular의 "결합" 또는 "연동" 기준은 네트워크와 트래커 데이터를 모두 기반으로 합니다. 이러한 데이터는 Singular에서 처리되어 일반적인 데이터 불일치를 수정하고 가능한 한 가장 세분화된 결합 데이터를 볼 수 있도록 합니다.

    예를 들어, 트래커에 있는 특정 캠페인의 이름은 애드 네트워크에서 가져온 캠페인의 이름과 약간 다를 수 있습니다. 따라서 트래커 보고서와 네트워크 보고서를 실행하고 결과를 합치면 캠페인에 대해 한 행에는 네트워크 통계가, 다른 행에는 트래커 통계가 있는 분할된 행이 표시될 수 있습니다. 하지만 연동 보고서를 실행하는 경우(unified_campaign_name 기준 사용), Singular는 캠페인에 대해 네트워크 통계와 트래커 통계를 동일한 행에서 모두 확인할 수 있도록 합니다.

  3. 스마트하고 사용자 지정 가능한 지표는 각각의 경우에 적합한 소스에서 데이터를 가져옵니다.

    네트워크와 트래커 모두에서 동일한 통계를 제공하는 경우(예: 특정 날짜 범위의 캠페인당 설치 수), 연동 지표는 표준 업계 사용량에 따라 트래커 통계 또는 네트워크 통계를 지능적으로 선택하여 신뢰할 수 있는 Singular 소스를 제공합니다.

    예를 들어, Facebook이나 트위터와 같은 자체 할당 네트워크(SAN)가 아닌 경우 네트워크 통계가 더 중요하며, 이 경우 custom_installs에는 트래커의 설치 수가 포함되며, custom_installs에는 네트워크 지표가 포함됩니다.

    Singular의 기본 선택 항목이 특정 사례에 적합하지 않은 경우, Singular에서 특정 지표를 재구성하도록 할 수 있습니다.

    참고: 크리에이티브 분류에는 사용자 지정 지표를 사용할 수 없습니다. 네트워크 지표 또는 트래커 지표를 선택합니다.

내 지표의 출처를 알고 싶으면 어떻게 해야 하나요?

예를 들어 네트워크와 트래커 간의 심각한 불일치를 찾아 문제를 해결하려는 경우 각 캠페인에 대한 각 지표의 정확한 출처를 알고 싶을 수 있습니다.

이 경우 네트워크 지표( 네트워크 데이터의 사용 가능한 필드 참조)와 트래커 지표( 트래커 데이터의 사용 가능한 필드 참조)를 연동 보고서에 추가할 수 있습니다. 예를 들어 custom_installs, adn_installs, tracker_installs의 세 가지 설치 지표를 모두 가져옵니다.

이렇게 하면 custom_installs를 KPI로 사용하면서도 adn_installs와 tracker_installs 간에 유의미한 차이가 있는지 확인할 수 있습니다.

결합된 데이터에 사용 가능한 필드

각 필드에 대한 설명은 지표 및 기준 페이지를 참조하세요.

기준

기본 기준(모든 네트워크와 트래커에서 사용할 수 있어야 함):

  • source
  • 연동_캠페인_ID
  • 연동_캠페인_이름

선택적 추가 기준(네트워크/트래커에 따라 지원 여부가 달라짐):

  • os
  • 플랫폼
  • 국가_필드
  • 광고주_서브_애드네트워크_이름
  • adn_account_id
  • adn_account_name
  • sub_campaign_id
  • sub_campaign_name

키워드 및/또는 퍼블리셔 분류(네트워크/트래커에 따라 지원 여부가 다르며, 광고 소재 분류와 동일한 쿼리로 가져올 수 없음):

  • keyword_id
  • 키워드
  • publisher_id
  • 퍼블리셔_사이트_ID
  • 퍼블리셔_사이트_이름

크리에이티브 분류(네트워크에 따라 지원 여부가 다르며, Singular 어트리뷰션 서비스 사용자만 사용 가능):

  • 크리에이티브_유형
  • adn_creative_id
  • adn_크리에이티브_이름
  • creative_url
  • 크리에이티브_이미지
  • 크리에이티브_텍스트
  • creative_width
  • creative_height
  • creative_is_video

사용자 지정 기준:

이러한 기본 기준을 기반으로 사용자 지정 기준을 정의한 경우 해당 ID를 사용하여 해당 기준을 가져올 수 있습니다. 사용자 지정 기준 엔드포인트를 사용하여 계정에 정의된 모든 사용자 지정 기준과 해당 ID를 가져올 수 있습니다.

메트릭

기본 메트릭입니다:

  • adn_cos
  • adn_original_cost
  • adn_original_currency
  • custom_impressions
  • custom_clicks
  • custom_installs
  • tracker_conversions
  • tracker_reengagements
  • daily_active_users

동영상 크리에이티브 및 동영상 기반 캠페인에 대한 지표입니다:

  • video_views
  • VIDEO_VIEWS_25PCT
  • VIDEO_VIEWS_50PCT
  • VIDEO_VIEWS_75PCT
  • 완료된_비디오_조회수
  • 완료된_비디오_보기_율

코호트 지표:

  • 구매
  • original_revenue

사용할 수 있는 코호트 지표의 전체 목록은 코호트 지표 엔드포인트를 참조하세요. 자세한 내용은 코호트 지표란 무엇인가요?

코호트 지표에는 CPE 및 CPI와 같은 비율 기반 계산이 포함된다는 점에 유의하세요. API 보고서에서는 이러한 지표를 사용하지 않는 것이 좋습니다(자세히 알아보기).

이벤트:

정의한 모든 이벤트에 대한 통계를 가져올 수 있습니다. 단, Singular 앱에 정의된 이벤트 이름을 사용하는 대신 코호트 지표 엔드포인트에서 얻을 수 있는 이벤트의 자동 생성 ID를 사용해야 한다는 점에 유의하세요.

참고:

    • Singular는 가능한 가장 높은 수준의 세분성을 제공하려고 노력하지만, 모든 네트워크와 트래커가 모든 세분성을 지원하는 것은 아닙니다. Singular가 각 소스에서 가져오는 데이터에 대한 자세한 내용은 데이터 커넥터 상세 정보를 참조하세요.
  • 크리에이티브 레벨의 연동 보고서는 Singular 어트리뷰션 서비스 사용자만 이용할 수 있습니다.
  • 크리에이티브 분석에는 사용자 지정 지표를 사용할 수 없습니다. 네트워크 지표("adn_...") 또는 트래커 지표("tracker_...") 중 하나를 선택하세요.

요약: 어떤 유형의 데이터를 사용할 수 있나요?

저는 Singular 어트리뷰션을 사용하는 용도는...
애널리틱스 + Singular 어트리뷰션 애널리틱스만 사용하지만, 타사 트래커에서 데이터를 가져오도록 Singular를 설정했습니다. 내 광고 네트워크에서만 데이터 가져오기
네트워크 데이터 사용 가능 사용 가능 사용 가능
트래커 데이터 사용 가능 사용 가능 -
결합 필드 사용 가능 자체 어트리뷰션 네트워크에 사용 가능(크리에이티브 분류 없음) -

리포팅 API를 쿼리하는 방법

쿼리할 데이터 유형을 결정하고 관심 있는 특정 메트릭과 기준 목록을 만든 후에는 다음과 같이 리포팅 API를 사용하는 방법을 알아보세요.

기본 쿼리 실행하기

1

선택한 메트릭과 기준을 지정하여 비동기 보고서 만들기 엔드포인트( 엔드포인트 참조 참조)를 쿼리합니다.

그러면 비동기 보고서 쿼리가 생성되고 보고서 ID가 반환됩니다.

2

보고서 ID를 사용하여 보고서 상태 가져오기 API 엔드포인트( 엔드포인트 참조 참조)를 쿼리하여 보고서 실행이 완료된 시점을 확인합니다.

보고서가 완료되면 보고서 상태 가져오기 엔드포인트가 보고서 URL을 반환합니다.

3

보고서 URL에서 보고서를 다운로드합니다.

Screen_Shot_2021-07-07_at_16.48.30.png

참고: Singular에서 처리하는 데이터의 양이 많기 때문에 각 쿼리를 Singular 소스(네트워크) 또는 데이터 커넥터와 Singular 날짜로 필터링하는 것이 좋습니다. 예를 들어, 지난 7일 동안의 Facebook 캠페인에 대한 보고서를 실행하는 경우 7개의 개별 보고서를 실행합니다. 이렇게 하면 쿼리를 실행하기에 너무 무겁지 않게 할 수 있습니다.

일일 보고서 실행

Singular 데이터는 매일 업데이트됩니다. 일반적으로 다음을 포함하여 매일 Singular에서 데이터를 가져오고 싶을 것입니다:

  • 어제 데이터
  • 네트워크에서 업데이트되었을 수 있는 과거 데이터.

정기 일일 보고서에서는 다음 시간대를 사용하여 기록 데이터를 가져오는 것이 좋습니다:

쿼리 유형 권장 시간 창
네트워크 데이터 7일 전.
트래커 데이터 또는 결합된 데이터 가장 긴 코호트 기간만큼의 기간입니다. 예를 들어 30일 코호트가 있는 경우 30일 전을 쿼리합니다. 매출과 같은 코호트 데이터를 가져오지 않는 경우에는 일반적으로 7일 전으로 가져오면 충분합니다.

데이터 사용 가능성 확인

데이터 가용성 상태 엔드포인트를 사용하여 각 데이터 커넥터에 대해 Singular가 해당 날짜에 해당 커넥터의 데이터를 가지고 있는지 여부와 해당 데이터가 마지막으로 새로 고쳐진 시간을 확인할 수 있습니다.

이 엔드포인트의 가장 일반적인 용도는 각 데이터 커넥터에 대해 어제 데이터가 이미 사용 가능한 지 확인하는 것입니다. 이렇게 하면 모든 데이터 커넥터가 준비되면 모든 데이터에 대한 보고서 실행을 시작할 수 있습니다. 일부 데이터 커넥터에만 데이터가 있고 다른 데이터 커넥터에는 데이터가 없는 경우, 모든 데이터 커넥터가 완료될 때까지 기다릴지 아니면 데이터가 사용 가능해지면 각 데이터 소스에 대한 보고서를 실행할지는 사용자가 선택할 수 있습니다. (비동기 보고서 만들기에서 Singular 데이터 커넥터에 대한 보고서를 실행하려면 data_connector_id로 보고서를 필터링합니다.)

Singular는 동일한 쿼리에서 둘 이상의 데이터 커넥터/소스에 대해 보고서를 실행하는 것을 권장하지 않습니다.

Screen_Shot_2021-07-07_at_16.48.49.png

"데이터 커넥터" 대 "소스"에 대한 참고 사항:

Singular에서 '소스' 는 Singular가 광고 데이터를 가져오는 광고 네트워크 파트너입니다. '데이터 커넥터' 는 광고 네트워크에 연결하여 데이터를 가져오는 도구입니다.

설정에 따라 동일한 소스를 공유하는 여러 데이터 커넥터가 있을 수 있습니다. 즉, 동일한 플랫폼에서 (계정 이름, 설정 등이 다르지만) 데이터를 Singular로 가져옵니다.

데이터 가용성 엔드포인트는 소스가 아닌 데이터 커넥터별로 가용성을 반환합니다. 새로운 "expanded=true" 매개변수(권장)를 사용하는 경우, 결과에는 보고서를 필터링하는 데 사용할 수 있는 data_connector_id 매개변수가 포함됩니다.

팁: data_connector_id는 네트워크 필드입니다. 네트워크 데이터와 트래커 데이터가 모두 포함된 보고서를 실행하는 경우 data_connector_id를 포함하면 네트워크 데이터와 트래커 데이터가 별도의 행으로 분리됩니다( 네트워크 및 트래커 데이터 조인 참조)는 것을 의미합니다( 네트워크 및 트래커 데이터 조인 참조). 이 문제를 해결하려면 BI 플랫폼에서 결과를 처리하기 시작할 때 결과를 소스별로 그룹화하고 data_connector_id 필드를 포함하지 마세요.

데이터 최신성 확인

네트워크 데이터가 얼마나 최신 상태인지 확인하려면 보고서 쿼리에 data_connector_timestamp_utc 기준을 포함하세요.

이 기준에는 Singular가 데이터 커넥터에서 데이터를 가져오기 시작한 날짜와 시간이 포함됩니다(데이터를 수집, 처리 및 저장하는 데 걸린 시간과 관계없이 Singular 데이터베이스에 데이터를 저장하는 데 걸린 시간).Screen_Shot_2021-07-07_at_16.49.09.png

데이터 타임스탬프의 사용 사례 예는 다음과 같습니다:

  • Singular 보고와 네트워크 대시보드의 데이터 간에 불일치가 발생하는 경우
  • Singular 데이터 대상(ETL)을 사용하여 Singular에서 BI 플랫폼으로 데이터를 가져오는데 Singular에 최신 데이터가 있는지 확인하려는 경우

팁: data_connector_id는 네트워크 필드입니다. 네트워크 데이터와 트래커 데이터를 모두 포함하는 보고서를 실행하는 경우, data_connector_id를 포함하면 네트워크 데이터와 트래커 데이터가 별도의 행으로 분리됩니다( 네트워크 및 트래커 데이터 조인 참조).