# P2ACH 광고분석 API

P2ACH 광고분석 연동 API 문서입니다

Version: v1
License: CC BY-NC

## Servers

```
https://admin.dev.p2ach.io/customer
```

## Security

### Bearer

Type: apiKey
In: header
Name: Authorization

### Token

Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

[P2ACH 광고분석 API](https://docs.p2ach.ai/_bundle/apis/v1.yaml)

## 인증

### API 키 인증 api

 - [POST /authorize](https://docs.p2ach.ai/apis/v1/%EC%9D%B8%EC%A6%9D/authorize_create.md): 발급/전달 받은 access_key와 secret_access_key를 사용하여 인증합니다.
반환 된 access token을 헤더에 Bearer {access_token} 형식으로 담아 요청합니다.

## 송출 기록

### 광고 송출 기록 저장 API

 - [POST /advertisements](https://docs.p2ach.ai/apis/v1/%EC%86%A1%EC%B6%9C-%EA%B8%B0%EB%A1%9D/advertising_record.md): 피치에이아이 분석 데이터와 연동하기 위해 광고 송출 기록을 저장합니다.

광고의 캠페인 ID, 송출 시작/종료시간과 광고가 송출된 매체(display) id를 리스트 형태로 요청합니다.

광고 송출 기록을 해당 api 로 저장한 다음날 피치에이아이 내부에서 성과분석 데이터와 송출 기록 데이터를 연동합니다.

start_date와 end_date는 UTC 기준입니다.

## 성과분석

### 배치용 광고 성과 분석 조회 api

 - [GET /measurements](https://docs.p2ach.ai/apis/v1/%EC%84%B1%EA%B3%BC%EB%B6%84%EC%84%9D/measurements.md): 지정한 날짜의 광고 성과 측정 데이터를 조회합니다. campaign_ids, display_ids 파라미터를 통해 특정 캠페인들과 매체들의 데이터만 조회하도록 지정할 수 있습니다. 한번에 모든 데이터를 가져오기 떄문에 배치성 작업에 적합합니다.

### 웹용 광고 성과 분석 조회 api v2

 - [GET /measurements/v2](https://docs.p2ach.ai/apis/v1/%EC%84%B1%EA%B3%BC%EB%B6%84%EC%84%9D/measurementsv2.md): 지정한 날짜 외 추가 세부 파라미터를 사용하여 광고 성과 측정 데이터를 조회합니다. api 응답이 빠르고 응답 데이터가 비대하지 않아 웹에 보여주는 용도에 적합합니다.

### 성과분석 데이터 연동 확인 API

 - [GET /measurements/check](https://docs.p2ach.ai/apis/v1/%EC%84%B1%EA%B3%BC%EB%B6%84%EC%84%9D/measurements_measurements_check.md): 매체 별로 광고 성과 데이터와 송출기록 데이터 연동 여부를 확인하는 API

## 기기

### 피치에이아이 셋탑박스 - 고객사 매체 조회

 - [GET /settopbox](https://docs.p2ach.ai/apis/v1/%EA%B8%B0%EA%B8%B0/settopbox_read.md): 피치에이아이에 등록되어 있는 셋탑박스와 연결된 매체(디스플레이) 정보를 조회합니다.
각 항목에는 셋탑박스의 시리얼 번호, 설치 위치, 하드웨어 스펙, 카메라 유효 거리 등의 정보가 포함되어 있습니다.

### 셋탑박스-매체 등록 API

 - [POST /settopbox](https://docs.p2ach.ai/apis/v1/%EA%B8%B0%EA%B8%B0/settopbox_create.md): 초기 장비 셋업시, 사용자가 피치에이아이의 셋탑박스와 매체(디스플레이)를 연동할 수 있도록 등록하는 API입니다.
이미 등록된 셋탑박스나 중복되는 매체 ID가 있는 경우 오류를 반환합니다.